W3cubDocs

/Ansible

cisco.intersight.intersight_multicast_policy module – Multicast Policy configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.2.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.intersight.

To use it in a playbook, specify: cisco.intersight.intersight_multicast_policy.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages Multicast Policy configuration on Cisco Intersight.
A policy to configure multicast settings including IGMP snooping and querier on Cisco Intersight managed switches.
For more information see Cisco Intersight.

Parameters

Parameter	Comments
api_key_id string / required	Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.
api_private_key path / required	Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <your private key data> —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.
api_uri string	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: `"https://intersight.com/api/v1"`
description aliases: descr string	The user-defined description for the Multicast Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
name string / required	The name assigned to the Multicast Policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
organization string	The name of the Organization this resource is assigned to. Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization. Default: `"default"`
querier_ip_address string	Used to define the IGMP Querier IP address. Must be a valid IPv4 address.
querier_ip_address_peer string	Used to define the IGMP Querier IP address of the peer switch. This is optional and only applicable when querier_state is set to ‘Enabled’. Must be a valid IPv4 address.
querier_state string	Administrative state of the IGMP Querier for this VLAN. Choices: `"Enabled"` `"Disabled"` ← (default)
snooping_state string	Administrative state of the IGMP Snooping for this VLAN. Choices: `"Enabled"` ← (default) `"Disabled"`
src_ip_proxy string	Administrative state of the IGMP source IP proxy for this VLAN. Choices: `"Enabled"` ← (default) `"Disabled"`
state string	If `present`, will verify the resource is present and will create if needed. If `absent`, will verify the resource is absent and will delete if needed. Choices: `"present"` ← (default) `"absent"`
tags list / elements=dictionary	List of tags in Key:<user-defined key> Value:<user-defined value> format.
use_proxy boolean	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. Choices: `false` `true` ← (default)
validate_certs boolean	Boolean control for verifying the api_uri TLS certificate Choices: `false` `true` ← (default)

Examples

- name: Create a Multicast Policy with querier enabled
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "Multicast-Policy-Querier"
    description: "Multicast policy with IGMP querier enabled"
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    querier_state: "Enabled"
    snooping_state: "Enabled"
    querier_ip_address: "192.168.1.1"
    querier_ip_address_peer: "192.168.1.2"
    src_ip_proxy: "Enabled"
    state: present

- name: Create a basic Multicast Policy with defaults
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Basic-Multicast-Policy"
    description: "Basic multicast policy with snooping enabled"
    querier_state: "Disabled"
    snooping_state: "Enabled"
    src_ip_proxy: "Enabled"
    state: present

- name: Create a Multicast Policy with only snooping
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Snooping-Only-Policy"
    description: "Multicast policy with only snooping enabled"
    querier_state: "Disabled"
    snooping_state: "Enabled"
    src_ip_proxy: "Disabled"
    state: present

- name: Delete a Multicast Policy
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Multicast-Policy-Querier"
    state: absent

Return Values

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

Key	Description
api_repsonse dictionary	The API response output returned by the specified resource. Returned: always Sample: `{"api_response": {"Name": "test_multicast_policy", "ObjectType": "fabric.MulticastPolicy", "QuerierIpAddress": "192.168.1.1", "QuerierIpAddressPeer": "192.168.1.2", "QuerierState": "Enabled", "SnoopingState": "Enabled", "SrcIpProxy": "Enabled", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}`

Authors

Ron Gershburg (@rgershbu)

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/intersight/intersight_multicast_policy_module.html