ce_multicast_global – Manages multicast global configuration on HUAWEI CloudEngine switches

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
    ce_multicast_global:
      aftype: v4
      state: absent
      provider: "{{ cli }}"
  - name: multicast routing-enable
    ce_multicast_global:
      aftype: v4
      state: present
      provider: "{{ cli }}"
  - name: multicast routing-enable
    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
always
command list sent to the device

Sample:
['multicast routing-enable']


Status

Authors

  • xuxiaowei0512 (@xuxiaowei0512)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.