W3cubDocs

/Ansible

cisco.mso.ndo_tenant_igmp_snooping_policy module – Manage Internet Group Management Protocol (IGMP) Snooping Policies in Tenant Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.11.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 cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_tenant_igmp_snooping_policy.

Synopsis

  • Manage IGMP Snooping Policies in Tenant Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).
  • This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

The below requirements are needed on the host that executes this module.

  • Multi Site Orchestrator v2.1 or newer

Parameters

Parameter

Comments

admin_state

string

The administrative state of the IGMP Snooping Policy.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

description

string

The description of the IGMP Snooping Policy.

Providing an empty string will remove the description="" from the IGMP Snooping Policy.

fast_leave_control

string

The fast leave control of the IGMP Snooping Policy.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

host

aliases: hostname

string

IP Address or hostname of the ACI Multi Site Orchestrator host.

If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.

last_member_query_interval

integer

The last member query interval value in seconds.

The last member query interval of the IGMP Snooping Policy.

Defaults to 1 when unset during creation.

The value must be between 1 and 25.

login_domain

string

The login domain name to use for authentication.

The default value is Local.

If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.

name

aliases: igmp_snooping_policy

string

The name of the IGMP Snooping Policy.

output_level

string

Influence the output of this MSO module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

password

string

The password to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Port number to be used for the REST connection.

The default value depends on parameter `use_ssl`.

If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.

querier_control

string

The querier control of the IGMP Snooping Policy.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

querier_version

string

The querier version of the IGMP Snooping Policy.

Defaults to v3 when unset during creation.

Choices:

  • "v2"
  • "v3"

query_interval

integer

The query interval value in seconds.

The query interval of the IGMP Snooping Policy.

Defaults to 125 when unset during creation.

The value must be between 1 and 18000.

query_response_interval

integer

The query response interval value in seconds.

The query response interval of the IGMP Snooping Policy.

Defaults to 10 when unset during creation.

The value must be between 1 and 25.

start_query_count

integer

The start query count of the IGMP Snooping Policy.

Defaults to 2 when unset during creation.

The value must be between 1 and 10.

start_query_interval

integer

The start query interval value in seconds.

The start query interval of the IGMP Snooping Policy.

Defaults to 31 when unset during creation.

The value must be between 1 and 18000.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"
  • "query" ← (default)
  • "present"

template

aliases: tenant_template

string / required

The name of the tenant template.

timeout

integer

The socket level timeout in seconds.

The default value is 30 seconds.

If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead.

The default is true.

Choices:

  • false
  • true

use_ssl

boolean

If false, an HTTP connection will be used instead of the default HTTPS connection.

If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso).

Choices:

  • false
  • true

username

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

uuid

string

The UUID of the IGMP Snooping Policy.

This parameter is required when the IGMP Snooping Policy name needs to be updated.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.

The default is true.

Choices:

  • false
  • true

Notes

Note

  • The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant template.
  • This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create a new IGMP Snooping Policy object
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: igmp_snooping_policy_1
    admin_state: enabled
    fast_leave_control: enabled
    querier_control: enabled
    querier_version: v2
    query_interval: 100
    query_response_interval: 5
    last_member_query_interval: 2
    start_query_interval: 25
    start_query_count: 1
    state: present
  register: igmp_snooping_policy_1

- name: Update a IGMP Snooping Policy object name with UUID
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: igmp_snooping_policy_2
    uuid: "{{ igmp_snooping_policy_1.current.uuid }}"
    state: present

- name: Query a IGMP Snooping Policy object with name
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: igmp_snooping_policy_1
    state: query
  register: query_uuid

- name: Query a IGMP Snooping Policy object with UUID
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ igmp_snooping_policy_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all IGMP Snooping Policy objects in a Tenant Template
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    state: query
  register: query_all

- name: Delete a IGMP Snooping Policy object with name
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: igmp_snooping_policy_1
    state: absent

- name: Delete a IGMP Snooping Policy object with UUID
  cisco.mso.ndo_tenant_igmp_snooping_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ igmp_snooping_policy_1.current.uuid }}"
    state: absent

Authors

  • Anvitha Jain (@anvjain)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/ndo_tenant_igmp_snooping_policy_module.html