Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

allow_intersite_bum_traffic

aliases: allow_bum_traffic

boolean

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

allow_intersite_l2_stretch

aliases: allow_l2_stretch

boolean

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

allow_ipv6_multicast

aliases: ipv6_multicast, ipv6_mcast, allow_ipv6_mcast

boolean

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

annotation

string

Пользовательская строка для аннотации объекта.

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

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

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

arp_flooding

boolean

Определяет, должен ли Bridge Domain рассылать ARP-трафик.

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

bd

aliases: bd_name, name

string

Имя Bridge Domain.

bd_type

string

Тип трафика в Bridge Domain.

APIC по умолчанию использует ethernet при отсутствии значения во время создания.

Варианты:

  • "ethernet"
  • "fc"

certificate_name

aliases: cert_name

string

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

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

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

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

description

string

Описание Bridge Domain.

enable_multicast

boolean

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

enable_rogue_except_mac

boolean

Поддержка подстановочных знаков для исключения MAC-адресов Rogue для Bridge Domains.

Доступно только в версии APIC 6.0 и выше.

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

enable_routing

boolean

Определяет, разрешена ли переадресация IP.

APIC по умолчанию использует true при отсутствии значения во время создания.

Варианты:

  • false
  • true

endpoint_clear

boolean

Очищает все конечные точки во всех листьях, когда true.

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

endpoint_move_detect

string

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

Варианты:

  • "default"
  • "garp"

endpoint_retention_action

string

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

APIC по умолчанию использует resolve при отсутствии значения во время создания.

Варианты:

  • "inherit"
  • "resolve"

endpoint_retention_policy

string

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

first_hop_security_policy

aliases: fhsp, fhs_pol, fhsp_name

string

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

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

host

aliases: hostname

string

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

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

host_based_routing

aliases: advertise_host_routes

boolean

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

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

igmp_policy

aliases: igmp

string

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

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

igmp_snoop_policy

string

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

ip_learning

boolean

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

APIC по умолчанию использует true при отсутствии значения во время создания.

Варианты:

  • false
  • true

ipv6_l3_unknown_multicast

string

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

APIC по умолчанию использует flood при отсутствии значения во время создания.

Варианты:

  • "flood"
  • "opt-flood"

ipv6_nd_policy

string

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

l2_unknown_unicast

string

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

APIC по умолчанию использует proxy при отсутствии значения во время создания.

Варианты:

  • "proxy"
  • "flood"

l3_unknown_multicast

string

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

APIC по умолчанию использует flood при отсутствии значения во время создания.

Варианты:

  • "flood"
  • "opt-flood"

limit_ip_learn

boolean

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

APIC по умолчанию использует true при отсутствии значения во время создания.

Варианты:

  • false
  • true

link_local_address

aliases: ll_addr_ipv6, ll_addr, link_local

string

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

mac_address

aliases: mac

string

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

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

mld_snoop_policy

aliases: mld_snoop, mld_policy

string

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

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

monitoring_policy

aliases: mon_pol, monitoring_pol

string

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

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

multi_dest

string

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

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

Варианты:

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

multicast_arp_drop

aliases: mcast_arp_drop

boolean

Включить отбрасывание пакетов ARP мультикаста мостового домена.

Доступно только в версии APIC 6.0 и выше.

APIC по умолчанию использует true при отсутствии значения во время создания.

Варианты:

  • false
  • true

name_alias

string

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

optimize_wan_bandwidth

aliases: wan_optimization, opt_bandwidth

boolean

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

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

Варианты:

  • false
  • true

output_level

string

Влияет на вывод этого модуля ACI.

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

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

debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию.

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

Варианты:

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

output_path

string

Путь к файлу, который будет использоваться для вывода JSON-объектов конфигурации ACI, сгенерированных модулем.

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

owner_key

string

Пользовательская строка для атрибута ownerKey объекта ACI.

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

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

owner_tag

string

Пользовательская строка для атрибута ownerTag объекта ACI.

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

Например, чтобы указать, кто создал этот объект.

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

password

string

Пароль для аутентификации.

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

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

pim_destination_filter

aliases: pim_dest, pim_destination

string

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

Для удаления этого атрибута передайте пустую строку.

Доступно только в версии APIC 5.2 и выше.

pim_source_filter

aliases: pim_source

string

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

Для удаления этого атрибута передайте пустую строку.

Доступно только в версии APIC 5.2 и выше.

port

integer

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

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

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

private_key

aliases: cert_key

string

Файл закрытого ключа в формате 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, GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC.

Если значение не указано в задании, используется значение переменной окружения 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, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, будет использовано значение переменной окружения 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. Используется при расширении BD на несколько сайтов с использованием L2 Outside.

vrf

aliases: vrf_name

string

Имя VRF.

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_tenant

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

APIC Management Information Model reference

Дополнительная информация о внутренней классе APIC fv:BD.

Руководство по Cisco ACI

Подробная информация о управлении вашей инфраструктурой Cisco 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

список / элементы=строка

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

Возвращается: успех

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

error

словарь

Информация об ошибке, возвращённая APIC

Возвращается: ошибка

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

filter_string

строка

Строка фильтра, используемая для запроса

Возвращается: ошибка или отладка

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

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращается: ошибка или отладка

Пример: "POST"

previous

список / элементы=строка

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

Возвращается: информация

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

proposed

словарь

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

Возвращается: информация

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

raw

строка

Необработанный вывод, возвращённый API REST APIC (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 bytes)"

sent

список / элементы=строка

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

Возвращается: информация

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

status

целое число

HTTP-статус от APIC

Возвращается: ошибка или отладка

Пример: 200

url

строка

HTTP-URL, используемый для запроса к APIC

Возвращается: ошибка или отладка

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

Авторы

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

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

  • Система отслеживания задач
  • Репозиторий (источники)

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

Spec-Zone.ru

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