Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_bd — управление объектами Bridge Domain (BD) (fv:BD)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_bd.

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

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

  • Управляет доменами Bridge Domain (BD) в сетях Cisco ACI.

Параметры

Параметр

Комментарии

allow_intersite_bum_traffic

псевдонимы: allow_bum_traffic

логическое значение

Управляет разрешением трафика BUM между сайтами.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

allow_intersite_l2_stretch

псевдонимы: allow_l2_stretch

логическое значение

Разрешает растяжение L2 между сайтами.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

allow_ipv6_multicast

псевдонимы: ipv6_multicast, ipv6_mcast, allow_ipv6_mcast

логическое значение

Флаг, указывающий, включена ли многоадресная передача IPv6.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

annotation

строка

Строка, заданная пользователем для добавления аннотации к объекту.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_ANNOTATION.

Если значение не указано в задаче и переменная окружения ACI_ANNOTATION, будет использоваться значение по умолчанию.

По умолчанию: "orchestrator:ansible"

arp_flooding

логическое значение

Определяет, должен ли мостовой домен рассылать ARP-трафик широковещательно.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

bd

псевдонимы: bd_name, name

строка

Имя мостового домена.

bd_type

строка

Тип трафика в мостовом домене.

Если при создании параметр не задан, APIC использует значение ethernet.

Варианты:

  • "ethernet"
  • "fc"

certificate_name

псевдонимы: cert_name

строка

Имя сертификата X.509, привязанного к пользователю APIC AAA и используемого для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется имя файла private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_CERTIFICATE_NAME.

description

строка

Описание мостового домена.

enable_multicast

логическое значение

Определяет, включен ли PIM.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

enable_rogue_except_mac

логическое значение

Поддержка подстановочных знаков MAC-адресов для исключений из проверки на несанкционированную активность в мостовых доменах.

Доступно только в APIC версии 6.0 или более поздней.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

enable_routing

логическое значение

Определяет, следует ли разрешить IP-переадресацию.

Если при создании параметр не задан, APIC использует значение true.

Варианты:

  • false
  • true

endpoint_clear

логическое значение

Очищает все конечные точки на всех Leaf, если true.

После очистки конечных точек значение не сбрасывается на «отключено»; для этого требуется выполнить вторую задачу.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

endpoint_move_detect

строка

Определяет, следует ли включить GARP для обнаружения перемещения конечных точек.

Варианты:

  • "default"
  • "garp"

endpoint_retention_action

строка

Определяет, должен ли мостовой домен наследовать политику удержания конечных точек или использовать ее разрешенное значение.

Если при создании параметр не задан, APIC использует значение resolve.

Варианты:

  • "inherit"
  • "resolve"

endpoint_retention_policy

строка

Имя политики удержания конечных точек, которую должен использовать мостовой домен при переопределении политики удержания конечных точек по умолчанию.

first_hop_security_policy

псевдонимы: fhsp, fhs_pol, fhsp_name

строка

Имя политики безопасности первого перехода, применяемой к мостовому домену.

Чтобы удалить этот атрибут, передайте пустую строку.

host

псевдонимы: hostname

строка

IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_HOST.

host_based_routing

псевдонимы: advertise_host_routes

логическое значение

Включает анонсирование маршрутов узлов (префиксов /32) через L3OUT, связанные с этим BD.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

igmp_policy

псевдонимы: igmp

строка

Имя политики интерфейса IGMP, которую должен использовать мостовой домен при переопределении политики интерфейса IGMP по умолчанию.

Чтобы удалить этот атрибут, передайте пустую строку.

igmp_snoop_policy

строка

Имя политики отслеживания IGMP, которую должен использовать мостовой домен при переопределении политики отслеживания IGMP по умолчанию.

ip_learning

логическое значение

Определяет, должен ли мостовой домен обучаться IP-адресам конечных точек.

Если при создании параметр не задан, APIC использует значение true.

Варианты:

  • false
  • true

ipv6_l3_unknown_multicast

строка

Определяет метод переадресации для неизвестных адресатов многоадресной передачи IPv6.

Если при создании параметр не задан, APIC использует значение flood.

Варианты:

  • "flood"
  • "opt-flood"

ipv6_nd_policy

строка

Имя политики обнаружения соседей IPv6, которую должен использовать мостовой домен при переопределении политики IPv6 ND по умолчанию.

l2_unknown_unicast

строка

Определяет метод переадресации для неизвестных адресатов L2.

Если при создании параметр не задан, APIC использует значение proxy.

Варианты:

  • "proxy"
  • "flood"

l3_unknown_multicast

строка

Определяет метод переадресации для неизвестных адресатов многоадресной передачи.

Если при создании параметр не задан, APIC использует значение flood.

Варианты:

  • "flood"
  • "opt-flood"

limit_ip_learn

логическое значение

Определяет, должен ли BD ограничивать обучение IP-адресов только подсетями, принадлежащими мостовому домену.

Если при создании параметр не задан, APIC использует значение true.

Варианты:

  • false
  • true

link_local_address

псевдонимы: ll_addr_ipv6, ll_addr, link_local

строка

Переопределение автоматически созданного системой локального адреса IPv6.

mac_address

псевдонимы: mac

строка

MAC-адрес, назначаемый bd вместо использования значения по умолчанию.

Если при создании параметр не задан, APIC использует значение 00:22:BD:F8:19:FF.

mld_snoop_policy

псевдонимы: mld_snoop, mld_policy

строка

Имя политики отслеживания Multicast Listener Discovery (MLD), которую должен использовать мостовой домен при переопределении политики отслеживания MLD по умолчанию.

Чтобы удалить этот атрибут, передайте пустую строку.

monitoring_policy

псевдонимы: mon_pol, monitoring_pol

строка

Имя политики мониторинга, применяемой к мостовому домену.

Чтобы удалить этот атрибут, передайте пустую строку.

multi_dest

строка

Определяет метод переадресации для многоадресного и широковещательного трафика L2, а также трафика канального уровня.

Если при создании параметр не задан, APIC использует значение bd-flood.

Варианты:

  • "bd-flood"
  • "drop"
  • "encap-flood"

multicast_arp_drop

псевдонимы: mcast_arp_drop

логическое значение

Включает отбрасывание многоадресных ARP-пакетов, признанных несанкционированными для BD.

Доступно только в APIC версии 6.0 или более поздней.

Если при создании параметр не задан, APIC использует значение true.

Варианты:

  • false
  • true

name_alias

строка

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

optimize_wan_bandwidth

псевдонимы: wan_optimization, opt_bandwidth

логическое значение

Оптимизация пропускной способности WAN улучшает работу сетевых приложений в филиале и позволяет эффективнее использовать ограниченные сетевые ресурсы.

Если при создании параметр не задан, APIC использует значение false.

Варианты:

  • false
  • true

output_level

строка

Определяет состав выходных данных этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая сведения filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

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.

pim_destination_filter

псевдонимы: pim_dest, pim_destination

строка

Имя фильтра адресатов PIM, применяемого к мостовому домену.

Чтобы удалить этот атрибут, передайте пустую строку.

Доступно только в APIC версии 5.2 или более поздней.

pim_source_filter

псевдонимы: pim_source

строка

Имя фильтра источников PIM, применяемого к мостовому домену.

Чтобы удалить этот атрибут, передайте пустую строку.

Доступно только в APIC версии 5.2 или более поздней.

port

целое число

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_PORT.

private_key

псевдонимы: cert_key

строка

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на значение certificate_name, используемое по умолчанию.

Этот параметр нельзя использовать вместе с password. Если также задан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

route_profile

string

Профиль маршрутизации, который нужно связать с доменом моста.

route_profile_l3out

string

L3 Out, содержащий связанный профиль маршрутизации.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для вывода одного или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если true, перед отправкой POST-запроса для обновления APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате предыдущее возвращаемое значение будет пустым.

Предыдущее состояние объекта не будет проверяться, а POST-запрос для обновления будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки POST-запроса для обновления APIC не будет отправлен GET-запрос для проверки.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено равным предложенному значению.

Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

  • false
  • true

tenant

aliases: tenant_name

string

Имя арендатора.

timeout

integer

Тайм-аут на уровне сокета в секундах.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_TIMEOUT.

Значение по умолчанию — 30.

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_USE_PROXY.

Значение по умолчанию — true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, вместо HTTPS-соединения, используемого по умолчанию, будет использоваться HTTP-соединение.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_USE_SSL.

При локальном подключении значение по умолчанию — true.

Варианты:

  • false
  • true

username

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использованы значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию — admin.

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

Устанавливайте значение false только на контролируемых вами ресурсах, использующих самоподписанные сертификаты.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию — true.

Варианты:

  • false
  • true

vlan

aliases: encap

string

Выбранный VLAN для инкапсуляции порта доступа домена моста.

Чтобы удалить этот атрибут, передайте пустую строку.

vmac

string

Виртуальный MAC-адрес BD/SVI. Используется, если домен моста расширен на несколько сайтов с помощью L2 Outside.

vrf

aliases: vrf_name

string

Имя VRF.

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_tenant

Управление арендаторами (fv:Tenant).

Справочник модели управления информацией APIC

Дополнительные сведения о внутреннем классе 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: false
    tenant: prod
    bd: web_servers
    mac_address: 00:22:BD:F8:19:FE
    vrf: prod_vrf
    host_based_routing: true
    allow_intersite_bum_traffic: true
    allow_intersite_l2_stretch: true
    allow_ipv6_mcast: true
    ll_addr: "fe80::1322:33ff:fe44:5566"
    vmac: "00:AA:BB:CC:DD:03"
    optimize_wan_bandwidth: true
    vlan: vlan-101
    igmp_policy: web_servers_igmp_pol
    monitoring_policy: web_servers_monitoring_pol
    igmp_snoop_policy: web_servers_igmp_snoop
    mld_snoop_policy: web_servers_mld_snoop
    first_hop_security_policy: web_servers_fhs
    state: present
  delegate_to: localhost

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

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

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

- name: Query All Bridge Domains
  cisco.aci.aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    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: true
    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: true
    tenant: prod
    bd: web_servers
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращенные APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до запуска модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, предоставленных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанные данные, возвращенные REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Jacob McGill (@jmcgill298)
  • Samita Bhattacharjee (@samitab)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API