mso_schema_site_anp_epg_domain – Manage site-local EPG domains in schema template

New in version 2.9.

Synopsis

• Manage site-local EPG domains in schema template 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
allow_micro_segmentation boolean	Choices: no yes	Specifies microsegmentation is enabled or not. This attribute can only be used with vmmDomain domain association.
anp string / required		The name of the ANP.
deployment_immediacy string	Choices: immediate lazy	The deployment immediacy of the domain. immediate means Deploy immediate. lazy means deploy on demand.
domain_association_type string	Choices: vmmDomain l3ExtDomain l2ExtDomain physicalDomain fibreChannel	The type of domain to associate.
domain_profile string		The domain profile name.
enhanced_lagpolicy_dn string		Distinguished name of EPG lagpolicy. This attribute can only be used with vmmDomain domain association.
enhanced_lagpolicy_name string		EPG enhanced lagpolicy name. This attribute can only be used with vmmDomain domain association.
epg string / required		The name of the EPG.
host string / required		IP Address or hostname of the ACI Multi Site Orchestrator host. aliases: hostname
micro_seg_vlan integer		Virtual LAN for microsegmentation. This attribute can only be used with vmmDomain domain association.
micro_seg_vlan_type string		Virtual LAN type for microsegmentation. This attribute can only be used with vmmDomain domain association.
output_level string	Choices: debug info normal ←	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information
password string / required		The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
port integer		Port number to be used for the REST connection. The default value depends on parameter `use_ssl`.
port_encap_vlan integer		Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association.
port_encap_vlan_type string		Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association.
resolution_immediacy string	Choices: immediate lazy pre-provision	Determines when the policies should be resolved and available. Defaults to lazy when unset during creation.
schema string / required		The name of the schema.
site string / required		The name of the site.
state string	Choices: absent present ← query	Use present or absent for adding or removing. Use query for listing an object or multiple objects.
switch_type string		Which switch type to use with this domain association. This attribute can only be used with vmmDomain domain association.
switching_mode string		Which switching mode to use with this domain association. This attribute can only be used with vmmDomain domain association.
template string / required		The name of the template.
timeout integer	Default: 30	The socket level timeout in seconds.
use_proxy boolean	Choices: no yes ←	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean	Choices: no yes ←	If no, an HTTP connection will be used instead of the default HTTPS connection.
username string	Default: "admin"	The username to use for authentication.
validate_certs boolean	Choices: no yes ←	If no, SSL certificates will not be validated. This should only set to no when used on personally controlled sites using self-signed certificates.
vlan_encap_mode string	Choices: static dynamic	Which VLAN enacap mode to use. This attribute can only be used with vmmDomain domain association.

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

mso_schema_site_anp_epg – Manage site-local Endpoint Groups (EPGs) in schema template

The official documentation on the mso_schema_site_anp_epg module.

mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates

The official documentation on the mso_schema_template_anp_epg module.

Examples

- name: Add a new static leaf to a site EPG
  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 static leaf from a site EPG
  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 specific site EPG static leaf
  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 site EPG static leafs
  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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Nirav Katarmal (@nkatarmal-crest)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.