Модуль cisco.aci.aci_l3out_bgp_peer — управление BGP-пирами Layer 3 Outside (L3Out) (bgp:PeerP и bgp:InfraPeerP)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_l3out_bgp_peer.
Обзор
- Управление BGP-пирами L3Out в сетях Cisco ACI.
Параметры
Параметр | Комментарии |
|---|---|
address_type_controls list / elements=string | Элементы управления типом адреса Варианты:
|
admin_state string | Состояние администрирования сеанса BGP Варианты:
|
allow_self_as_count integer | Количество разрешённых собственных AS. Используется только в том случае, если |
annotation string | Заданная пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Если значение не указано в задаче и переменной среды По умолчанию: |
bgp_controls list / elements=string | Элементы управления BGP Варианты:
|
bgp_infra_peer aliases: infra boolean | Пир инфраструктуры BGP (bgp:InfraPeerP). Варианты:
|
bgp_password string | Пароль для пира BGP. Указание пароля всегда приводит к изменению, поскольку установленный пароль нельзя получить из APIC. |
bgp_peer_prefix_policy aliases: bgp_peer_prefix_policy_name string | Политика префиксов пира BGP. Настроить политику префиксов пира BGP можно только при условии bgp_infra_peer=true. |
certificate_name aliases: cert_name string | Имя сертификата X.509, связанного с пользователем AAA APIC, используемого для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
description aliases: descr string | Описание пира BGP. |
host aliases: hostname string | IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
interface_profile aliases: interface_profile_name, logical_interface string | Имя профиля интерфейса. |
l3out aliases: l3out_name string | Имя существующего L3Out. |
local_as_number aliases: local_as_num integer | Локальный номер автономной системы (ASN) пира BGP L3Out. При создании APIC присваивает значение 0, если параметр не задан. |
local_as_number_config aliases: local_as_num_config string | Конфигурация локального номера автономной системы (ASN) пира BGP L3Out. При создании APIC присваивает значение Варианты:
|
node_id string | Узел, на котором будет создан интерфейс для каналов портов и отдельных портов. Для vPC укажите пару узлов, разделённых дефисом (например, «201-202»). |
node_profile aliases: node_profile_name, logical_node string | Имя профиля узла. |
output_level string | Управляет выводом этого модуля ACI.
Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Варианты:
|
output_path string | Путь к файлу, в который будут записываться созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
password string | Пароль для аутентификации. Этот параметр несовместим с Если значение не указано в задаче, вместо него будет использоваться значение одной из переменных среды: |
path_ep string | Путь к интерфейсу Имя группы портов интерфейса для каналов портов и vPC Номер порта для отдельных портов (например, «eth1/12») |
peer_controls list / elements=string | Элементы управления пиром Варианты:
|
peer_ip string | IP-адрес пира BGP. |
peer_type string | Тип пира BGP. Варианты:
|
pod_id string | Под, на котором будет создан интерфейс. |
port integer | Номер порта для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
private_asn_controls list / elements=string | Элементы управления частной AS Варианты:
|
private_key aliases: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр несовместим с Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
remote_asn integer | Номер автономной системы пира BGP. |
route_control_profiles list / elements=dictionary | Список словарей, используемый для привязки профиля подключения пира BGP к профилю управления маршрутами. |
|
direction string / обязательный |
Имя направления профиля управления маршрутами. |
|
l3out string |
Имя L3 Out. |
|
profile string / обязательный |
Имя профиля управления маршрутами. |
|
tenant string / обязательный |
Имя арендатора. |
state string | Для добавления или удаления используйте Для просмотра одного или нескольких объектов используйте Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ: возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта проверяться не будет, а запрос POST на обновление будет содержать все свойства. Варианты:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ: в качестве текущего возвращаемого значения будет установлено предлагаемое значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты:
|
tenant aliases: tenant_name string | Имя существующего арендатора. |
timeout integer | Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Значение по умолчанию — 30. |
transport_data_plane string | Тип плоскости передачи данных транспорта. Варианты:
|
ttl integer | Время жизни пакета для многопереходного eBGP |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использоваться значение переменной среды При локальном подключении значение по умолчанию — true. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение одной из переменных среды: Значение по умолчанию — admin. |
validate_certs boolean | Если Устанавливайте значение Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Значение по умолчанию — true. Варианты:
|
weight integer | Вес маршрутов BGP от этого соседа |
См. также
См. также
- cisco.aci.aci_l3out
-
Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).
- cisco.aci.aci_l3out_logical_node_profile
-
Управление логическими профилями узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).
- Справочник модели управляющей информации APIC
-
Дополнительная информация о внутренних классах APIC bgp:peerP и bgp:InfraPeerP
- Руководство по Cisco ACI
-
Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.
Примеры
- name: Add a new BGP peer on a physical interface
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
peer_ip: 192.168.10.2
remote_asn: 65456
bgp_controls:
- nh-self
- send-com
- send-ext-com
peer_controls:
- bfd
route_control_profiles:
- tenant: "ansible_tenant"
profile: "anstest_import"
direction: "import"
- tenant: "ansible_tenant"
profile: "anstest_export"
direction: "export"
l3out: "anstest_l3out"
state: present
delegate_to: localhost
- name: Add a new BGP peer on a vPC
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201-202
path_ep: my_vpc_ipg
peer_ip: 192.168.20.2
remote_asn: 65457
ttl: 4
weight: 50
state: present
delegate_to: localhost
- name: Create Infra BGP Peer with password
aci_l3out_bgp_peer: &infra_bgp_peer
host: apic
username: admin
password: SomeSecretPassword
tenant: infra
l3out: ansible_infra_l3out
node_profile: ansible_infra_l3out_node_profile
ttl: 2
bgp_infra_peer: true
bgp_password: ansible_test_password
peer_ip: 192.168.50.2
remote_asn: 65450
local_as_number: 65460
peer_type: sr_mpls
bgp_controls:
- send-domain-path
transport_data_plane: sr_mpls
bgp_peer_prefix_policy: ansible_peer_prefix_profile
state: present
delegate_to: localhost
- name: Shutdown a BGP peer
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
peer_ip: 192.168.10.2
admin_state: disabled
state: present
delegate_to: localhost
- name: Delete a BGP peer
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
peer_ip: 192.168.10.2
state: absent
delegate_to: localhost
- name: Add BGP Peer to the Node Profile level
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: ansible_tenant
l3out: ansible_l3out
node_profile: ansible_node_profile
peer_ip: 192.168.50.3
route_control_profiles:
- tenant: "ansible_tenant"
profile: "anstest_import"
direction: "import"
- tenant: "ansible_tenant"
profile: "anstest_export"
direction: "export"
l3out: "anstest_l3out"
state: present
delegate_to: localhost
- name: Query a BGP peer
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
peer_ip: 192.168.10.2
state: query
delegate_to: localhost
register: query_result
- name: Query all BGP peer
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_all
- name: Query all BGP infra peer
cisco.aci.aci_l3out_bgp_peer:
host: apic
username: admin
password: SomeSecretPassword
bgp_infra_peer: true
state: query
delegate_to: localhost
register: query_all
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, специфичные для этого модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Текущая конфигурация из APIC после завершения работы модуля Возвращается: при успехе Пример: |
error словарь | Сведения об ошибке, возвращенные APIC Возвращается: при сбое Пример: |
filter_string строка | Строка фильтра, использованная для запроса Возвращается: при сбое или в режиме отладки Пример: |
method строка | Метод HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: |
previous список / элементы=строка | Исходная конфигурация из APIC до запуска модуля Возвращается: сведения Пример: |
proposed словарь | Собранная конфигурация на основе параметров, предоставленных пользователем Возвращается: сведения Пример: |
raw строка | Необработанный вывод, возвращенный REST API APIC (xml или json) Возвращается: при ошибке разбора Пример: |
response строка | Ответ HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, переданная в APIC Возвращается: сведения Пример: |
status целое число | Статус HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: |
url строка | URL HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: |
Ссылки на коллекцию
© 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_l3out_bgp_peer_module.html