cisco.aci.aci_bd – Управление объектами Bridge Domains (BD) (fv:BD)
Примечание
Этот плагин входит в коллекцию cisco.aci (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в плейбуке укажите: cisco.aci.aci_bd.
Краткое описание
- Управление Bridge Domains (BD) на тканях Cisco ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| annotation строка | Пользовательская строка для аннотирования объекта. Если значение не указано в задании, будет использовано значение переменной окружения ACI_ANNOTATION. | |
| arp_flooding логический |
| Определяет, будет ли домен моста раздавать трафик ARP. APIC по умолчанию использует no, если значение не установлено при создании. |
| bd строка | Имя домена моста. псевдонимы: bd_name, имя | |
| bd_type строка |
| Тип трафика в домене моста. 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 строка |
| Определяет, включен ли GARP для обнаружения перемещения конечных точек. APIC по умолчанию использует garp при создании, если значение не указано. |
| endpoint_retention_action строка |
| Определяет, должен ли домен моста унаследовать или разрешить политику сохранения конечной точки. 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 строка |
| Определяет метод переадресации для 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 строка |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| tenant строка | Имя арендатора. псевдонимы: tenant_name | |
| timeout целое число | По умолчанию: 30 | Таймаут уровня сокета в секундах. Если значение не указано в задании, будет использовано значение переменной окружения ACI_TIMEOUT. |
| use_proxy boolean |
| Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_PROXY. |
| use_ssl boolean |
| Если no, вместо стандартного HTTPS соединения будет использовано HTTP соединение.Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_SSL. |
| username string | По умолчанию: "admin" | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME. Псевдонимы: user |
| validate_certs boolean |
| Если 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-url, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Авторы
- Jacob McGill (@jmcgill298)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_bd_module.html