aci_vlan_pool_encap_block – Управление блоками encap, назначенными пулам VLAN (fvns:EncapBlk)

Новая в версии 2.5.

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

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

Управление блоками VLAN encap, назначенными пулам VLAN на Cisco ACI фабриках.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allocation_mode строка	Варианты: dynamic inherit static	Метод, используемый для распределения encap ресурсам. псевдонимы: mode
block_end целое число		Конец блока encap. псевдонимы: end
block_name строка		Имя, присваиваемое блоку encap. псевдонимы: name
block_start целое число		Начало блока encap. псевдонимы: start
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено `private_key` имя файла, по умолчанию используется `private_key` базовое имя без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется `username` значение. псевдонимы: cert_name
description строка		Описание блока encap пула. псевдонимы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимый управляющим хостом Ansible. псевдонимы: hostname
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password строка / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также предоставлен `private_key`, он будет использован вместо него.
pool строка		Имя пула, которому должен быть назначен блок encap. псевдонимы: pool_name
pool_allocation_mode строка	Варианты: dynamic static	Метод, используемый для распределения encap ресурсам. псевдонимы: pool_mode
port целое число		Номер порта для использования в подключении REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также предоставлено `password`, оно будет проигнорировано. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода объекта или нескольких объектов.
timeout целое число	По умолчанию: 30	Таймаут сокета в секундах.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при работе с сайтами под собственным контролем, использующими самозаверяющие сертификаты.

Примечания

Примечание

pool должен существовать для добавления или удаления блока encap.

См. также

aci_encap_pool_range – Управление диапазонами encap, назначенными пулам (fvns:EncapBlk, fvns:VsanEncapBlk): Официальная документация модуля aci_encap_pool_range.
aci_vlan_pool – Управление пулами VLAN (fvns:VlanInstP): Официальная документация модуля aci_vlan_pool.
APIC Management Information Model reference: Дополнительная информация об внутренней APIC классе fvns:EncapBlk.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.

Примеры

- name: Add a new VLAN encap block
  aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    block_start: 20
    block_end: 50
    state: present
  delegate_to: localhost

- name: Remove a VLAN encap block
  aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    block_start: 20
    block_end: 50
    state: absent
  delegate_to: localhost

- name: Query a VLAN encap block
  aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    block_start: 20
    block_end: 50
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a VLAN pool for encap blocks
  aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VLAN encap blocks
  aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

Jacob McGill (@jmcgill298)
Dag Wieers (@dagwieers)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_vlan_pool_encap_block_module.html