Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_bgp_address_family_context_policy — Управление политикой контекста семейства адресов BGP (bgp:CtxAfPol)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_bgp_address_family_context_policy.

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

Обзор

  • Управление политиками контекста семейства адресов BGP для теней на Cisco ACI fabric.

Параметры

Параметр

Комментарии

address_family_context_policy

aliases: address_family_context_name, name

string

Имя политики контекста семейства адресов BGP.

annotation

string

Определяемая пользователем строка для аннотации объекта.

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

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

Default: "orchestrator:ansible"

bgp_add_path_capability

string

Возможность системы соседнего узла.

Чтобы удалить этот атрибут, передайте пустую строку.

Не может быть сконфигурирован для версии APIC 6.0(2h) и более ранних.

Choices:

  • "receive"
  • "send"
  • ""

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.

ebgp_distance

integer

Административное расстояние маршрутов eBGP.

APIC использует значение по умолчанию 20 при отсутствии значения во время создания.

ebgp_max_ecmp

integer

Максимальный путь eBGP.

APIC использует значение по умолчанию 16 при отсутствии значения во время создания.

host

aliases: hostname

string

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

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

host_route_leak

boolean

Состояние управления.

Параметр для включения/отключения утечки маршрутов хоста.

APIC использует значение по умолчанию false при отсутствии значения во время создания.

Choices:

  • false
  • true

ibgp_distance

integer

Административное расстояние маршрутов iBGP.

APIC использует значение по умолчанию 200 при отсутствии значения во время создания.

ibgp_max_ecmp

integer

Максимальный путь iBGP.

APIC использует значение по умолчанию 16 при отсутствии значения во время создания.

local_distance

integer

Административное расстояние локальных маршрутов.

APIC использует значение по умолчанию 220 при отсутствии значения во время создания.

local_max_ecmp

integer

Максимальное количество локальных путей с одинаковой стоимостью для redist.

APIC использует значение по умолчанию 0 при отсутствии значения во время создания.

Не может быть сконфигурирован для версии APIC 4.2(7s) и более ранних.

name_alias

string

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

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 должен существовать до использования этого модуля в вашем playbook. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

См. также

cisco.aci.aci_tenant

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

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

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

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

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

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

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

Примеры

- name: Create a BGP address family context policy
  cisco.aci.aci_bgp_address_family_context_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_address_family_context_policy: my_bgp_address_family_context_policy
    host_route_leak: true
    ebgp_distance: 40
    ibgp_distance: 210
    local_distance: 215
    ebgp_max_ecmp: 32
    ibgp_max_ecmp: 32
    local_max_ecmp: 1
    bgp_add_path_capability: receive
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete BGP address family context policy's child
  cisco.aci.aci_bgp_address_family_context_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_address_family_context_policy: my_bgp_address_family_context_policy
    bgp_add_path_capability: ""
    tenant: production
    state: absent
  delegate_to: localhost

- name: Delete a BGP address family context policy
  cisco.aci.aci_bgp_address_family_context_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_address_family_context_policy: my_bgp_address_family_context_policy
    tenant: production
    state: absent
  delegate_to: localhost

- name: Query all BGP address family context policies
  cisco.aci.aci_bgp_address_family_context_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific BGP address family context policy
  cisco.aci.aci_bgp_address_family_context_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_address_family_context_policy: my_bgp_address_family_context_policy
    tenant: production
    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

Необработанный вывод, возвращаемый API REST 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

HTTP-URL, используемый для запроса к 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_bgp_address_family_context_policy_module.html

Spec-Zone.ru

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