Модуль cisco.mso.ndo_l3out_bgp_peer — управление узлом BGP L3Out в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_l3out_bgp_peer.

Добавлено в cisco.mso 2.11.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

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

Управление узлом BGP L3Out в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v3.1 (NDO v4.3) и более поздних версиях.

Требования

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

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
address_families dictionary	Параметры управления семействами адресов для BGP-пира.
multicast boolean	Флаг многоадресной передачи для семейства адресов. Варианты: `false` `true`
state string	Используйте `enabled` для настройки параметров управления адресами. Используйте `disabled` для удаления параметров управления адресами. Варианты: `"enabled"` `"disabled"`
unicast boolean	Флаг одноадресной передачи для семейства адресов. Варианты: `false` `true`
admin_state string	Административное состояние BGP-пира L3Out. При создании по умолчанию используется `enabled`, если значение не задано. Варианты: `"enabled"` `"disabled"`
allowed_self_as_count integer	Допустимое количество собственных AS для BGP-пира L3Out. При создании по умолчанию используется значение 3, если параметр не задан. Значение должно находиться в диапазоне от 1 до 10.
auth_password string	Пароль аутентификации BGP-пира L3Out.
bgp_controls dictionary	Параметры управления BGP для пира.
allow_self_as boolean	Флаг разрешения собственной AS в параметрах управления BGP. Варианты: `false` `true`
disabled_peer_as_check boolean	Флаг отключения проверки AS пира в параметрах управления BGP. Варианты: `false` `true`
next_hop_self boolean	Флаг установки следующего перехода равным собственному адресу в параметрах управления BGP. Варианты: `false` `true`
override_as boolean	Флаг переопределения AS в параметрах управления BGP. Варианты: `false` `true`
send_community boolean	Флаг отправки атрибутов community в параметрах управления BGP. Варианты: `false` `true`
send_domain_path boolean	Флаг отправки пути домена в параметрах управления BGP. Варианты: `false` `true`
send_extended_community boolean	Флаг отправки расширенных атрибутов community в параметрах управления BGP. Варианты: `false` `true`
state string	Используйте `enabled` для настройки параметров управления BGP. Используйте `disabled` для удаления параметров управления BGP. Варианты: `"enabled"` `"disabled"`
ebgp_multi_hop_ttl integer	TTL для многопереходного eBGP BGP-пира L3Out. При создании по умолчанию используется значение 1, если параметр не задан. Значение должно находиться в диапазоне от 1 до 255.
encapsulation_type псевдонимы: encap_type string	Тип инкапсуляции интерфейса. Варианты: `"vlan"` `"vxlan"`
encapsulation_value псевдонимы: encap, encapsulation, encapsulation_id integer	Значение инкапсуляции интерфейса. Параметр `encapsulation_type=vlan` задаёт идентификатор VLAN, который должен находиться в диапазоне от 1 до 4094. Параметр `encapsulation_type=vxlan` задаёт идентификатор сети VXLAN (VNI), который должен находиться в диапазоне от 5000 до 16777215.
export_route_map dictionary	Имя карты маршрутизации экспорта. Передача пустого словаря удалит `export_route_map={}` из BGP-пира L3Out. Этот параметр можно использовать вместо `export_route_map_uuid`.
name string	Имя карты маршрутизации экспорта.
template string	Шаблон, связанный с картой маршрутизации экспорта. Необходимо указать этот параметр или `export_route_map.template_id`.
template_id string	Идентификатор шаблона, связанного с картой маршрутизации экспорта. Необходимо указать этот параметр или `export_route_map.template`.
export_route_map_uuid string	UUID карты маршрутизации экспорта. Передача пустой строки удалит `export_route_map_uuid=""` из BGP-пира L3Out. Этот параметр можно использовать вместо `export_route_map`.
host псевдонимы: hostname string	IP-адрес или имя хоста Cisco ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_HOST`.
import_route_map dictionary	Имя карты маршрутизации импорта. Передача пустого словаря удалит `import_route_map={}` из BGP-пира L3Out. Этот параметр можно использовать вместо `import_route_map_uuid`.
name string	Имя карты маршрутизации импорта.
template string	Шаблон, связанный с картой маршрутизации импорта. Необходимо указать этот параметр или `import_route_map.template_id`.
template_id string	Идентификатор шаблона, связанного с картой маршрутизации импорта. Необходимо указать этот параметр или `import_route_map.template`.
import_route_map_uuid string	UUID карты маршрутизации импорта. Передача пустой строки удалит `import_route_map_uuid=""` из BGP-пира L3Out. Этот параметр можно использовать вместо `import_route_map`.
ipv4_address псевдонимы: peer_address_ipv4 string	IPv4-адрес BGP-пира L3Out. Передача пустой строки удалит `ipv4_address=""` из BGP-пира L3Out.
ipv6_address псевдонимы: peer_address_ipv6 string	IPv6-адрес BGP-пира L3Out. Передача пустой строки удалит `ipv6_address=""` из BGP-пира L3Out.
l3out string	Имя L3Out. Необходимо указать этот параметр или `l3out_uuid`.
l3out_uuid string	UUID L3Out. Необходимо указать этот параметр или `l3out`.
local_asn string	Номер локальной автономной системы (ASN) BGP-пира L3Out. Значение должно находиться в диапазоне от 1 до 4294967295. Передача пустой строки удалит `local_asn=""` из BGP-пира L3Out.
local_asn_config string	Конфигурация локального ASN BGP-пира L3Out. Варианты: `"none"` `"no_prepend"` `"dual_as"` `"replace_as"`
login_domain string	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не задан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
node_group string	Имя политики группы узлов.
node_id псевдонимы: node, border_leaf, anchor_node string	Идентификатор узла (пограничного коммутатора leaf).
output_level string	Определяет состав выходных данных этого модуля MSO. `normal` — стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и сведения `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
parent_type string	Тип родительского объекта L3Out. Варианты: `"floating_svi"` `"node_group"` ← (по умолчанию) `"routed"` `"routed_sub"` `"svi"`
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
path псевдонимы: interface string	Путь к интерфейсу. Путь должен указывать на существующий физический порт (например, eth1/1).
peer_controls dictionary	Параметры управления пиром для BGP-пира.
bfd boolean	Флаг включения обнаружения двунаправленной переадресации (BFD) в параметрах управления пиром. Варианты: `false` `true`
disable_peer_connected_check boolean	Флаг отключения проверки подключённости пира в параметрах управления пиром. Варианты: `false` `true`
state string	Используйте `enabled` для настройки параметров управления пиром. Используйте `disabled` для удаления параметров управления пиром. Варианты: `"enabled"` `"disabled"`
peer_prefix dictionary	Имя префикса пира. Передача пустого словаря удалит `peer_prefix={}` из BGP-пира L3Out. Этот параметр можно использовать вместо `peer_prefix_uuid`.
name string	Имя префикса пира.
template string	Шаблон, связанный с префиксом пира. Необходимо указать этот параметр или `peer_prefix.template_id`.
template_id string	Идентификатор шаблона, связанного с префиксом пира. Необходимо указать этот параметр или `peer_prefix.template`.
peer_prefix_uuid string	UUID префикса пира. Передача пустой строки удалит `peer_prefix_uuid=""` из BGP-пира L3Out. Этот параметр можно использовать вместо `peer_prefix`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_PORT`.
port_channel псевдонимы: pc dictionary	Сведения о агрегированном канале.

reference aliases: ref dictionary	Сведения о ссылке на порт-канал. Этот параметр или `port_channel.uuid` является обязательным.
name string / обязательный	Имя порт-канала.
template string	Имя шаблона, содержащего порт-канал. Этот параметр или `port_channel.reference.template_id` является обязательным.
template_id string	Идентификатор шаблона, содержащего порт-канал. Этот параметр или `port_channel.reference.template` является обязательным.
uuid string	UUID порт-канала. Этот параметр или `port_channel.reference` является обязательным.
private_as_controls dictionary	Параметры управления частной AS для BGP-соседа.
remove_all boolean	Флаг удаления всех частных номеров AS. Варианты: `false` `true`
replace_with_local_as boolean	Флаг замены частной AS локальной AS в настройках управления частной AS. Варианты: `false` `true`
state string	Используйте `enabled` для настройки параметров управления частной AS. Используйте `disabled` для удаления параметров управления частной AS. Варианты: `"enabled"` `"disabled"`
remote_asn string	Номер удаленной автономной системы (ASN) BGP-соседа L3Out. Значение должно находиться в диапазоне от 1 до 4294967295. Если указать пустую строку, из BGP-соседа L3Out будет удален `remote_asn=""`.
site_of_origin aliases: fabric_of_origin string	Сайт-источник для BGP-соседа L3Out. Значение должно соответствовать шаблону “extended:as2-nn2:1000:65534”.
state string	Используйте `absent` для удаления. Используйте `query` для просмотра одного или нескольких объектов. Используйте `present` для создания или обновления. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template aliases: l3out_template string	Имя шаблона L3Out. Этот параметр или `template_id` является обязательным.
template_id aliases: l3out_template_id string	Идентификатор шаблона L3Out. Этот параметр или `template` является обязательным.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_TIMEOUT`.
use_proxy boolean	Если задано `false`, прокси-сервер использоваться не будет, даже если он определен в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если задано `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_SSL`. При использовании подключаемого модуля подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаризации `ansible_httpapi_use_ssl`. По умолчанию используется `false` при использовании подключаемого модуля подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего способа подключения (только для mso). Варианты: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если задано `false`, сертификаты SSL не будут проверяться. Устанавливайте значение `false` только для сайтов под личным управлением, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`
virtual_port_channel aliases: vpc dictionary	Сведения о виртуальном порт-канале.
reference aliases: ref dictionary	Сведения о ссылке на виртуальный порт-канал. Этот параметр или `virtual_port_channel.uuid` является обязательным.
name string / обязательный	Имя виртуального порт-канала.
template string	Имя шаблона, содержащего виртуальный порт-канал. Этот параметр или `virtual_port_channel.reference.template_id` является обязательным.
template_id string	Идентификатор шаблона, содержащего виртуальный порт-канал. Этот параметр или `virtual_port_channel.reference.template` является обязательным.
uuid string	UUID виртуального порт-канала. Этот параметр или `virtual_port_channel.reference` является обязательным.
weight string	Вес BGP-соседа L3Out. Значение должно находиться в диапазоне от 1 до 65535. Если указать пустую строку, из BGP-соседа L3Out будет удален `weight=""`.

Примечания

Примечание

Перед использованием этого модуля в сценарии должен существовать template. Используйте cisco.mso.ndo_template, чтобы создать шаблон L3Out.
Перед использованием этого модуля в сценарии должен существовать l3out. Используйте cisco.mso.ndo_l3out_template, чтобы создать L3Out.
Перед использованием этого модуля в сценарии должен существовать node_group. Используйте cisco.mso.ndo_l3out_node_group_policy, чтобы создать политику группы узлов L3Out.
Перед использованием этого модуля в сценарии должен существовать peer_prefix. Используйте cisco.mso.ndo_tenant_bgp_peer_prefix_policy, чтобы создать политику префиксов BGP-соседа.
Этот модуль создан для поддержки Multi Site Orchestrator версии 2.1 и новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_l3out_template: Управление L3Out в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_l3out_node_group_policy: Управление политикой группы узлов L3Out в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_tenant_bgp_peer_prefix_policy: Управление политиками префиксов BGP-соседей в шаблонах политик арендаторов в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- name: Create an L3Out BGP Peer with minimum configuration
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    ipv6_address: "1::8/16"
    auth_password: 123
    state: present

- name: Create L3Out BGP Peer on a L3out routed interface of type port
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    ipv4_address: 5.5.5.5
    parent_type: routed
    node_id: 101
    path: eth1/1
    state: present

- name: Create a L3out routed sub-interface of type port channel
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    ipv4_address: 5.5.5.5
    parent_type: routed_sub
    port_channel:
      uuid: '{{ port_channel_interface_1.current.uuid }}'
    encapsulation_type: vlan
    encapsulation_value: 100
    state: present

- name: Create L3Out BGP Peer on a L3out svi interface of type virtual port channel
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    ipv4_address: 5.5.5.5
    parent_type: svi
    virtual_port_channel:
      uuid: '{{ virtual_port_channel_interface_1.current.uuid }}'
    encapsulation_type: vlan
    encapsulation_value: 100
    state: present

- name: Create L3Out BGP Peer on a L3out floating svi interface
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    ipv4_address: "1.1.1.1"
    parent_type: floating_svi
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 100
    state: present

- name: Update an L3Out BGP Peer with full configuration
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    ipv6_address: "1::8/16"
    remote_asn: 2
    admin_state: enabled
    import_route_map:
      name: ans_route_map
      template: ansible_test_policy
    export_route_map:
      name: ans_route_map_2
      template: ansible_test_policy
    peer_prefix:
      name: ansible_test_bgp_peer_prefix_policy
      template: ansible_test_policy
    ebgp_multi_hop_ttl: 1
    auth_password: 123
    weight: 2
    site_of_origin: "extended:as2-nn2:1000:65534"
    allowed_self_as_count: 3
    local_asn_config: replace_as
    local_asn: 1
    bgp_controls:
      allow_self_as: true
      override_as: true
      disabled_peer_as_check: true
      next_hop_self: true
      send_community: true
      send_extended_community: true
      send_domain_path: true
    peer_controls:
      bfd: true
      disable_peer_connected_check: true
    address_families:
      multicast: true
      unicast: true
    private_as_controls:
      remove_all: true
      replace_with_local_as: true
    state: present

- name: Query an L3Out BGP Peer with IPv4 and IPv6 addresses
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    ipv6_address: "1::8/16"
    state: query
  register: query_with_ipv4_and_ipv6

- name: Query an L3Out BGP Peer with IPv4
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    state: query
  register: query_with_ipv4

- name: Query an L3Out BGP Peer with IPv6
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv6_address: "1::8/16"
    state: query
  register: query_with_ipv6

- name: Query all L3Out BGP Peer
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    state: query
  register: query_all

- name: Remove an L3Out BGP Peer with IPv4 and IPv6 addresses
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    ipv6_address: "1::8/16"
    state: absent

- name: Remove an L3Out BGP Peer with IPv4
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv4_address: "1.1.1.1"
    state: absent

- name: Remove an L3Out BGP Peer with IPv6
  cisco.mso.ndo_l3out_bgp_peer:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_1
    node_group: node_group_policy_1
    ipv6_address: "1::8/16"
    state: absent

Авторы

Sabari Jaganathan (@sajagana)

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

© 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/mso/ndo_l3out_bgp_peer_module.html