cisco.aci.aci_bd – Управление объектами Bridge Domains (BD) (fv:BD)

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

Для использования в playbook, укажите: cisco.aci.aci_bd.

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

Обзор

Управление Bridge Domains (BD) на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
arp_flooding логическое	Варианты: нет да	Определяет, должен ли домен моста раздавать трафик ARP. APIC по умолчанию устанавливает значение `no`, если оно не задано при создании.
bd строка		Имя домена моста. псевдонимы: bd_name, name
bd_type строка	Варианты: ethernet fc	Тип трафика в домене моста. APIC по умолчанию устанавливает значение `ethernet`, если оно не задано при создании.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был указан файл с именем `private_key`, он по умолчанию устанавливает значение базового имени `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию устанавливается значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание домена моста.
enable_multicast логическое	Варианты: нет да	Определяет, включен ли PIM. APIC по умолчанию устанавливает значение `no`, если оно не задано при создании.
enable_routing логическое	Варианты: нет да	Определяет, разрешено ли IP-перенаправление. APIC по умолчанию устанавливает значение `yes`, если оно не задано при создании.
endpoint_clear логическое	Варианты: нет да	Очищает все конечные точки на всех листьях, когда `yes`. Значение не сбрасывается в выключенное состояние после очистки конечных точек; для этого требуется вторая задача. APIC по умолчанию устанавливает значение `no`, если оно не задано при создании.
endpoint_move_detect строка	Варианты: default garp	Определяет, должен ли быть включен GARP для обнаружения перемещения конечных точек. APIC по умолчанию устанавливает значение `garp`, если оно не задано при создании.
endpoint_retention_action строка	Варианты: inherit resolve	Определяет, должен ли домен моста наследовать или разрешить политику сохранения конечных точек. APIC по умолчанию устанавливает значение `resolve`, если оно не задано при создании.
endpoint_retention_policy строка		Имя политики сохранения конечных точек, которую должен использовать домен моста при переопределении политики сохранения конечных точек по умолчанию.
host строка / обязательно		IP-адрес или имя хоста, разрешаемого управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
igmp_snoop_policy строка		Имя политики IGMP Snooping, которую должен использовать домен моста при переопределении политики IGMP Snooping по умолчанию.
ip_learning логическое	Варианты: нет да	Определяет, должен ли домен моста определять IP-адреса конечных точек. APIC по умолчанию устанавливает значение `yes`, если оно не задано при создании.
ipv6_nd_policy строка		Имя политики IPv6 Neighbor Discovery, которую должен использовать домен моста при переопределении политики IPv6 ND по умолчанию.
l2_unknown_unicast строка	Варианты: прокси поток	Определяет метод перенаправления для неизвестных l2-назначений. APIC по умолчанию устанавливает значение `proxy`, если оно не задано при создании.
l3_unknown_multicast строка	Варианты: поток опциональный поток	Определяет метод перенаправления для неизвестных мультикаст-назначений. APIC по умолчанию устанавливает значение `flood`, если оно не задано при создании.
limit_ip_learn логическое	Варианты: нет да	Определяет, должен ли BD ограничивать изучение IP только для подсетей, принадлежащих домену моста. APIC по умолчанию устанавливает значение `yes`, если оно не задано при создании.
mac_address строка		MAC-адрес для назначения `bd` вместо использования значения по умолчанию. APIC по умолчанию устанавливает значение `00:22:BD:F8:19:FF`, если оно не задано при создании. псевдонимы: mac
multi_dest строка	Варианты: bd-поток отклонить encap-поток	Определяет метод перенаправления для L2 мультикаст, широковещательного и трафика уровня каналов. APIC по умолчанию устанавливает значение `bd-flood`, если оно не задано при создании.
name_alias строка		Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
output_level строка	Варианты: отладка информация нормально ←	Влияет на вывод данного модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_LEVEL`.
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`.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
state строка	Варианты: absent present ← запрос	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant строка		Имя арендатора. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.

use_proxy boolean	Choices: no да ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`.
use_ssl boolean	Choices: no да ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`.
username string	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs boolean	Choices: no да ←	Если `no`, сертификаты SSL не будут проверены. Это следует задать как `no` только при работе с сайтами, управляемыми самостоятельно, использующими самозаверенные сертификаты. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`.
vrf string		Имя VRF. псевдонимы: vrf_name

Примечания

Примечание

Переменная tenant должна быть определена до использования этого модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC fv:BD.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- name: Add Bridge Domain
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: no
    tenant: prod
    bd: web_servers
    mac_address: 00:22:BD:F8:19:FE
    vrf: prod_vrf
    state: present
  delegate_to: localhost

- name: Add an FC Bridge Domain
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: no
    tenant: prod
    bd: storage
    bd_type: fc
    vrf: fc_vrf
    enable_routing: no
    state: present
  delegate_to: localhost

- name: Modify a Bridge Domain
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    tenant: prod
    bd: web_servers
    arp_flooding: yes
    l2_unknown_unicast: flood
    state: present
  delegate_to: localhost

- name: Query All Bridge Domains
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a Bridge Domain
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    tenant: prod
    bd: web_servers
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Bridge Domain
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    tenant: prod
    bd: web_servers
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Jacob McGill (@jmcgill298)

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