mso_schema_site_vrf_region_cidr_subnet – Manage site-local VRF regions in schema template
New in version 2.8.
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 |
---|---|---|
cidr
string
|
The IP range of for the region CIDR.
|
|
host
string /
required
|
IP Address or hostname of the ACI Multi Site Orchestrator host.
aliases: hostname |
|
output_level
string
|
|
Influence the output of this ACI module.
normal means the standard output, incl.
current dict
info adds informational output, incl.
previous ,
proposed and
sent dicts
debug adds debugging output, incl.
filter_string ,
method ,
response ,
status and
url information
|
password
string /
required
|
The password to use for authentication.
This option is mutual exclusive with
private_key . If
private_key is provided too, it will be used instead.
|
|
port
integer
|
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
|
|
region
string
|
The name of the region.
|
|
schema
string /
required
|
The name of the schema.
|
|
site
string /
required
|
The name of the site.
|
|
state
string
|
|
Use
present or
absent for adding or removing.
Use
query for listing an object or multiple objects.
|
subnet
string
|
The IP subnet of this region CIDR.
aliases: ip |
|
template
string /
required
|
The name of the template.
|
|
timeout
integer
|
Default:
30
|
The socket level timeout in seconds.
|
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
use_ssl
boolean
|
|
If
no , an HTTP connection will be used instead of the default HTTPS connection.
|
username
string
|
Default:
"admin"
|
The username to use for authentication.
|
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated.
This should only set to
no when used on personally controlled sites using self-signed certificates.
|
vrf
string
|
The name of the VRF.
|
|
zone
string
|
The name of the zone for the region CIDR subnet.
aliases: name |
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.
- 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
- mso_schema_site_vrf_region_cidr – Manage site-local VRF region CIDRs in schema template
- The official documentation on the mso_schema_site_vrf_region_cidr module.
- mso_schema_template_vrf – Manage VRFs in schema templates
- The official documentation on the mso_schema_template_vrf module.
Examples
- name: Add a new site VRF region CIDR subnet mso_schema_template_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 delegate_to: localhost - name: Remove a site VRF region CIDR subnet 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 delegate_to: localhost - name: Query a specific site VRF region CIDR subnet 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 delegate_to: localhost register: query_result - name: Query all site VRF region CIDR subnet 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 delegate_to: localhost register: query_result
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/mso_schema_site_vrf_region_cidr_subnet_module.html