Модуль cisco.aci.aci_bgp_peer_prefix_policy – Управление политикой префиксов BGP-пейров (bgp:PeerPfxPol)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
действие строка	Действие, которое должно быть выполнено при достижении максимального предела префиксов. APIC по умолчанию использует `reject`, если это значение не задано при создании. Варианты: `"log"` `"reject"` `"restart"` `"shut"`
комментарий строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задании, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задании и переменная среды `ACI_ANNOTATION` не задана, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
имя_сертификата алиасы: имя_серт строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задании, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
описание алиасы: опис строка	Описание политики префиксов BGP-пейра.
хост алиасы: имя_хоста строка	IP-адрес или имя хоста APIC, разрешаемые хостом Ansible. Если значение не указано в задании, будет использовано значение переменной среды `ACI_HOST`.
максимальное_количество_префиксов алиасы: max_pref, max_num_pref целое	Максимальное количество префиксов, разрешенных от пейра. APIC по умолчанию использует `20000` при отсутствии значения при создании.
алиас_имени строка	Псевдоним для текущего объекта. Связано с полем nameAlias в ACI.
уровень_вывода строка	Влияет на вывод этого модуля ACI. `normal` — стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задании, будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
путь_вывода строка	Путь к файлу, который будет использован для вывода объектов конфигурации ACI в формате JSON, сгенерированных модулем. Если значение не указано в задании, будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
ключ_владельца строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задании, будет использовано значение переменной среды `ACI_OWNER_KEY`.
метка_владельца строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет метку, позволяющую клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задании, будет использовано значение переменной среды `ACI_OWNER_TAG`.
пароль строка	Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если указано `private_key`, оно будет использовано вместо этого. Если значение не указано в задании, будет использовано значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
имя_политики_префиксов_пейра алиасы: имя_политики_префикса_пейра, имя строка	Имя политики префиксов BGP-пейра.
порт целое	Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задании, будет использовано значение переменной среды `ACI_PORT`.
приватный_ключ алиасы: ключ_серт строка	Файл приватного ключа в формате PEM или содержимое приватного ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если указано `password`, оно будет проигнорировано. Если значение не указано в задании, будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.

restart_time string	Период времени в минутах до перезапуска псевдонима при достижении предела префиксов. Используется только если `action` установлено в значение `restart`. APIC по умолчанию устанавливает значение `infinite` при отсутствии указания при создании.
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	Имя существующего арендатора.
threshold aliases: thresh integer	Процентный порог от максимального числа префиксов, при достижении которого выдается предупреждение. Например, если максимальное количество префиксов равно 10, а порог составляет 70%, предупреждение выдается, когда количество префиксов превышает 7 (70%). APIC по умолчанию устанавливает значение `75` при отсутствии указания при создании.
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:PeerPfxPol.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_policy
    action: restart
    restart_time: 10
    max_prefix: 10000
    threshold: 80
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete a BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_policy
    tenant: production
    state: absent
  delegate_to: localhost

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

- name: Query a specific BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_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 строка	Необработанный вывод, возвращённый 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-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_peer_prefix_policy_module.html