Модуль cisco.aci.aci_encap_pool — управление пулами инкапсуляции (fvns:VlanInstP, fvns:VxlanInstP и fvns:VsanInstP)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_encap_pool.

Краткое описание
Параметры
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление пулами VLAN, VXLAN и VSAN в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, связанного с пользователем AAA APIC, который используется для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется базовое имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание для `pool`.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Управляет выводом этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут сохраняться объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку, позволяющую клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, он будет использован вместо этого параметра. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pool псевдонимы: name, pool_name строка	Имя пула.
pool_allocation_mode псевдонимы: allocation_mode, mode строка	Метод выделения инкапсуляций ресурсам. Режимы выделения поддерживаются только для VLAN и VSAN. Варианты: `"dynamic"` `"static"`
pool_type псевдонимы: type строка / обязательный	Тип инкапсуляции для `pool`. Варианты: `"vlan"` `"vsan"` `"vxlan"`
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, перед POST-запросом на обновление APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — при этом возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после POST-запроса на обновление APIC не будет отправлен GET-запрос для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — при этом возвращаемое текущее значение будет установлено равным предложенному. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy логический	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию — true при локальном подключении. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логический	Если `false`, SSL-сертификаты не будут проверяться. Устанавливайте значение `false` только для подконтрольных вам сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

cisco.aci.aci_encap_pool_range: Управление диапазонами инкапсуляции, назначенными пулам (fvns:EncapBlk и fvns:VsanEncapBlk).
cisco.aci.aci_vlan_pool: Управление пулами VLAN (fvns:VlanInstP).
Справочник информационной модели управления APIC: Дополнительная информация о внутренних классах APIC fvns:VlanInstP, fvns:VxlanInstP и fvns:VsanInstP
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new vlan pool
  cisco.aci.aci_encap_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_type: vlan
    description: Production VLANs
    state: present
  delegate_to: localhost

- name: Remove a vlan pool
  cisco.aci.aci_encap_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_type: vlan
    state: absent
  delegate_to: localhost

- name: Query a vlan pool
  cisco.aci.aci_encap_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_type: vlan
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all vlan pools
  cisco.aci.aci_encap_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool_type: vlan
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
current список / элементы=строка	Существующая конфигурация APIC после завершения работы модуля Возвращается: при успехе Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Сведения об ошибке, возвращённые APIC Возвращается: при сбое Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Строка фильтра, использованная для запроса Возвращается: при сбое или в режиме отладки Пример: `"?rsp-prop-include=config-only"`
method строка	Метод HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация APIC до начала работы модуля Возвращается: при информационном выводе Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собранная конфигурация на основе параметров, заданных пользователем Возвращается: при информационном выводе Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращённый REST API APIC (XML или JSON) Возвращается: при ошибке разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	Ответ HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, переданная в APIC Возвращается: при информационном выводе Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	Статус HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: `200`
url строка	URL HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Jacob McGill (@jmcgill298)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_encap_pool_module.html