You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.6.0).

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
allocation_mode aliases: mode string	The method used for allocating encaps to resources. Choices: "dynamic" "inherit" "static"
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. If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used. Default: "orchestrator:ansible"
block_end aliases: end integer	The end of encap block.
block_name aliases: name string	The name to give to the encap block.
block_start aliases: start integer	The start of the encap block.
certificate_name aliases: cert_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.
description aliases: descr string	Description for the pool encap block.
host aliases: hostname 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.
name_alias string	The alias for the current object. This relates to the nameAlias field in ACI.
output_level string	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. Choices: "debug" "info" "normal" ← (default)
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.
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.
pool aliases: pool_name string	The name of the pool that the encap block should be assigned to.
pool_allocation_mode aliases: pool_mode string	The method used for allocating encaps to resources. Choices: "dynamic" "static"
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.
private_key aliases: cert_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 or ANSIBLE_NET_SSH_KEYFILE will be used instead.
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: "absent" "present" ← (default) "query"
timeout integer	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. Default: 30
use_proxy boolean	If false, 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. Choices: false true ← (default)
use_ssl boolean	If false, 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. Choices: false true ← (default)
username aliases: user string	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. Default: "admin"
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false 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. Choices: false true ← (default)

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

The official documentation on the cisco.aci.aci_encap_pool_range module.

cisco.aci.aci_vlan_pool

The official documentation on the cisco.aci.aci_vlan_pool module.

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
current list / elements=string	The existing configuration from the APIC after the module has finished Returned: success Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	The error information as returned from the APIC Returned: failure Sample: {"code": "122", "text": "unknown managed object class foo"}
filter_string string	The filter string used for the request Returned: failure or debug Sample: "?rsp-prop-include=config-only"
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: "POST"
previous list / elements=string	The original configuration from the APIC before the module has started Returned: info Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw string	The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
response string	The HTTP response from the APIC Returned: failure or debug Sample: "OK (30 bytes)"
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status integer	The HTTP status from the APIC Returned: failure or debug Sample: 200
url string	The HTTP url used for the request to the APIC Returned: failure or debug Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

• Jacob McGill (@jmcgill298)

• Dag Wieers (@dagwieers)

Collection links

Issue Tracker Repository (Sources)