cisco.mso.mso_schema_site_vrf_region_cidr_subnet module – Manage site-local VRF regions in schema template
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_site_vrf_region_cidr_subnet
.
Synopsis
Manage site-local VRF regions in schema template on Cisco ACI Multi-Site.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The IP range of for the region CIDR. |
|
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 name of hosted vrf associated with region CIDR subnet. This is supported on versions of MSO that are 3.3 or greater. |
|
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 private link label used to represent this subnet. This parameter is available for MSO version greater than 3.3. |
|
The name of the region. |
|
The name of the schema. |
|
The name of the site. |
|
Use Use Choices:
|
|
The IP subnet of this region CIDR. |
|
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 |
|
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:
|
|
Whether this subnet is used for the Azure Gateway in Azure. Whether this subnet is used for the Transit Gateway Attachment in AWS. Choices:
|
|
The name of the VRF. |
|
The name of the zone for the region CIDR subnet. This argument is required for AWS sites. |
Notes
Note
The ACI MultiSite PATCH API has a deficiency requiring some objects to be referenced by index. This can cause silent corruption on concurrent access when changing/removing on object as the wrong object may be referenced. This module is affected by this deficiency.
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
See Also
See also
- cisco.mso.mso_schema_site_vrf_region_cidr
Manage site-local VRF region CIDRs in schema template.
- cisco.mso.mso_schema_template_vrf
Manage VRFs in schema templates.
Examples
- name: Add a new site VRF region CIDR subnet
cisco.mso.mso_schema_site_vrf_region_cidr_subnet:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
cidr: 14.14.14.1/24
subnet: 14.14.14.2/24
zone: us-west-1a
state: present
- name: Remove a site VRF region CIDR subnet
cisco.mso.mso_schema_site_vrf_region_cidr_subnet:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
cidr: 14.14.14.1/24
subnet: 14.14.14.2/24
state: absent
- name: Query a specific site VRF region CIDR subnet
cisco.mso.mso_schema_site_vrf_region_cidr_subnet:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
cidr: 14.14.14.1/24
subnet: 14.14.14.2/24
state: query
register: query_result
- name: Query all site VRF region CIDR subnet
cisco.mso.mso_schema_site_vrf_region_cidr_subnet:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
cidr: 14.14.14.1/24
state: query
register: query_result