cisco.mso.mso_schema_site_anp_epg_domain – Manage site-local EPG domains in schema template
Note
This plugin is part of the cisco.mso collection (version 1.2.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
.
To use it in a playbook, specify: cisco.mso.mso_schema_site_anp_epg_domain
.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
Specifies microsegmentation is enabled or not. This attribute can only be used with vmmDomain domain association. Choices:
|
|
The name of the ANP. |
|
The deployment immediacy of the domain.
Choices:
|
|
The type of domain to associate. Choices:
|
|
The domain profile name. |
|
Distinguished name of EPG lagpolicy. This attribute can only be used with vmmDomain domain association. |
|
EPG enhanced lagpolicy name. This attribute can only be used with vmmDomain domain association. |
|
The name of the EPG. |
|
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 |
|
Virtual LAN for microsegmentation. This attribute can only be used with vmmDomain domain association. |
|
Virtual LAN type for microsegmentation. This attribute can only be used with vmmDomain domain association. vlan is currently the only accepted value. |
|
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 |
|
Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association. |
|
Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association. vlan is currently the only accepted value. |
|
Determines when the policies should be resolved and available. Defaults to Choices:
|
|
The name of the schema. |
|
The name of the site. |
|
Use Use Choices:
|
|
Which switch type to use with this domain association. This attribute can only be used with vmmDomain domain association. |
|
Which switching mode to use with this domain association. This attribute can only be used with vmmDomain domain association. |
|
The name of the template. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: 30 |
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables Default: “admin” |
|
If This should only set to If the value is not specified in the task, the value of environment variable Choices:
|
|
Which VLAN enacap mode to use. This attribute can only be used with vmmDomain domain association. Choices:
|
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 mso_guide for more detailed information on how to manage your MSO infrastructure using Ansible.
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_site_anp_epg
The official documentation on the cisco.mso.mso_schema_site_anp_epg module.
- cisco.mso.mso_schema_template_anp_epg
The official documentation on the cisco.mso.mso_schema_template_anp_epg module.
Examples
- name: Add a new domain to a site EPG
cisco.mso.mso_schema_site_anp_epg_domain:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
anp: ANP1
epg: EPG1
domain_association_type: vmmDomain
domain_profile: 'VMware-VMM'
deployment_immediacy: lazy
resolution_immediacy: pre-provision
state: present
delegate_to: localhost
- name: Remove a domain from a site EPG
cisco.mso.mso_schema_site_anp_epg_domain:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
anp: ANP1
epg: EPG1
domain_association_type: vmmDomain
domain_profile: 'VMware-VMM'
deployment_immediacy: lazy
resolution_immediacy: pre-provision
state: absent
delegate_to: localhost
- name: Query a domain associated with a specific site EPG
cisco.mso.mso_schema_site_anp_epg_domain:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
anp: ANP1
epg: EPG1
domain_association_type: vmmDomain
domain_profile: 'VMware-VMM'
state: query
delegate_to: localhost
register: query_result
- name: Query all domains associated with a site EPG
cisco.mso.mso_schema_site_anp_epg_domain:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema1
site: Site1
template: Template1
anp: ANP1
epg: EPG1
state: query
delegate_to: localhost
register: query_result
Authors
Nirav Katarmal (@nkatarmal-crest)