Spec-Zone.ru › Ansible

модуль cisco.aci.aci_l3out_bgp_protocol_profile — управление профилем протокола BGP (bgp:ProtP)

Примечание

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

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

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

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

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

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

  • Управление профилем протокола BGP для профилей логических узлов в фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

bgp_best_path_policy

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

string

Имя политики управления выбором наилучшего пути BGP.

bgp_timers_policy

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

string

Имя существующей политики таймеров BGP.

certificate_name

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

string

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

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

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

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

host

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

string

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

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

l3out

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

string

Имя существующего L3Out.

name_alias

string

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

node_profile

псевдонимы: node_profile_name, logical_node

string

Имя существующего профиля логического узла.

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

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

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

port

integer

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

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

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

private_key

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

string

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

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

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

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

state

string

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

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

Возможные значения:

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

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

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

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

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

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

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

Возможные значения:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

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

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

Возможные значения:

  • false
  • true

tenant

псевдонимы: 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

псевдоним: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Возможные значения:

  • false
  • true

Примечания

Примечание

  • Перед использованием этого модуля в плейбуке должны существовать tenant, l3out и node_profile. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_l3out и cisco.aci.aci_l3out_logical_node_profile.
  • Если используются bgp_timers_policy и/или bgp_best_path_policy, перед использованием этого модуля в плейбуке они должны существовать. Для этого можно использовать модули cisco.aci.aci_bgp_timers_policy и cisco.aci.aci_bgp_best_path_policy.

См. также

См. также

cisco.aci.aci_tenant

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

cisco.aci.aci_l3out

Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).

cisco.aci.aci_l3out_logical_node_profile

Управление профилями логических узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).

cisco.aci.aci_bgp_timers_policy

Управление политикой таймеров BGP (bgp:CtxPol).

cisco.aci.aci_bgp_best_path_policy

Управление политикой выбора наилучшего пути BGP (bgp:BestPathCtrlPol).

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

Дополнительные сведения о внутреннем классе APIC bgp:ProtP.

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

Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a l3out BGP protocol profile
  cisco.aci.l3out_bgp_protocol_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    node_profile: prod_node_profile
    bgp_timers_policy: prod_bgp_timers_policy
    bgp_best_path_policy: prod_bgp_best_path_policy
    state: present
  delegate_to: localhost

- name: Delete a l3out BGP protocol profile
  cisco.aci.l3out_bgp_protocol_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    node_profile: prod_node_profile
    state: absent
  delegate_to: localhost

- name: Query all l3out BGP protocol profiles
  cisco.aci.l3out_bgp_protocol_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific l3out BGP protocol profile
  cisco.aci.l3out_bgp_protocol_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    node_profile: prod_node_profile
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

current

list / elements=string

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

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

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

error

dictionary

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

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

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

filter_string

string

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

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

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

method

string

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

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

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

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

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

proposed

dictionary

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

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

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

raw

string

Исходные данные, возвращенные REST API APIC (xml или json)

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

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

response

string

Ответ HTTP от APIC

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

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

sent

list / elements=string

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

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

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

status

integer

Статус HTTP от APIC

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

Пример: 200

url

string

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

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

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

Авторы

  • Gaspard Micol (@gmicol)

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

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

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

Spec-Zone.ru

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