aci_domain – Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP) — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

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

New in version 2.5.

- Synopsis
- Parameters
- See Also
- Examples
- Return Values
- Status

## Synopsis

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

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
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. 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 | 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. aliases: hostname
multicast_address string |  | The multicast IP address to use for the virtual switch.
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 REST connection. The default value depends on parameter `use_ssl`.
private_key string / required |  | 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. 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.
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. 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.
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

aci_aep_to_domain – Bind AEPs to Physical or Virtual Domains (infra:RsDomP)
  The official documentation on the aci_aep_to_domain module.
aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)
  The official documentation on the aci_domain_to_encap_pool module.
aci_domain_to_vlan_pool – Bind Domain to VLAN Pools (infra:RsVlanNs)
  The official documentation on the 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
      aci_domain:
        host: apic
        username: admin
        password: SomeSecretPassword
        domain: phys_dom
        domain_type: phys
        state: present

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

    - name: Add a new VMM domain
      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
      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
      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
      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 | 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 | 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 | 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Dag Wieers (@dagwieers)

Hint

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