aci_epg_to_domain
Bind EPGs to Domains (fv:RsDomAtt)
Collection: cisco.aci
Full Name: cisco.aci.aci_epg_to_domain
Synopsis
Bind EPGs to Domains (fv:RsDomAtt)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| allow_useg | string | Allows micro-segmentation. The APIC defaults to C(encap) when unset during creation. | ||
| 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. | |
| ap | string | Name of an existing application network profile, that will contain the EPGs. | ||
| 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. | ||
| custom_epg_name | string | The custom epg name in VMM domain association. | ||
| delimiter | string | The delimiter. | ||
| deploy_immediacy | string | Determines when the policy is pushed to hardware Policy CAM. The APIC defaults to C(lazy) when unset during creation. | ||
| domain | string | Name of the physical or virtual domain being associated with the EPG. | ||
| domain_type | string | Specify whether the Domain is a physical (phys), a virtual (vmm) or an L2 external domain association (l2dom). | ||
| encap | int | The VLAN encapsulation for the EPG when binding a VMM Domain in static VLAN mode. The VLAN mode in UI is set to static when O(encap) is not set. This acts as the secondary encap when using useg. Accepted values range between C(1) and C(4096). | ||
| encap_mode | string | The encapsulation method to be used. The APIC defaults to C(auto) when unset during creation. If vxlan is selected, switching_mode must be “AVE”. | ||
| enhanced_lag_policy | string | Name of the VMM Domain Enhanced Lag Policy. | ||
| epg | string | Name of the end point group. | ||
| epg_cos | string | The class of service (CoS). The APIC defaults to C(cos_0) when unset during creation. | ||
| epg_cos_preference | string | The CoS preference. The APIC defaults to C(disabled) when unset during creation. | ||
| forged_transmits | string | reject | Allow forged transmits. A forged transmit occurs when a network adapter starts sending out traffic that identifies itself as something else. | |
| 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. | ||
| ipam_dhcp_override | string | The IP Address Management (IPAM) Dynamic Host Configuration Protocol (DHCP) override. Only applicable for Nutanix domains. | ||
| ipam_enabled | bool | The IPAM enabled state. Only applicable for Nutanix domains. The APIC defaults to C(false) when unset during creation. | ||
| ipam_gateway | string | The IPAM gateway. Only applicable for Nutanix domains. | ||
| lag_policy_name | string | The link aggregation group (LAG) policy name. | ||
| mac_changes | string | reject | Allows definition of new MAC addresses for the network adapter within the virtual machine (VM). | |
| netflow | bool | Determines if netflow should be enabled. The APIC defaults to C(false) when unset during creation. | ||
| netflow_direction | string | The NetFlow monitoring direction. The APIC defaults to C(both) when unset during creation. | ||
| number_of_ports | int | The number of ports. | ||
| 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. | ||
| 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. | ||
| port_allocation | string | The port allocation method. | ||
| port_binding | string | The port binding method. | ||
| primary_encap | int | Determines the primary VLAN ID when using useg. Accepted values range between C(1) and C(4096). | ||
| primary_encap_inner | int | The primary inner encapsulation. This is used for the portgroup at the VMWare Distributed Virtual Switch (DVS). This VLAN is internal to the DVS and is used for communication between the other VMs and the AVE VM at a host. Traffic is not forwarded to the fabric over the VLAN. Only applicable for Cisco ACI Virtual Edge (AVE) domains. Accepted values range between C(1) and C(4096). | ||
| 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. | ||
| promiscuous | string | reject | Allow/Disallow promiscuous mode in vmm domain | |
| resolution_immediacy | string | Determines when the policies should be resolved and available. The APIC defaults to C(lazy) when unset during creation. | ||
| secondary_encap_inner | int | The secondary inner encapsulation. This is used for the portgroup at the VMWare DVS. This VLAN is internal to the DVS and is used for communication between the other VMs and the AVE VM at a host. Traffic is not forwarded to the fabric over the VLAN. Only applicable for AVE domains. Accepted values range between C(1) and C(4096). | ||
| 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. | ||
| switching_mode | string | native | Switching Mode used by the switch | |
| tenant | string | Name of an existing tenant. | ||
| 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. | ||
| untagged_vlan | bool | The access vlan is untagged. | ||
| 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. | ||
| vmm_uplink_active | list | A list of active uplink IDs. The order decides the order in which active uplinks take over for a failed uplink. At least one active uplink must remain specified in the list when an active uplink was previously configured. | ||
| vmm_uplink_standby | list | A list of standby uplink IDs. At least one standby uplink must remain specified in the list when no active uplink is configured. |
Example
yaml
- {"cisco.aci.aci_epg_to_domain": {"ap": "anstest", "domain": "anstest", "domain_type": "phys", "epg": "anstest", "host": "apic", "password": "SomeSecretPassword", "state": "present", "tenant": "anstest", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new physical domain to EPG binding"}
- {"cisco.aci.aci_epg_to_domain": {"ap": "anstest", "domain": "anstest", "domain_type": "phys", "epg": "anstest", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "tenant": "anstest", "username": "admin"}, "delegate_to": "localhost", "name": "Remove an existing physical domain to EPG binding"}
- {"cisco.aci.aci_epg_to_domain": {"ap": "anstest", "domain": "anstest", "domain_type": "phys", "epg": "anstest", "host": "apic", "password": "SomeSecretPassword", "state": "query", "tenant": "anstest", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific physical domain to EPG binding", "register": "query_result"}
- {"cisco.aci.aci_epg_to_domain": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all domain to EPG bindings", "register": "query_result"}