cisco.mso.mso_schema_site_vrf_region_hub_network – Manage site-local VRF region hub network in schema template
cisco.mso.mso_schema_site_vrf_region_hub_network – Manage site-local VRF region hub network 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_hub_network
.
Synopsis
- Manage site-local VRF region hub network in schema template on Cisco ACI Multi-Site.
- The ‘Hub Network’ feature was introduced in Multi-Site Orchestrator (MSO) version 3.0(1) for AWS and version 3.0(2) for Azure.
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
| ||
hub_network dictionary |
The hub network to be managed. | ||
name string / required |
The name of the hub network. The hub-default is the default created hub network. | ||
tenant string / required |
The tenant name of the hub network. | ||
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 / required |
The name of the region. | ||
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 | |
vrf string / required |
The name of the VRF. |
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
- cisco.mso.mso_schema_site_vrf_region
- The official documentation on the cisco.mso.mso_schema_site_vrf_region module.
- cisco.mso.mso_schema_template_vrf
- The official documentation on the cisco.mso.mso_schema_template_vrf module.
Examples
- name: Add a new site VRF region hub network
cisco.mso.mso_schema_site_vrf_region_hub_network:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
region: us-west-1
hub_network:
name: hub-default
tenant: infra
state: present
delegate_to: localhost
- name: Remove a site VRF region hub network
cisco.mso.mso_schema_site_vrf_region_hub_network:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
vrf: VRF1
state: absent
delegate_to: localhost
- name: Query site VRF region hub network
cisco.mso.mso_schema_site_vrf_region_hub_network:
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
Authors
- Cindy Zhao (@cizhao)
© 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_hub_network_module.html