ansible / ansible.builtin / v2.7.16 / module / aci_encap_pool_range Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk) | "added in version" 2.5 of ansible.builtin" Authors: Jacob McGill (@jmcgill298) preview | supported by certifiedansible.builtin.aci_encap_pool_range (v2.7.16) — module
pip
Install with pip install ansible==2.7.16
Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.
- name: Add a new VLAN pool range aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool: production pool_type: vlan pool_allocation_mode: static range_name: anstest range_start: 20 range_end: 40 allocation_mode: inherit state: present delegate_to: localhost
- name: Remove a VLAN pool range aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool: production pool_type: vlan pool_allocation_mode: static range_name: anstest range_start: 20 range_end: 40 state: absent delegate_to: localhost
- name: Query a VLAN range aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool: production pool_type: vlan pool_allocation_mode: static range_name: anstest range_start: 20 range_end: 50 state: query delegate_to: localhost register: query_result
- name: Query a VLAN pool for ranges by range_name aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool_type: vlan range_name: anstest state: query delegate_to: localhost register: query_result
- name: Query a VLAN pool for ranges by range_start aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool_type: vlan range_start: 20 state: query delegate_to: localhost register: query_result
- name: Query a VLAN pool for ranges by range_start and range_end aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool_type: vlan range_start: 20 range_end: 40 state: query delegate_to: localhost register: query_result
- name: Query all VLAN pool ranges aci_encap_pool_range: host: apic username: admin password: SomeSecretPassword pool_type: vlan state: query delegate_to: localhost register: query_result
host: aliases: - hostname description: - IP Address or hostname of APIC resolvable by Ansible control host. required: true type: str pool: aliases: - pool_name description: - The name of the pool that the range should be assigned to. port: description: - Port number to be used for REST connection. - The default value depends on parameter C(use_ssl). type: int state: choices: - absent - present - query default: present description: - Use C(present) or C(absent) for adding or removing. - Use C(query) for listing an object or multiple objects. timeout: default: 30 description: - The socket level timeout in seconds. type: int use_ssl: default: true description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection. type: bool password: description: - The password to use for authentication. - This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. required: true type: str username: aliases: - user default: admin description: - The username to use for authentication. type: str pool_type: aliases: - type choices: - vlan - vxlan - vsan description: - The encap type of C(pool). required: true range_end: aliases: - end description: - The end of encap range. type: int use_proxy: default: true description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool range_name: aliases: - name - range description: - The name to give to the encap range. description: aliases: - descr description: - Description for the pool range. output_path: description: - Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. type: str private_key: aliases: - cert_key description: - Either a PEM-formatted private key file or the private key content used for signature-based authentication. - This value also influences the default C(certificate_name) that is used. - This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. required: true type: str range_start: aliases: - start description: - The start of the encap range. type: int output_level: choices: - debug - info - normal default: normal description: - Influence the output of this ACI module. - C(normal) means the standard output, incl. C(current) dict - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information type: str validate_certs: default: true description: - If C(no), SSL certificates will not be validated. - This should only set to C(no) when used on personally controlled sites using self-signed certificates. type: bool allocation_mode: aliases: - mode choices: - dynamic - inherit - static description: - The method used for allocating encaps to resources. - Only vlan and vsan support allocation modes. certificate_name: aliases: - cert_name description: - The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. - If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. - If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. type: str pool_allocation_mode: aliases: - pool_mode choices: - dynamic - static description: - The method used for allocating encaps to resources. - Only vlan and vsan support allocation modes.
current: description: 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: '' type: list error: description: The error information as returned from the APIC returned: failure sample: code: '122' text: unknown managed object class foo type: dict filter_string: description: The filter string used for the request returned: failure or debug sample: ?rsp-prop-include=config-only type: string method: description: The HTTP method used for the request to the APIC returned: failure or debug sample: POST type: string previous: description: 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: '' type: list proposed: description: The assembled configuration from the user-provided parameters returned: info sample: fvTenant: attributes: descr: Production environment name: production type: dict raw: description: 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> type: string response: description: The HTTP response from the APIC returned: failure or debug sample: OK (30 bytes) type: string sent: description: The actual/minimal configuration pushed to the APIC returned: info sample: fvTenant: attributes: descr: Production environment type: list status: description: The HTTP status from the APIC returned: failure or debug sample: 200 type: int url: description: 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 type: string