W3cubDocs

/Ansible

cisco.mso.ndo_tenant_igmp_interface_policy module – Manage Internet Group Management Protocol (IGMP) Interface 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_interface_policy.

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage IGMP Interface 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
description string	The description of the IGMP Interface Policy. Providing an empty string will remove the `description=""` from the IGMP Interface Policy.
fast_leave string	Enable or disable fast leave. Defaults to `disabled` when unset during creation. Choices: `"enabled"` `"disabled"`
group_timeout integer	The group timeout value in seconds. Defaults to 260 when unset during creation. The valid range is from 3 to 65535.
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.
igmp_version string	The IGMP version of the IGMP Interface Policy. Defaults to `v2` when unset during creation. Choices: `"v2"` `"v3"`
last_member_count integer	The last member query count value. Defaults to 2 when unset during creation. The valid range is from 1 to 5.
last_member_response_time integer	The last member query response time value in seconds. Defaults to 1 when unset during creation. The valid range is from 1 to 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.
maximum_multicast_entries integer	The maximum multicast entries value. Defaults to 4294967295 when unset during creation. The valid range is from 1 to 4294967295. This parameter is only applicable when the `state_limit_route_map_uuid` or `state_limit_route_map` is not empty.
name aliases: igmp_interface_policy string	The name of the IGMP Interface 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_timeout integer	The querier timeout value in seconds. Defaults to 255 when unset during creation. The valid range is from 1 to 65535.
query_interval integer	The query interval value in seconds. Defaults to 125 when unset during creation. The valid range is from 1 to 18000.
query_response_interval integer	The query response interval value in seconds. Defaults to 10 when unset during creation. The valid range is from 1 to 25.
report_link_local_groups string	Enable or disable reporting link-local groups. Defaults to `disabled` when unset during creation. Choices: `"enabled"` `"disabled"`
report_policy_route_map aliases: report_policy_route_map_policy, report_policy_route_map_policy_multicast dictionary	The Route Map Policy for Multicast. This parameter can be used instead of `report_policy_route_map_uuid`. If both parameter are used, `report_policy_route_map` will be ignored. Providing an empty map will remove the `report_policy_route_map={}` from IGMP Interface Policy.
name string	The name of the Route Map Policy for Multicast.
report_policy_route_map_uuid aliases: report_policy_route_map_for_multicast string	The UUID of the report policy route map. Providing an empty string will remove the `report_policy_route_map_uuid=""` from IGMP Interface Policy.
reserved_multicast_entries integer	The reserved multicast entries value. Defaults to 0 when unset during creation. The valid range is from 0 to 4294967295.
robustness_variable integer	The robustness variable value. Defaults to 2 when unset during creation. The valid range is from 1 to 7.
startup_query_count integer	The startup query count value. Defaults to 2 when unset during creation. The valid range is from 1 to 10.
startup_query_interval integer	The startup query interval value in seconds. Defaults to 31 when unset during creation. The valid range is from 1 to 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"`
state_limit_route_map aliases: state_limit_route_map_policy, state_limit_route_map_policy_multicast dictionary	The Route Map Policy for Multicast. This parameter can be used instead of `state_limit_route_map_uuid`. If both parameter are used, `state_limit_route_map` will be ignored. Providing an empty map will remove the `state_limit_route_map={}` from IGMP Interface Policy.
name string	The name of the Route Map Policy for Multicast.
state_limit_route_map_uuid aliases: state_limit_route_map_for_multicast string	The UUID of the state limit route map. Providing an empty string will remove the `state_limit_route_map_uuid=""` from IGMP Interface Policy.
static_report_route_map aliases: static_report_route_map_policy, static_report_route_map_policy_multicast dictionary	The Route Map Policy for Multicast. This parameter can be used instead of `static_report_route_map_uuid`. If both parameter are used, `static_report_route_map` will be ignored. Providing an empty map will remove the `static_report_route_map={}` from IGMP Interface Policy.
name string	The name of the Route Map Policy for Multicast.
static_report_route_map_uuid aliases: static_report_route_map_for_multicast string	The UUID of the static report route map. Providing an empty string will remove the `static_report_route_map_uuid=""` from IGMP Interface Policy.
template aliases: tenant_template string / required	The name of the tenant template. This parameter or `template_id` is required.
template_id aliases: l3out_template_id string	The ID of the L3Out template. This parameter or `template` is required.
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 aliases: igmp_interface_policy_uuid string	The UUID of the IGMP Interface Policy. This parameter is required when the IGMP Interface 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`
version3_asm aliases: allow_version3_asm string	Enable or disable IGMP version 3 ASM. Defaults to `disabled` when unset during creation. Choices: `"enabled"` `"disabled"`

Notes

Note

The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant template.
The state_limit_route_map_uuid or state_limit_route_map requires Route Map Policy for Multicast. The report_policy_route_map_uuid or report_policy_route_map requires Route Map Policy for Multicast. The static_report_route_map_uuid or static_report_route_map requires Route Map Policy for Multicast. Use cisco.mso.ndo_route_map_policy_multicast to create the Route Map Policy for Multicast.
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

Examples

- name: Create an IGMP Interface Policy
  cisco.mso.ndo_tenant_igmp_interface_policy:
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    description: Test Description
    version3_asm: enabled
    fast_leave: enabled
    report_link_local_groups: enabled
    igmp_version: v3
    group_timeout: 260
    query_interval: 125
    query_response_interval: 10
    last_member_count: 2
    last_member_response_time: 1
    startup_query_count: 2
    startup_query_interval: 31
    querier_timeout: 255
    robustness_variable: 2
    state_limit_route_map_uuid: "2be2b2e6-727d-4534-9d09-4abc36ed0194"
    report_policy_route_map_uuid: "{{ route_map_policy_for_multicast.current.uuid }}"
    static_report_route_map:
      name: TestStaticReportRouteMap
    maximum_multicast_entries: 4294967295
    reserved_multicast_entries: 4294967
    state: present
  register: igmp_interface_policy

- name: Update an IGMP Interface Policy name with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy_updated
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: present
  register: igmp_interface_policy_update

- name: Query an IGMP Interface Policy with the name
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    state: query
  register: query

- name: Query an IGMP Interface Policy with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all IGMP Interface Policies in the template
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Delete an IGMP Interface Policy with the name
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    state: absent

- name: Delete an IGMP Interface Policy with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: absent

Authors

Anvitha Jain (@anvjain)

Collection links

© 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_interface_policy_module.html