intersight_multicast_policy

Multicast Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_multicast_policy

Synopsis

Multicast Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	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.
name	string	yes		The name assigned to the Multicast Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list			List of tags in Key: Value: format.
querier_state	string		`Disabled`	Administrative state of the IGMP Querier for this VLAN. Choices: `Enabled`, `Disabled`
snooping_state	string		`Enabled`	Administrative state of the IGMP Snooping for this VLAN. Choices: `Enabled`, `Disabled`
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.
src_ip_proxy	string		`Enabled`	Administrative state of the IGMP source IP proxy for this VLAN. Choices: `Enabled`, `Disabled`

Example

yaml

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

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

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

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