cisco.mso.mso_schema_site_vrf_region – Manage site-local VRF regions in schema template
cisco.mso.mso_schema_site_vrf_region – Manage site-local VRF regions in schema template
Note
This plugin is part of the cisco.mso collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_schema_site_vrf_region
.
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 | Choices/Defaults | Comments |
---|---|---|
host string / required |
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
| |
login_domain string |
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 | |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
password string / required |
The password to use for authentication. If the value is not specified in the task, the value of environment variables | |
port integer |
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 | |
region string |
The name of the region to manage.
| |
schema string / required |
The name of the schema. | |
site string / required |
The name of the site. | |
state string |
|
Use Use |
template string / required |
The name of the template. | |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
vpn_gateway_router boolean |
|
Whether VPN Gateway Router is enabled or not. |
vrf string / required |
The name of the VRF. |
Notes
Note
- Due to restrictions of the MSO REST API, this module cannot create empty region (i.e. regions without cidrs) Use the cisco.mso.mso_schema_site_vrf_region_cidr to automatically create regions with cidrs.
- Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
- This module was written to support ACI 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
- The official documentation on the cisco.mso.mso_schema_site_vrf module.
- cisco.mso.mso_schema_template_vrf
- The official documentation on the cisco.mso.mso_schema_template_vrf module.
Examples
- name: Remove VPN Gateway Router at site VRF Region
cisco.mso.mso_schema_site_vrf_region:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
vpn_gateway_router: false
state: present
delegate_to: localhost
- name: Remove a site VRF region
cisco.mso.mso_schema_site_vrf_region:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
state: absent
delegate_to: localhost
- name: Query a specific site VRF region
cisco.mso.mso_schema_site_vrf_region:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
state: query
delegate_to: localhost
register: query_result
- name: Query all site VRF regions
cisco.mso.mso_schema_site_vrf_region:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
state: query
delegate_to: localhost
register: query_result
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_schema_site_vrf_region_module.html