cisco.mso.mso_schema_template_vrf_rp module – Manage VRF Rendezvous Points (RP) in schema templates.
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.mso_schema_template_vrf_rp
.
Synopsis
Manage VRF Rendezvous Points (RP) in schema templates on Cisco ACI Multi-Site.
RPs can only be configured when the VRF has Layer 3 Multicast is enabled.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
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 IP address of the RP. |
|
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 |
|
The name of the Multicast Route Map Policy. The Multicast Route Map Policy must reside in the same tenant as the tenant associated to the schema. Use |
|
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 schema. |
|
Use Use Choices:
|
|
The name of the 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 |
|
The type of the RP. Choices:
|
|
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:
|
|
The name of the VRF. |
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: Add a new VRF RP
cisco.mso.mso_schema_template_vrf_rp:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
ip: 1.1.1.1
type: static
multicast_route_map_policy: RouteMapPolicy1
state: present
- name: Query a specific VRF RP
cisco.mso.mso_schema_template_vrf_rp:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
ip: 1.1.1.1
state: query
register: query_result
- name: Query all VRF RPs
cisco.mso.mso_schema_template_vrf_rp:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
state: query
register: query_result
- name: Remove an VRF RP
cisco.mso.mso_schema_template_vrf_rp:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
ip: 1.1.1.1
state: absent