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

Note

This module is part of the community.network collection (version 3.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

Comments

aftype

string / required

Destination ip address family type of static route.

Choices:

  • v4

  • v6

state

string

Specify desired state of the resource.

Choices:

  • present ← (default)

  • absent

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

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of switchport after module execution

Returned: always

Sample: {“addressFamily”: “ipv4unicast”, “state”: “present”, “vrfName”: “_public_”}

existing

dictionary

k/v pairs of existing switchport

Returned: always

Sample: {}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {“addressFamily”: “ipv4unicast”, “state”: “present”, “vrfName”: “_public_”}

updates

list / elements=string

command list sent to the device

Returned: always

Sample: [“multicast routing-enable”]

Authors

  • xuxiaowei0512 (@xuxiaowei0512)