aci_vlan_pool_encap_block — Управление блоками encap, назначенными для VLAN-пулов (fvns:EncapBlk)
Новое в версии 2.5.
Описание
- Управление блоками VLAN encap, назначенными для VLAN-пулов на Cisco ACI-фабриках.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allocation_mode |
| Метод, используемый для распределения encaps в ресурсы. Псевдонимы: режим |
| block_end | Конец блока encap. Псевдонимы: конец | |
| block_name | Имя, которое нужно присвоить блоку encap. Псевдонимы: имя | |
| block_start | Начало блока encap. Псевдонимы: начало | |
| certificate_name | Значение по умолчанию: C(private_key) basename | Имя X.509 сертификата, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно private_key basename без расширения.Псевдонимы: имя_сертификата |
| description | Описание блока encap для пула. Псевдонимы: описание | |
| host обязательно | IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. Псевдонимы: имя_хоста | |
| output_level |
| Влияет на вывод данного ACI-модуля. normal означает стандартный вывод, включая current словарьinfo означает информативный вывод, включая previous, proposed и sent словариdebug означает отладочный вывод, включая filter_string, method, response, status и url информацию |
| password обязательно | Пароль для аутентификации. | |
| pool | Имя пула, которому должен быть назначен блок encap. Псевдонимы: имя_пула | |
| pool_allocation_mode |
| Метод, используемый для распределения encaps в ресурсы. Псевдонимы: режим_пула |
| port | Значение по умолчанию: 443 (для https) и 80 (для http) | Номер порта, используемого для подключения REST. |
| private_key | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если certificate_name не указан.Псевдонимы: ключ_сертификата | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| timeout | Значение по умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy |
| Если no, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. |
| use_ssl |
| Если no, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. |
| username обязательно | Значение по умолчанию: admin | Имя пользователя для аутентификации. Псевдонимы: пользователь |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует установить только на no для использования на сайтах с собственноручно подписанными сертификатами. |
Примечания
Примечание
poolдолжен существовать для добавления или удаления блока encap.- Дополнительную информацию о внутреннем классе APIC fvns:EncapBlk можно найти в справочнике по модели управления информацией APIC.
- По умолчанию, если на целевом хосте установлена переменная окружения
<protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. установку среды) или с помощью параметраuse_proxy. - Перенаправления HTTP могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов верна.
Примеры
- 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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}] |
| error словарь | ошибка | Информация об ошибке, возвращённая APIC Пример: {'text': 'unknown managed object class foo', 'code': '122'} |
| filter_string строка | ошибка или отладка | Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only |
| method строка | ошибка или отладка | HTTP-метод, используемый для запроса к APIC Пример: POST |
| previous список | информация | Исходная конфигурация из APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная', 'nameAlias': '', 'ownerTag': ''}}}] |
| proposed словарь | информация | Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}} |
| raw строка | ошибка разбора | Необработанный вывод, возвращённый APIC REST API (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 байт) |
| sent список | информация | Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}} |
| status целое число | ошибка или отладка | HTTP-статус от APIC Пример: 200 |
| url строка | ошибка или отладка | HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/aci_vlan_pool_encap_block_module.html