aci_epg_to_domain - Bind EPGs to Domains (fv:RsDomAtt)

New in version 2.4.

Synopsis

  • Bind EPGs to Physical and Virtual Domains on Cisco ACI fabrics.

Parameters

Parameter Choices/Defaults Comments
allow_useg
    Choices:
  • encap ←
  • useg
Allows micro-segmentation.
The APIC defaults new EPG to Domain bindings to use encap.
ap
Name of an existing application network profile, that will contain the EPGs.

aliases: app_profile, app_profile_name
certificate_name Default:
C(private_key) basename
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
It defaults to the private_key basename, without extension.

aliases: cert_name
deploy_immediacy
    Choices:
  • immediate
  • lazy ←
Determines when the policy is pushed to hardware Policy CAM.
The APIC defaults new EPG to Domain bindings to lazy.
domain
Name of the physical or virtual domain being associated with the EPG.

aliases: domain_name, domain_profile
domain_type
    Choices:
  • phys
  • vmm
Determines if the Domain is physical (phys) or virtual (vmm).

aliases: type
encap
    Choices:
  • range from 1 to 4096
The VLAN encapsulation for the EPG when binding a VMM Domain with static encap_mode.
This acts as the secondary encap when using useg.
encap_mode
    Choices:
  • auto ←
  • vlan
  • vxlan
The ecapsulataion method to be used.
The APIC defaults new EPG to Domain bindings to auto.
epg
Name of the end point group.

aliases: epg_name, name
host
required
IP Address or hostname of APIC resolvable by Ansible control host.

aliases: hostname
netflow
    Choices:
  • no ←
  • yes
Determines if netflow should be enabled.
The APIC defaults new EPG to Domain binings to no.
output_level
    Choices:
  • debug
  • info
  • normal ←
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info means informational output, incl. previous, proposed and sent dicts
debug means debugging output, incl. filter_string, method, response, status and url information
password
required
The password to use for authentication.
port Default:
443 (for https) and 80 (for http)
Port number to be used for REST connection.
primary_encap
    Choices:
  • range from 1 to 4096
Determines the primary VLAN ID when using useg.
private_key
PEM formatted file that contains your private key to be used for signature-based authentication.
The name of the key (without extension) is used as the certificate name in ACI, unless certificate_name is specified.

aliases: cert_key
resolution_immediacy
    Choices:
  • immediate
  • lazy ←
  • pre-provision
Determines when the policies should be resolved and available.
The APIC defaults new EPG to Domain bindings to lazy.
state
    Choices:
  • absent
  • present ←
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
tenant
Name of an existing tenant.

aliases: tenant_name
timeout Default:
30
The socket level timeout in seconds.
use_proxy
    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
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
required
 Default:
admin
The username to use for authentication.

aliases: user
validate_certs
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.
vm_provider
    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.

Notes

Note

  • The 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.
  • OpenStack VMM domains must not be created using this module. The OpenStack VMM domain is created directly by the Cisco APIC Neutron plugin as part of the installation and configuration. This module can be used to query status of an OpenStack VMM domain.
  • More information about the internal APIC class fv:RsDomAtt from the APIC Management Information Model reference.
  • By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
  • HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Examples

- 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

- 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

- 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

- name: Query all domain to EPG bindings
  aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}]
error
dict
 failure
The error information as returned from the APIC

Sample:
{'text': 'unknown managed object class foo', 'code': '122'}
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production', 'nameAlias': '', 'ownerTag': ''}}}]
proposed
dict
 info
The assembled configuration from the user-provided parameters

Sample:
{'fvTenant': {'attributes': {'name': 'production', 'descr': 'Production environment'}}}
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
int
 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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Jacob McGill (@jmcgill298)

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.5/modules/aci_epg_to_domain_module.html