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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

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

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

Обзор

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

Параметры

Параметр	Комментарии
address_family_context_policy псевдонимы: address_family_context_name, name строка	Имя политики контекста семейства адресов BGP.
annotation строка	Строка, заданная пользователем для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bgp_add_path_capability строка	Возможность соседней системы. Чтобы удалить этот атрибут, передайте пустую строку. Нельзя настроить для APIC версии 6.0(2h) и более ранних. Варианты: `"receive"` `"send"` `""`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание профиля протокола BGP.
ebgp_distance целое число	Административное расстояние маршрутов eBGP. При создании APIC присваивает значение `20`, если параметр не задан.
ebgp_max_ecmp целое число	Максимальное количество путей eBGP. При создании APIC присваивает значение `16`, если параметр не задан.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_HOST`.
host_route_leak логическое значение	Состояние управления. Параметр включения/отключения утечки маршрутов узла. При создании APIC присваивает значение `false`, если параметр не задан. Варианты: `false` `true`
ibgp_distance целое число	Административное расстояние маршрутов iBGP. При создании APIC присваивает значение `200`, если параметр не задан.
ibgp_max_ecmp целое число	Максимальное количество путей iBGP. При создании APIC присваивает значение `16`, если параметр не задан.
local_distance целое число	Административное расстояние локальных маршрутов. При создании APIC присваивает значение `220`, если параметр не задан.
local_max_ecmp целое число	Максимальное количество локальных путей с равной стоимостью для перераспределения. При создании APIC присваивает значение `0`, если параметр не задан. Нельзя настроить для APIC версии 4.2(7s) и более ранних.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Настройка вывода этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записываться объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка	Строка, заданная пользователем для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для сопоставления сущностей. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка	Строка, заданная пользователем для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, будет использоваться он. Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name`, используемое по умолчанию. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет отправляться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после отправки POST-запроса на обновление в APIC не будет отправляться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в качестве текущего возвращаемого значения будет установлено предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
tenant псевдонимы: tenant_name строка	Имя существующего арендатора.
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию — true при локальном подключении. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логическое значение	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте значение `false` только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать tenant. Для этого можно использовать модуль 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	Необработанный вывод, возвращенный 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_bgp_address_family_context_policy_module.html