Модуль cisco.aci.aci_l3out_bgp_peer – Управление внешними BGP-узлами L3 (L3Out) (bgp:PeerP и bgp:InfraPeerP)

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Управление типами адресов Варианты: `"af-ucast"` `"af-mcast"`
admin_state string	Административное состояние сессии BGP Варианты: `"enabled"` `"disabled"`
allow_self_as_count integer	Количество разрешенных собственных AS. Используется только если `allow-self-as` включен в `bgp_controls`.
annotation string	Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
bgp_controls list / elements=string	Управление BGP Варианты: `"send-com"` `"send-ext-com"` `"allow-self-as"` `"as-override"` `"dis-peer-as-check"` `"nh-self"` `"send-domain-path"`
bgp_infra_peer aliases: infra boolean	BGP Infra-пир (bgp:InfraPeerP). Варианты: `false` `true`
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, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, это значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description aliases: descr string	Описание BGP-пира.
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
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 по умолчанию устанавливает `none`, если значение не задано при создании. Варианты: `"dual-as"` `"no-prepend"` `"none"` `"replace-as"`
node_id string	Узел для построения интерфейса для каналов портов и отдельных портов. Пара узлов, разделенных дефисом (например, «201-202») для vPC.
node_profile aliases: node_profile_name, logical_node string	Имя профиля узла.

output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password string	Пароль, используемый для аутентификации. Эта опция является взаимоисключающей с `private_key`. Если также предоставлен `private_key`, он будет использоваться вместо этого. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
path_ep string	Путь к интерфейсу Имя группы портов интерфейса для каналов портов и vPC Номер порта для отдельных портов (например, «eth1/12»)
peer_controls list / elements=string	Управление пирами Варианты: `"bfd"` `"dis-conn-check"`
peer_ip string	IP-адрес BGP-пира.
peer_type string	Тип BGP-пира. Варианты: `"sr_mpls"`
pod_id string	Под для построения интерфейса.
port integer	Номер порта, используемый для соединения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_asn_controls list / elements=string	Управление частными AS Варианты: `"remove-exclusive"` `"remove-all"` `"replace-as"`
private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Эта опция является взаимоисключающей с `password`. Если также предоставлен `password`, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
remote_asn integer	Номер автономной системы BGP-пира.
route_control_profiles list / elements=dictionary	Список словарей объектов, который используется для привязки профиля подключения BGP Peer к профилю управления маршрутами.
direction string / required	Имя направления профиля управления маршрутами.
l3out string	Имя L3 Out.
profile string / required	Имя профиля управления маршрутами.
tenant string / required	Имя арендатора.
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`, GET-запрос для проверки не будет отправлен после обновления POST на APIC. Если значение не указано в задании, будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приведет к тому, что текущее возвращаемое значение будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
tenant aliases: tenant_name string	Имя существующего арендатора.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задании, будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
transport_data_plane string	Тип транспорта плоскости данных. Варианты: `"mpls"` `"sr_mpls"`
ttl integer	eBGP Multihop Time To Live
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`
weight integer	Вес маршрутов BGP от этого соседа

См. также

aci_l3out: Официальная документация по модулю aci_l3out.
aci_l3out_logical_node_profile: Официальная документация по модулю aci_l3out_logical_node_profile.
APIC Management Information Model reference: Дополнительная информация о внутренних классах 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 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 или debug Пример: `"?rsp-prop-include=config-only"`
method string	HTTP-метод, используемый для запроса к APIC Возвращается: failure или 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 или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	HTTP-статус от APIC Возвращается: failure или debug Пример: `200`
url string	HTTP-url, используемый для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Tim Cragg (@timcragg)
Akini Ross (@akinross)

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

© 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_l3out_bgp_peer_module.html