cisco.aci.aci_domain – Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)

Note

This plugin is part of the cisco.aci collection (version 2.1.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.aci.

To use it in a playbook, specify: cisco.aci.aci_domain.

Synopsis

  • Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.

Parameters

Parameter Choices/Defaults Comments
add_infra_pg
boolean
    Choices:
  • no
  • yes
Configure port groups for infra VLAN (e.g. Virtual APIC).

aliases: infra_pg
annotation
string
User-defined string for annotating an object.
If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.
certificate_name
string
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
If a private_key filename was provided, this defaults to the private_key basename, without extension.
If PEM-formatted content was provided for private_key, this defaults to the username value.
If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.

aliases: cert_name
domain
string
Name of the physical, virtual, bridged routed or FC domain profile.

aliases: domain_name, domain_profile, name
domain_type
string / required
    Choices:
  • fc
  • l2dom
  • l3dom
  • phys
  • vmm
The type of domain profile.
fc: The FC domain profile is a policy pertaining to single FC Management domain
l2dom: The external bridged domain profile is a policy for managing L2 bridged infrastructure bridged outside the fabric.
l3dom: The external routed domain profile is a policy for managing L3 routed infrastructure outside the fabric.
phys: The physical domain profile stores the physical resources and encap resources that should be used for EPGs associated with this domain.
vmm: The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements.

aliases: type
dscp
string
    Choices:
  • AF11
  • AF12
  • AF13
  • AF21
  • AF22
  • AF23
  • AF31
  • AF32
  • AF33
  • AF41
  • AF42
  • AF43
  • CS0
  • CS1
  • CS2
  • CS3
  • CS4
  • CS5
  • CS6
  • CS7
  • EF
  • VA
  • unspecified
The target Differentiated Service (DSCP) value.
The APIC defaults to unspecified when unset during creation.

aliases: target
encap_mode
string
    Choices:
  • unknown
  • vlan
  • vxlan
The layer 2 encapsulation protocol to use with the virtual switch.
host
string / required
IP Address or hostname of APIC resolvable by Ansible control host.
If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.

aliases: hostname
multicast_address
string
The multicast IP address to use for the virtual switch.
name_alias
string
The alias for the current object. This relates to the nameAlias field in ACI.
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
If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.
output_path
string
Path to a file that will be used to dump the ACI JSON configuration objects generated by the module.
If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.
owner_key
string
User-defined string for the ownerKey attribute of an ACI object.
This attribute represents a key for enabling clients to own their data for entity correlation.
If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.
owner_tag
string
User-defined string for the ownerTag attribute of an ACI object.
This attribute represents a tag for enabling clients to add their own data.
For example, to indicate who created this object.
If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.
password
string
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.
If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Port number to be used for REST connection.
The default value depends on parameter use_ssl.
If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
private_key
string
Either a PEM-formatted private key file or the private key content used for signature-based authentication.
This value also influences the default certificate_name that is used.
This option is mutual exclusive with password. If password is provided too, it will be ignored.
If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.

aliases: cert_key
state
string
    Choices:
  • absent
  • present ←
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
tag_collection
boolean
    Choices:
  • no
  • yes
Enables Cisco APIC to collect VMs that have been assigned tags in VMware vCenter for microsegmentation.
timeout
integer
Default:
30
The socket level timeout in seconds.
If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.
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.
If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, 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 ACI_USE_SSL will be used instead.
username
string
Default:
"admin"
The username to use for authentication.
If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

aliases: user
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.
If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead.
vm_provider
string
    Choices:
  • cloudfoundry
  • kubernetes
  • microsoft
  • openshift
  • openstack
  • redhat
  • vmware
The VM platform for VMM Domains.
Support for Kubernetes was added in ACI v3.0.
Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1.
vswitch
string
    Choices:
  • avs
  • default
  • dvs
  • unknown
The virtual switch to use for vmm domains.
The APIC defaults to default when unset during creation.

See Also

See also

cisco.aci.aci_aep_to_domain

The official documentation on the cisco.aci.aci_aep_to_domain module.

cisco.aci.aci_domain_to_encap_pool

The official documentation on the cisco.aci.aci_domain_to_encap_pool module.

cisco.aci.aci_domain_to_vlan_pool

The official documentation on the cisco.aci.aci_domain_to_vlan_pool module.

APIC Management Information Model reference

More information about the internal APIC classes phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP and fc:DomP

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Add a new physical domain
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    state: present

- name: Remove a physical domain
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    state: absent

- name: Add a new VMM domain
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: hyperv_dom
    domain_type: vmm
    vm_provider: microsoft
    state: present
  delegate_to: localhost

- name: Remove a VMM domain
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: hyperv_dom
    domain_type: vmm
    vm_provider: microsoft
    state: absent
  delegate_to: localhost

- name: Query a specific physical domain
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all domains
  cisco.aci.aci_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain_type: phys
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
current
list / elements=string
success
The existing configuration from the APIC after the module has finished

Sample:
[{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error
dictionary
failure
The error information as returned from the APIC

Sample:
{'code': '122', 'text': 'unknown managed object class foo'}
filter_string
string
failure or debug
The filter string used for the request

Sample:
?rsp-prop-include=config-only
method
string
failure or debug
The HTTP method used for the request to the APIC

Sample:
POST
previous
list / elements=string
info
The original configuration from the APIC before the module has started

Sample:
[{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
dictionary
info
The assembled configuration from the user-provided parameters

Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
raw
string
parse error
The raw output returned by the APIC REST API (xml or json)

Sample:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response
string
failure or debug
The HTTP response from the APIC

Sample:
OK (30 bytes)
sent
list / elements=string
info
The actual/minimal configuration pushed to the APIC

Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status
integer
failure or debug
The HTTP status from the APIC

Sample:
200
url
string
failure or debug
The HTTP url used for the request to the APIC

Sample:
https://10.11.12.13/api/mo/uni/tn-production.json


Authors

  • Dag Wieers (@dagwieers)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_domain_module.html