Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

bgp_timers_policy

aliases: bgp_timers_policy_name, name

string

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

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.

graceful_restart_controls

string

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

Параметр помощника плавного перезапуска настраивает локальный маршрутизатор BGP для поддержки плавного перезапуска удаленного узла BGP.

Параметр полного плавного перезапуска позволяет включить или отключить плавный перезапуск BGP для отдельного соседа.

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

Варианты:

  • "helper"
  • "complete"

hold_interval

integer

Время ожидания перед объявлением устройства-соседа нерабочим.

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

host

aliases: hostname

string

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

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

keepalive_interval

integer

Интервал времени между отправкой сообщений keepalive.

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

max_as_limit

integer

Максимальный предел AS для отбрасывания маршрутов с чрезмерным количеством AS-номеров.

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

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.

Варианты:

  • "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

aliases: cert_key

string

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

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

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

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

stale_interval

integer

Максимальное время, в течение которого BGP хранит устаревшие маршруты от перезапускающегося BGP-пира.

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

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

См. также

См. также

cisco.aci.aci_tenant

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

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a BGP timers policy
  cisco.aci.aci_bgp_timers_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_timers_policy: my_bgp_timers_policy
    graceful_restart_controls: complete
    hold_interval: 360
    keepalive_interval: 120
    max_as_limit: 1
    stale_interval: 600
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete a BGP timers policy
  cisco.aci.aci_bgp_timers_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_timers_policy: my_bgp_timers_policy
    tenant: production
    state: absent
  delegate_to: localhost

- name: Query all BGP timers policies
  cisco.aci.aci_bgp_timers_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific BGP timers policy
  cisco.aci.aci_bgp_timers_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_timers_policy: my_bgp_timers_policy
    tenant: production
    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

строка

Необработанный вывод, возвращённый APIC REST API (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-URL, используемый для запроса к APIC

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

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

Авторы

  • Гaspard 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_timers_policy_module.html

Spec-Zone.ru

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