cisco.aci.aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)
cisco.aci.aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)
Note
This plugin is part of the cisco.aci collection (version 2.0.0).
To install it use: ansible-galaxy collection install cisco.aci
.
To use it in a playbook, specify: cisco.aci.aci_domain_to_encap_pool
.
Synopsis
- Bind Domain to Encap Pools on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
annotation string |
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable | |
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 If the value is not specified in the task, the value of environment variable
| |
domain string |
Name of the domain being associated with the Encap Pool.
| |
domain_type string / required |
|
Determines if the Domain is physical (phys) or virtual (vmm). |
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
| |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
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 | |
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 | |
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 | |
password string |
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables | |
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 If the value is not specified in the task, the value of environment variable | |
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 This option is mutual exclusive with If the value is not specified in the task, the value of environment variable
| |
state string |
|
Use Use |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables
|
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
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 cisco.aci.aci_domain and cisco.aci.aci_encap_pool can be used for these.
See Also
See also
- cisco.aci.aci_domain
- The official documentation on the cisco.aci.aci_domain module.
- cisco.aci.aci_encap_pool
- The official documentation on the cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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 / 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: |
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_domain_to_encap_pool_module.html