cisco.mso.ndo_route_map_policy_multicast module – Manage Multicast Route Map Policies on Cisco Nexus Dashboard Orchestrator (NDO).
Note
This module is part of the cisco.mso collection (version 2.9.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_route_map_policy_multicast
.
Synopsis
Manage Multicast Route Map Policies on Cisco Nexus Dashboard Orchestrator (NDO).
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The description of the Multicast Route Map Policy. |
|
A list of entries attached to the Multicast Route Map Policy. The list of configured entries must contain at least one entry. When the list of entries is null the update will not change existing entry configuration. |
|
The action of the entry. Choices:
|
|
The name of the entry. |
|
The order of the entry. |
|
The rendezvous point of the entry. |
|
The data of the entry. |
|
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 |
|
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 When using a HTTPAPI connection plugin the inventory variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
The name of the Multicast Route Map Policy. |
|
The uuid of the Multicast Route Map Policy. This parameter is required when the |
|
Use Use Use Choices:
|
|
The name of the template. The template must be a tenant template. |
|
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 |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
Notes
Note
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 a new multicast route map policy policy
cisco.mso.ndo_route_map_policy_multicast:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
route_map_policy: ansible_test_route_map_policy
entries:
- order: 1
group: 226.2.2.0/24
source: 1.1.1.1/24
rp: 1.1.1.2
action: permit
state: present
- name: Query a multicast route map policy policy with template_name
cisco.mso.ndo_route_map_policy_multicast:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
route_map_policy: ansible_test_route_map_policy
state: query
register: query_one
- name: Query all multicast route map policy policy in the template
cisco.mso.ndo_route_map_policy_multicast:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
state: query
register: query_all
- name: Delete a multicast route map policy policy
cisco.mso.ndo_route_map_policy_multicast:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
route_map_policy: ansible_test_route_map_policy
state: absent