cisco.mso.mso_schema_template_anp_epg_contract module – Manage EPG contracts in schema templates
Note
This module is part of the cisco.mso collection (version 2.9.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.mso
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.mso.mso_schema_template_anp_epg_contract
.
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 |
Comments |
---|---|
The name of the ANP. |
|
The Contract associated to this EPG. This option can not be used in combination with the contracts option. |
|
The name of the Contract. |
|
The name of the Schema that defines the referenced Contract. If this parameter is unspecified, it defaults to the current schema. |
|
The name of the Template that defines the referenced Contract. If this parameter is unspecified, it defaults to the current schema. |
|
The type of the Contract. Choices:
|
|
A list of Contracts associated to this EPG. This option can not be used in combination with the All configured contract(s) will be replaced with the provided contract(s) when used with Only the provided contract(s) will be added, updated or removed when used with In combination with the |
|
The name of the Contract. |
|
The name of the Schema that defines the referenced Contract. If this parameter is unspecified, it defaults to the current schema. |
|
The name of the Template that defines the referenced Contract. If this parameter is unspecified, it defaults to the current schema. |
|
The type of the Contract. Choices:
|
|
The name of the EPG. |
|
Replaces all the configured contract(s) with the provided contract(s). This option can only be used in combination with the In combination with the Choices:
|
|
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 |
|
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 When using a HTTPAPI connection plugin the inventory variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
The name of the Schema. |
|
Use Use Choices:
|
|
The name of the Template. |
|
The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
Notes
Note
This module was written to support 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_anp_epg
Manage Endpoint Groups (EPGs) in schema templates.
- cisco.mso.mso_schema_template_contract_filter
Manage contract filters in schema templates.
Examples
- name: Add a contract to an EPG
cisco.mso.mso_schema_template_anp_epg_contract:
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
- name: Add 2 contracts to an EPG
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contracts:
- name: Contract 1
type: provider
- name: Contract 1
type: consumer
state: present
- name: Replace all existing contracts on an EPG with 2 new contracts
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
force_replace: true
contracts:
- name: Contract 2
type: provider
- name: Contract 2
type: consumer
state: present
- name: Query a specific Contract
cisco.mso.mso_schema_template_anp_epg_contract:
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: query
register: query_result
- name: Query a list of Contracts
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contracts:
- name: Contract 2
type: provider
- name: Contract 2
type: consumer
state: query
register: query_result
- name: Query all Contracts
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
state: query
register: query_result
- name: Remove a Contract
cisco.mso.mso_schema_template_anp_epg_contract:
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
- name: Remove 2 contracts to an EPG
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
contracts:
- name: Contract 1
type: provider
- name: Contract 1
type: consumer
state: absent
- name: Remove all existing contracts from an EPG
cisco.mso.mso_schema_template_anp_epg_contract:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
force_replace: true
state: absent