cisco.mso.mso_schema_template_vrf_contract – Manage vrf contracts in schema templates
cisco.mso.mso_schema_template_vrf_contract – Manage vrf contracts in schema templates
Note
This plugin is part of the cisco.mso collection (version 1.0.1).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_schema_template_vrf_contract
.
New in version 0.0.8: of cisco.mso
Synopsis
- Manage vrf contracts in schema templates 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 | |
---|---|---|---|
contract dictionary |
A contract associated to this VRF. | ||
name string / required |
The name of the Contract to associate with. | ||
schema string |
The schema that defines the referenced contract. If this parameter is unspecified, it defaults to the current schema. | ||
template string |
The template that defines the referenced contract. | ||
type string / required |
|
The type of contract. | |
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 | ||
schema string / required |
The name of the schema. | ||
state string |
|
Use Use | |
template string / required |
The name of the template to change. | ||
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
- 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_template_vrf
- The official documentation on the cisco.mso.mso_schema_template_vrf module.
Examples
- name: Add a contract to a VRF
cisco.mso.mso_schema_template_vrf_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
contract:
name: Contract 1
type: consumer
state: present
delegate_to: localhost
- name: Remove a Contract
cisco.mso.mso_schema_template_vrf_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
contract:
name: Contract 1
type: consumer
state: absent
delegate_to: localhost
- name: Query a specific Contract
cisco.mso.mso_schema_template_vrf_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
contract:
name: Contract 1
type: consumer
state: query
delegate_to: localhost
register: query_result
- name: Query all Contracts
cisco.mso.mso_schema_template_vrf_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
vrf: VRF 1
state: query
delegate_to: localhost
register: query_result
Authors
- Cindy Zhao (@cizhao)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/mso/mso_schema_template_vrf_contract_module.html