Spec-Zone.ru › Ansible

cisco.aci.aci_bgp_route_summarization_policy модуль — Управление политикой обобщения маршрутов BGP (bgp:RtSummPol)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

address_type_af_control

aliases: address_type_control

list / elements=string

Управление типом адреса Ucast/Mcast AF.

APIC по умолчанию использует af-ucast при создании, если значение не задано.

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

Варианты:

  • "af-label-ucast"
  • "af-ucast"
  • "af-mcast"

annotation

string

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

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

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

По умолчанию: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

control_state

aliases: summary_control, control

list / elements=string

Управление суммированием.

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

Варианты:

  • "as-set"
  • "summary-only"

description

aliases: descr

string

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

host

aliases: hostname

string

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

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

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.

route_summarization_policy

aliases: route_summarization_policy_name, name

строка

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

state

строка

Используйте present или absent для добавления или удаления.

Используйте query для перечисления объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

булево

Если true, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC.

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

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

булево

Если true, GET-запрос проверки не будет отправлен после обновления POST в APIC.

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

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

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

Варианты:

  • false
  • true

tenant

aliases: tenant_name

строка

Имя существующего арендатора.

timeout

целое число

Таймаут уровня сокета в секундах.

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

Значение по умолчанию 30.

use_proxy

булево

Если false, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.

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

Значение по умолчанию true.

Варианты:

  • false
  • true

use_ssl

булево

Если false, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

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

Значение по умолчанию true, когда соединение локальное.

Варианты:

  • false
  • true

username

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

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

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

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

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

Примеры

- name: Create a BGP route summarization policy
  cisco.aci.aci_bgp_route_summarization_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_summarization_policy: my_route_summarization_policy
    address_type_af_control: [af-mcast, af-ucast]
    control_state: [as-set, summary-only]
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete a BGP route summarization policy
  cisco.aci.aci_bgp_route_summarization_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_summarization_policy: my_route_summarization_policy
    tenant: production
    state: absent
  delegate_to: localhost

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

- name: Query a specific BGP route summarization policy
  cisco.aci.aci_bgp_route_summarization_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_summarization_policy: my_route_summarization_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"

Авторы

  • 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_route_summarization_policy_module.html

Spec-Zone.ru

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