aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)
aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)
New in version 2.5.
Synopsis
- Bind Domain to Encap Pools on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
certificate_name string |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for
| |
domain string |
Name of the domain being associated with the Encap Pool.
| |
domain_type string |
|
Determines if the Domain is physical (phys) or virtual (vmm). |
host string / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
output_level string |
|
Influence the output of this ACI module.
|
password string / required |
The password to use for authentication. This option is mutual exclusive with | |
pool string |
The name of the pool.
| |
pool_allocation_mode string |
|
The method used for allocating encaps to resources. Only vlan and vsan support allocation modes.
|
pool_type string / required |
|
The encap type of |
port integer |
Port number to be used for REST connection. The default value depends on parameter | |
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 This option is mutual exclusive with
| |
state string |
|
Use Use |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username string |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
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. |
Notes
Note
- The
domain
andencap_pool
parameters should exist before using this module. The aci_domain and aci_encap_pool can be used for these.
See Also
See also
- aci_domain – Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)
- The official documentation on the aci_domain module.
- aci_encap_pool – Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)
- The official documentation on the aci_encap_pool module.
- APIC Management Information Model reference
- More information about the internal APIC class infra:RsVlanNs.
- Cisco ACI Guide
- Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
- Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- name: Add domain to VLAN pool binding
aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: present
delegate_to: localhost
- name: Remove domain to VLAN pool binding
aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: absent
delegate_to: localhost
- name: Query our domain to VLAN pool binding
aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: query
delegate_to: localhost
register: query_result
- name: Query all domain to VLAN pool bindings
aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain_type: phys
pool_type: vlan
pool_allocation_mode: dynamic
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 |
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:
|
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: |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_domain_to_encap_pool_module.html