community.network.ce_multicast_igmp_enable – Manages multicast igmp enable configuration on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 3.0.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_igmp_enable.

New in version 0.2.0: of community.network

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manages multicast igmp on HUAWEI CloudEngine switches.

Parameters

Parameter	Choices/Defaults	Comments
aftype string / required	Choices: v4 v6	Destination ip address family type of static route.
features string / required	Choices: global vlan	Distinguish between Globally Enabled IGMP or Enabled IGMP under vlanID.
igmp boolean	Choices: no ← yes	Enable Layer 2 multicast Snooping in a VLAN.
proxy boolean	Choices: no ← yes	Layer 2 multicast snooping proxy is enabled.
state string	Choices: present ← absent	Specify desired state of the resource.
version integer	Default: 2	Specifies the IGMP version that can be processed.
vlan_id integer		Virtual LAN identity.

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: Configure global igmp enable
  community.network.ce_multicast_igmp_enable:
    aftype: v4
    features: 'global'
    state: present

- name: Configure global igmp disable
  community.network.ce_multicast_igmp_enable:
    features: 'global'
    aftype: v4
    state: absent

- name: Configure vlan igmp enable
  community.network.ce_multicast_igmp_enable:
    features: 'vlan'
    aftype: v4
    vlan_id: 1
    igmp: true

- name: New proxy,igmp,version
  community.network.ce_multicast_igmp_enable:
    features: 'vlan'
    aftype: v4
    vlan_id: 1
    proxy: true
    igmp: true
    version: 1

- name: Modify proxy,igmp,version
  community.network.ce_multicast_igmp_enable:
    features: 'vlan'
    aftype: v4
    vlan_id: 1
    version: 2

- name: Delete proxy,igmp,version
  community.network.ce_multicast_igmp_enable:
    features: 'vlan'
    aftype: v4
    vlan_id: 1
    state: absent

Return Values

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

Key	Returned	Description
changed boolean	always	check if a change was made on the device Sample: True
end_state dictionary	always	k/v pairs of switchport after module execution
existing dictionary	always	k/v pairs of existing switchport
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'addrFamily': 'ipv4unicast', 'features': 'vlan', 'proxyEnable': 'false', 'snoopingEnable': 'false', 'state': 'absent', 'version': 2, 'vlanId': 1}
updates list / elements=string	always	command list sent to the device Sample: ['undo igmp snooping enable', 'undo igmp snooping version', 'undo igmp snooping proxy']

Authors

xuxiaowei0512 (@CloudEngine-Ansible)

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