W3cubDocs

/Ansible 2.10

community.network.ce_multicast_global – Manages multicast global configuration on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection.

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_multicast_global.

New in version 0.2.0: of community.network

Synopsis

  • Manages multicast global on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
aftype
string / required
    Choices:
  • v4
  • v6
Destination ip address family type of static route.
state
string
    Choices:
  • present ←
  • absent
Specify desired state of the resource.
vrf
string
VPN instance of destination ip address.

Notes

Note

  • If no vrf is supplied, vrf is set to default.
  • If state=absent, the route will be removed, regardless of the non-required parameters.
  • This module requires the netconf system service be enabled on the remote device being managed.
  • This module works with connection netconf.

Examples

---
  - name: Multicast routing-enable
    community.network.ce_multicast_global:
      aftype: v4
      state: absent
      provider: "{{ cli }}"
  - name: Multicast routing-enable
    community.network.ce_multicast_global:
      aftype: v4
      state: present
      provider: "{{ cli }}"
  - name: Multicast routing-enable
    community.network.ce_multicast_global:
      aftype: v4
      vrf: vrf1
      provider: "{{ cli }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
always
k/v pairs of switchport after module execution

Sample:
{'addressFamily': 'ipv4unicast', 'state': 'present', 'vrfName': '_public_'}
existing
dictionary
always
k/v pairs of existing switchport
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'addressFamily': 'ipv4unicast', 'state': 'present', 'vrfName': '_public_'}
updates
list / elements=string
always
command list sent to the device

Sample:
['multicast routing-enable']


Authors

  • xuxiaowei0512 (@xuxiaowei0512)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_multicast_global_module.html