cisco.aci.aci_vlan_pool_encap_block module – Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)
Note
This module is part of the cisco.aci collection (version 2.10.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.aci
.
To use it in a playbook, specify: cisco.aci.aci_vlan_pool_encap_block
.
Synopsis
Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
The method used for allocating encaps to resources. Choices:
|
|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
The end of encap block. |
|
The name to give to the encap block. |
|
The start of the encap block. |
|
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 |
|
Description for the pool encap block. |
|
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 |
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
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 |
|
The name of the pool that the encap block should be assigned to. |
|
The method used for allocating encaps to resources. Choices:
|
|
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 |
|
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 |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
Notes
Note
The
pool
must exist in order to add or delete a encap block.
See Also
See also
- cisco.aci.aci_encap_pool_range
Manage encap ranges assigned to pools (fvns:EncapBlk and fvns:VsanEncapBlk).
- cisco.aci.aci_vlan_pool
Manage VLAN pools (fvns:VlanInstP).
- APIC Management Information Model reference
More information about the internal APIC class fvns:EncapBlk.
- 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 a new VLAN encap block
cisco.aci.aci_vlan_pool_encap_block:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_allocation_mode: static
block_start: 20
block_end: 50
state: present
delegate_to: localhost
- name: Remove a VLAN encap block
cisco.aci.aci_vlan_pool_encap_block:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_allocation_mode: static
block_start: 20
block_end: 50
state: absent
delegate_to: localhost
- name: Query a VLAN encap block
cisco.aci.aci_vlan_pool_encap_block:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_allocation_mode: static
block_start: 20
block_end: 50
state: query
delegate_to: localhost
register: query_result
- name: Query a VLAN pool for encap blocks
cisco.aci.aci_vlan_pool_encap_block:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_allocation_mode: static
state: query
delegate_to: localhost
register: query_result
- name: Query all VLAN encap blocks
cisco.aci.aci_vlan_pool_encap_block:
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 |
Description |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |