mso_schema_template_anp_epg_contract – Manage EPG contracts in schema templates
mso_schema_template_anp_epg_contract – Manage EPG contracts in schema templates
New in version 2.8.
Synopsis
- Manage EPG 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 | |
---|---|---|---|
anp string / required |
The name of the ANP. | ||
contract dictionary |
A contract associated to this EPG. | ||
name string / required |
The name of the COntract to associate with. | ||
schema string |
The schema that defines the referenced BD. If this parameter is unspecified, it defaults to the current schema. | ||
template string |
The template that defines the referenced BD. | ||
type string / required |
|
The type of contract. | |
epg string / required |
The name of the EPG to manage. | ||
host string / required |
IP Address or hostname of the ACI Multi Site Orchestrator host.
| ||
output_level string |
|
Influence the output of this ACI module.
| |
password string / required |
The password to use for authentication. This option is mutual exclusive with | ||
port integer |
Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. | ||
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. | |
use_proxy boolean |
|
If | |
use_ssl boolean |
|
If | |
username string |
Default: "admin" |
The username to use for authentication. | |
validate_certs boolean |
|
If This should only set to |
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
- mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates
- The official documentation on the mso_schema_template_anp_epg module.
- mso_schema_template_contract_filter – Manage contract filters in schema templates
- The official documentation on the mso_schema_template_contract_filter module.
Examples
- name: Add a contract to an EPG
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contract:
name: Contract 1
type: consumer
state: present
delegate_to: localhost
- name: Remove a Contract
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contract:
name: Contract 1
state: absent
delegate_to: localhost
- name: Query a specific Contract
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contract:
name: Contract 1
state: query
delegate_to: localhost
register: query_result
- name: Query all Contracts
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/mso_schema_template_anp_epg_contract_module.html