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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Управление блоками encap VLAN, назначенными для 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` basename без расширения. псевдонимы: cert_name
description		Описание блока encap для пула. псевдонимы: descr
host обязательно		IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. псевдонимы: hostname
output_level	Варианты: debug info normal ←	Влияет на вывод этого ACI-модуля. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `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, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `certificate_name`. Этот параметр является взаимоисключающим с `password`. Если указан `password`, он будет проигнорирован. псевдонимы: cert_key
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
timeout int	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использован, даже если он определен в переменной окружения на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с сайтами, управляемыми лично, с использованием самозаверяющих сертификатов.

Примечания

Примечание

Файл pool должен существовать для добавления или удаления блока encap.
Дополнительную информацию о внутреннем классе APIC fvns:EncapBlk можно найти в справочнике по модели управления информацией APIC.
Подробнее о том, как управлять инфраструктурой ACI с помощью Ansible, см. в Руководстве 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

- 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

- 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

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

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

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

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

Ключ	Результат	Описание
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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/aci_vlan_pool_encap_block_module.html