cisco.aci.aci_epg_to_domain – Bind EPGs to Domains (fv:RsDomAtt)

Note

This plugin is part of the cisco.aci collection (version 1.1.1).

To install it use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_epg_to_domain.

Synopsis
Parameters
Notes
See Also
Examples
Return Values

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
allow_useg string	encap useg	Allows micro-segmentation. The APIC defaults to `encap` when unset during creation.
annotation string		User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable `ACI_ANNOTATION` will be used instead.
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. If the value is not specified in the task, the value of environment variable `ACI_CERTIFICATE_NAME` will be used instead. aliases: cert_name
deploy_immediacy string	immediate lazy	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	l2dom phys vmm	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	auto vlan vxlan	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. If the value is not specified in the task, the value of environment variable `ACI_HOST` will be used instead. aliases: hostname
netflow boolean	no yes	Determines if netflow should be enabled. The APIC defaults to `no` when unset during creation.
output_level string	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 If the value is not specified in the task, the value of environment variable `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 `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 `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 `ACI_OWNER_TAG` will be used instead.
password string		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. If the value is not specified in the task, the value of environment variables `ACI_PASSWORD` or `ANSIBLE_NET_PASSWORD` will be used instead.
port integer		Port number to be used for REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable `ACI_PORT` will be used instead.
primary_encap integer		Determines the primary VLAN ID when using useg. Accepted values range between `1` and `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 `certificate_name` that is used. This option is mutual exclusive with `password`. If `password` is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable `ACI_PRIVATE_KEY` will be used instead. aliases: cert_key
promiscuous string	accept reject ←	Allow/Disallow promiscuous mode in vmm domain
resolution_immediacy string	immediate lazy pre-provision	Determines when the policies should be resolved and available. The APIC defaults to `lazy` when unset during creation.
state string	absent present ← query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
switching_mode string	AVE native ←	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. If the value is not specified in the task, the value of environment variable `ACI_TIMEOUT` will be used instead.
use_proxy boolean	no yes ←	If `no`, 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 `ACI_USE_PROXY` will be used instead.
use_ssl boolean	no yes ←	If `no`, 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 `ACI_USE_SSL` will be used instead.
username string	Default: "admin"	The username to use for authentication. If the value is not specified in the task, the value of environment variables `ACI_USERNAME` or `ANSIBLE_NET_USERNAME` will be used instead. aliases: user
validate_certs boolean	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. If the value is not specified in the task, the value of environment variable `ACI_VALIDATE_CERTS` will be used instead.
vm_provider string	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 cisco.aci.aci_tenant cisco.aci.aci_ap, cisco.aci.aci_epg cisco.aci.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.

Examples

- name: Add a new physical domain to EPG binding
  cisco.aci.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
  cisco.aci.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
  cisco.aci.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
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    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 / elements=string	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 / elements=string	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:
response string	failure or debug	The HTTP response from the APIC Sample: OK (30 bytes)
sent list / elements=string	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

Authors

Jacob McGill (@jmcgill298)
Shreyas Srish (@shrsr)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_epg_to_domain_module.html

cisco.aci.aci_epg_to_domain – Bind EPGs to Domains (fv:RsDomAtt)

cisco.aci.aci_epg_to_domain – Bind EPGs to Domains (fv:RsDomAtt)

Synopsis

Parameters

Notes

See Also

Examples

Return Values

Authors