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

Note

This module is part of the community.network collection (version 5.1.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.

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

New in community.network 0.2.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

  • Manages multicast igmp on HUAWEI CloudEngine switches.

Aliases: network.cloudengine.ce_multicast_igmp_enable

Parameters

Parameter

Comments

aftype

string / required

Destination ip address family type of static route.

Choices:

  • "v4"

  • "v6"

features

string / required

Distinguish between Globally Enabled IGMP or

Enabled IGMP under vlanID.

Choices:

  • "global"

  • "vlan"

igmp

boolean

Enable Layer 2 multicast Snooping in a VLAN.

Choices:

  • false ← (default)

  • true

proxy

boolean

Layer 2 multicast snooping proxy is enabled.

Choices:

  • false ← (default)

  • true

state

string

Specify desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

version

integer

Specifies the IGMP version that can be processed.

Default: 2

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

Description

changed

boolean

check 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: {}

existing

dictionary

k/v pairs of existing switchport

Returned: always

Sample: {}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"addrFamily": "ipv4unicast", "features": "vlan", "proxyEnable": "false", "snoopingEnable": "false", "state": "absent", "version": 2, "vlanId": 1}

updates

list / elements=string

command list sent to the device

Returned: always

Sample: ["undo igmp snooping enable", "undo igmp snooping version", "undo igmp snooping proxy"]

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • xuxiaowei0512 (@CloudEngine-Ansible)