aci_domain
Manage physical and virtual domains on Cisco ACI
Collection: cisco.aci
Full Name: cisco.aci.aci_domain
Synopsis
Manage physical and virtual domains on Cisco ACI
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_mode | string | Access mode for vmm domains This parameter cannot be changed after a domain is created | ||
| add_infra_pg | bool | Configure port groups for infra VLAN (e.g. Virtual APIC). | ||
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| domain | string | Name of the physical, virtual, bridged routed or FC domain profile. | ||
| domain_type | string | yes | The type of domain profile. C(fc): The FC domain profile is a policy pertaining to single FC Management domain C(l2dom): The external bridged domain profile is a policy for managing L2 bridged infrastructure bridged outside the fabric. C(l3dom): The external routed domain profile is a policy for managing L3 routed infrastructure outside the fabric. C(phys): The physical domain profile stores the physical resources and encap resources that should be used for EPGs associated with this domain. C(vmm): The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. | |
| dscp | string | The target Differentiated Service (DSCP) value. The APIC defaults to C(unspecified) when unset during creation. | ||
| enable_vm_folder | bool | Enable VM folder data retrieval | ||
| encap_mode | string | The layer 2 encapsulation protocol to use with the virtual switch. | ||
| host | string | 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 C(ACI_HOST) will be used instead. | ||
| 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 | normal | 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 If the value is not specified in the task, the value of environment variable C(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 C(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 C(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 C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | 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. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| tag_collection | bool | Enables Cisco APIC to collect VMs that have been assigned tags in VMware vCenter for microsegmentation. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(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 C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(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 C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(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 C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. | ||
| vm_provider | string | 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 | The virtual switch to use for vmm domains. The APIC defaults to C(default) when unset during creation. |
Example
yaml
- {"cisco.aci.aci_domain": {"domain": "phys_dom", "domain_type": "phys", "host": "apic", "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "name": "Add a new physical domain"}
- {"cisco.aci.aci_domain": {"domain": "phys_dom", "domain_type": "phys", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "username": "admin"}, "name": "Remove a physical domain"}
- {"cisco.aci.aci_domain": {"domain": "hyperv_dom", "domain_type": "vmm", "host": "apic", "password": "SomeSecretPassword", "state": "present", "username": "admin", "vm_provider": "microsoft"}, "delegate_to": "localhost", "name": "Add a new VMM domain"}
- {"cisco.aci.aci_domain": {"domain": "hyperv_dom", "domain_type": "vmm", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "username": "admin", "vm_provider": "microsoft"}, "delegate_to": "localhost", "name": "Remove a VMM domain"}
- {"cisco.aci.aci_domain": {"domain": "phys_dom", "domain_type": "phys", "host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific physical domain", "register": "query_result"}
- {"cisco.aci.aci_domain": {"domain_type": "phys", "host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all domains", "register": "query_result"}