Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, то будет использовано значение по умолчанию.

Default: "orchestrator:ansible"

bgp_best_path_policy

aliases: bgp_best_path_policy_name

string

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

bgp_timers_policy

aliases: bgp_timers_policy_name

string

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

certificate_name

aliases: cert_name

string

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

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

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

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

host

aliases: hostname

string

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

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

l3out

aliases: l3out_name

string

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

name_alias

string

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

node_profile

aliases: 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.

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

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

aliases: 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

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.

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

Примечания

Примечание

  • 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 Management Information Model reference

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

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

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

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

Текущая конфигурация с 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

строка

Необработанный вывод из 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

строка

HTTP-ответ от APIC

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

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

sent

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

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

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

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

status

целое число

HTTP-код состояния от APIC

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

Пример: 200

url

строка

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

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

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

Авторы

  • Gaspard Micol (@gmicol)

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

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

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

Spec-Zone.ru

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