New in version 2.4.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| allow_useg string |
| Allows micro-segmentation. The APIC defaults to encap when unset during creation. |
| ap string | Name of an existing application network profile, that will contain the EPGs. aliases: app_profile, app_profile_name | |
| 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 | |
| deploy_immediacy string |
| Determines when the policy is pushed to hardware Policy CAM. The APIC defaults to lazy when unset during creation. |
| domain string | Name of the physical or virtual domain being associated with the EPG. aliases: domain_name, domain_profile | |
| domain_type string |
| Specify whether the Domain is a physical (phys), a virtual (vmm) or an L2 external domain association (l2dom). aliases: type |
| encap integer | The VLAN encapsulation for the EPG when binding a VMM Domain with static encap_mode.This acts as the secondary encap when using useg. Accepted values range between 1 and 4096. | |
| encap_mode string |
| The encapsulation method to be used. The APIC defaults to auto when unset during creation.If vxlan is selected, switching_mode must be "AVE". |
| epg string | Name of the end point group. aliases: epg_name, name | |
| host string / required | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname | |
| netflow boolean |
| Determines if netflow should be enabled. The APIC defaults to no when unset during creation. |
| output_level string |
| Influence the output of this ACI module. normal means the standard output, incl. current dictinfo adds informational output, incl. previous, proposed and sent dictsdebug 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. | |
| primary_encap integer | Determines the primary VLAN ID when using useg. Accepted values range between 1 and 4096. | |
| 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 | |
| resolution_immediacy string |
| Determines when the policies should be resolved and available. The APIC defaults to lazy when unset during creation. |
| state string |
| Use present or absent for adding or removing.Use query for listing an object or multiple objects. |
| switching_mode string added in 2.9 |
| Switching Mode used by the switch |
| tenant string | Name of an existing tenant. aliases: tenant_name | |
| timeout integer | Default: 30 | The socket level timeout in seconds. |
| use_proxy boolean |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| use_ssl boolean |
| 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 |
| 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 |
| 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. |
Note
tenant, ap, epg, and domain used must exist before using this module in your playbook. The aci_tenant aci_ap, aci_epg aci_domain modules can be used for this.See also
- name: Add a new physical domain to EPG binding
aci_epg_to_domain:
host: apic
username: admin
password: SomeSecretPassword
tenant: anstest
ap: anstest
epg: anstest
domain: anstest
domain_type: phys
state: present
delegate_to: localhost
- name: Remove an existing physical domain to EPG binding
aci_epg_to_domain:
host: apic
username: admin
password: SomeSecretPassword
tenant: anstest
ap: anstest
epg: anstest
domain: anstest
domain_type: phys
state: absent
delegate_to: localhost
- name: Query a specific physical domain to EPG binding
aci_epg_to_domain:
host: apic
username: admin
password: SomeSecretPassword
tenant: anstest
ap: anstest
epg: anstest
domain: anstest
domain_type: phys
state: query
delegate_to: localhost
register: query_result
- name: Query all domain to EPG bindings
aci_epg_to_domain:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
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 |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aci_epg_to_domain_module.html