cisco.mso.mso_schema_site_anp_epg_domain module – Manage site-local EPG domains in schema template

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_site_anp_epg_domain.

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	Comments
allow_micro_segmentation boolean	Specifies microsegmentation is enabled or not. This attribute can only be used with VMM domain association. Choices: false true
allow_promiscuous string	The allow promiscuous state of the domain association. This attribute can only be used with VMM domain association. Choices: "accept" "reject" ← (default)
anp string / required	The name of the ANP.
binding_type string	Which binding_type to use with this domain association. This attribute can only be used with VMM domain association. Choices: "static" "dynamic" "none" ← (default) "ephemeral"
custom_epg_name string	Which custom_epg_name to use with this domain association. This attribute can only be used with VMM domain association.
delimiter string	Which delimiter to use with this domain association. This attribute can only be used with VMM domain association. Choices: "+" "|" "~" "!" "@" "^" "="
deployment_immediacy string	The deployment immediacy of the domain. immediate means Deploy immediate. lazy means deploy on demand. Choices: "immediate" "lazy"
domain_association_type string	The type of domain to associate. Choices: "vmmDomain" "l3ExtDomain" "l2ExtDomain" "physicalDomain" "fibreChannelDomain"
domain_profile string	The domain profile name.
enhanced_lagpolicy_dn string	Distinguished name of EPG lagpolicy. This attribute can only be used with VMM domain association.
enhanced_lagpolicy_name string	EPG enhanced lagpolicy name. This attribute can only be used with VMM domain association.
epg string / required	The name of the EPG.
forged_transmits string	The forged transmits state of the domain association. This attribute can only be used with VMM domain association. Choices: "accept" "reject" ← (default)
host aliases: hostname string	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 MSO_HOST will be used instead.
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 MSO_LOGIN_DOMAIN will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.
mac_changes string	The mac changes state of the domain association. This attribute can only be used with VMM domain association. Choices: "accept" "reject" ← (default)
micro_seg_vlan integer	Virtual LAN for microsegmentation. This attribute can only be used with VMM domain association.
micro_seg_vlan_type string	Virtual LAN type for microsegmentation. This attribute can only be used with VMM domain association. Choices: "vlan"
netflow_pref string	The netflow preference state of the domain association. This attribute can only be used with VMM domain association. Choices: "enabled" "disabled" ← (default)
num_ports integer	Number of ports for the binding type. This attribute can only be used with VMM domain association.
output_level string	Influence the output of this MSO 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 If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
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 MSO_PORT will be used instead.
port_allocation string	Port allocation for the binding type. This attribute can only be used with VMM domain association and binding type in static. Required when binding_type=static. Choices: "elastic" "fixed"
port_encap_vlan integer	Virtual LAN type for port encap. This attribute can only be used with VMM domain association.
port_encap_vlan_type string	Virtual LAN type for port encap. This attribute can only be used with VMM domain association. Choices: "vlan"
resolution_immediacy string	Determines when the policies should be resolved and available. Defaults to lazy when unset during creation. Choices: "immediate" "lazy" "pre-provision"
schema string / required	The name of the schema.
site string / required	The name of the site.
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: "absent" "present" ← (default) "query"
switch_type string	Which switch type to use with this domain association. This attribute can only be used with VMM domain association.
switching_mode string	Which switching mode to use with this domain association. This attribute can only be used with VMM domain association.
template string / required	The name of the template.
timeout integer	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 MSO_TIMEOUT will be used instead.
use_proxy boolean	If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead. The default is true. Choices: false true
use_ssl boolean	If false, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified. The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso). Choices: false true
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead. The default is true. Choices: false true
vlan_encap_mode string	Which VLAN enacap mode to use. This attribute can only be used with VMM domain association. Choices: "static" "dynamic"

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.

• 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

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

cisco.mso.mso_schema_template_anp_epg

Manage Endpoint Groups (EPGs) in schema templates.

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

- name: Add a new domain to a site EPG with all possible attributes set
  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: immediate
    resolution_immediacy: immediate
    micro_seg_vlan_type: vlan
    micro_seg_vlan: 100
    port_encap_vlan_type: vlan
    port_encap_vlan: 100
    vlan_encap_mode: static
    allow_micro_segmentation: true
    switch_type: default
    switching_mode: native
    enhanced_lagpolicy_name: ansible_lag_name
    enhanced_lagpolicy_dn: ansible_lag_dn
    delimiter: '|'
    binding_type: static
    num_ports: 2
    port_allocation: elastic
    netflow_pref: enabled
    allow_promiscuous: accept
    forged_transmits: accept
    mac_changes: accept
    custom_epg_name: ansible_custom_epg
    state: present

- 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
  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
  register: query_result

- 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

Authors

• Nirav Katarmal (@nkatarmal-crest)

• Mabille Florent (@fmabille09)

• Akini Ross (@akinross)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)