ansible.builtin.mso_schema_site_anp_epg_domain (v2.9.13) — module

Manage site-local EPG domains in schema template

| "added in version" 2.9 of ansible.builtin"

Authors: Nirav Katarmal (@nkatarmal-crest)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

Manage site-local EPG domains in schema template on Cisco ACI Multi-Site.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
anp:
    description:
    - The name of the ANP.
    required: true
    type: str

epg:
    description:
    - The name of the EPG.
    required: true
    type: str

host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of the ACI Multi Site Orchestrator host.
    required: true
    type: str

port:
    description:
    - Port number to be used for the REST connection.
    - The default value depends on parameter `use_ssl`.
    type: int

site:
    description:
    - The name of the site.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    - query
    default: present
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    type: str

schema:
    description:
    - The name of the schema.
    required: true
    type: str

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    type: int

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

password:
    description:
    - The password to use for authentication.
    - This option is mutual exclusive with C(private_key). If C(private_key) is provided
      too, it will be used instead.
    required: true
    type: str

template:
    description:
    - The name of the template.
    required: true
    type: str

username:
    default: admin
    description:
    - The username to use for authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

switch_type:
    description:
    - Which switch type to use with this domain association. This attribute can only be
      used with vmmDomain domain association.
    type: str

login_domain:
    description:
    - The login domain name to use for authentication.
    - The default value is Local.
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - Influence the output of this ACI module.
    - C(normal) means the standard output, incl. C(current) dict
    - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
    - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
      C(status) and C(url) information
    type: str

domain_profile:
    description:
    - The domain profile name.
    type: str

micro_seg_vlan:
    description:
    - Virtual LAN for microsegmentation. This attribute can only be used with vmmDomain
      domain association.
    type: int

switching_mode:
    description:
    - Which switching mode to use with this domain association. This attribute can only
      be used with vmmDomain domain association.
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    type: bool

port_encap_vlan:
    description:
    - Virtual LAN type for port encap. This attribute can only be used with vmmDomain
      domain association.
    type: int

vlan_encap_mode:
    choices:
    - static
    - dynamic
    description:
    - Which VLAN enacap mode to use. This attribute can only be used with vmmDomain domain
      association.
    type: str

micro_seg_vlan_type:
    description:
    - Virtual LAN type for microsegmentation. This attribute can only be used with vmmDomain
      domain association.
    type: str

deployment_immediacy:
    choices:
    - immediate
    - lazy
    description:
    - The deployment immediacy of the domain.
    - C(immediate) means B(Deploy immediate).
    - C(lazy) means B(deploy on demand).
    type: str

port_encap_vlan_type:
    description:
    - Virtual LAN type for port encap. This attribute can only be used with vmmDomain
      domain association.
    type: str

resolution_immediacy:
    choices:
    - immediate
    - lazy
    - pre-provision
    description:
    - Determines when the policies should be resolved and available.
    - Defaults to C(lazy) when unset during creation.
    type: str

enhanced_lagpolicy_dn:
    description:
    - Distinguished name of EPG lagpolicy. This attribute can only be used with vmmDomain
      domain association.
    type: str

domain_association_type:
    choices:
    - vmmDomain
    - l3ExtDomain
    - l2ExtDomain
    - physicalDomain
    - fibreChannel
    description:
    - The type of domain to associate.
    type: str

enhanced_lagpolicy_name:
    description:
    - EPG enhanced lagpolicy name. This attribute can only be used with vmmDomain domain
      association.
    type: str

allow_micro_segmentation:
    description:
    - Specifies microsegmentation is enabled or not. This attribute can only be used with
      vmmDomain domain association.
    type: bool

See also