Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_pim_route_map_policy — Управление политикой маршрутизации PIM (Protocol-Independent Multicast) для ACI (pim:RouteMapPol)

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

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

Описание политики PIM Route Map.

host

aliases: hostname

string

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

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

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая current dict

info добавляет информационный вывод, включая previous, proposed и sent dicts

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.

pim_route_map_policy

aliases: route_map_policy_name, name

string

Имя политики PIM Route Map.

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 для отображения одного объекта или нескольких объектов.

Choices:

  • "absent"
  • "present" ← (default)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Choices:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после обновления POST в APIC не будет отправлен проверяющий GET.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения 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, вместо стандартного HTTPS соединения будет использоваться HTTP-соединение.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения 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 Management Information Model reference

Дополнительная информация о внутренней внутренней API-классе pim:RouteMapPol.

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

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

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

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

Примеры

- name: Add a new PIM Route Map policy
  cisco.aci.aci_pim_route_map_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    pim_route_map_policy: my_pim_route_map_policy
    state: present
  delegate_to: localhost

- name: Query a PIM Route Map policy
  cisco.aci.aci_pim_route_map_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    pim_route_map_policy: my_pim_route_map_policy
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all PIM Route Map policies in my_tenant
  cisco.aci.aci_pim_route_map_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a PIM Route Map policy
  cisco.aci.aci_pim_route_map_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    pim_route_map_policy: my_pim_route_map_policy
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ

Описание

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

строка

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

строка

HTTP-ответ от APIC

Возвращается при: ошибке или отладке

Пример: "OK (30 bytes)"

sent

список / элементы=строка

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается при: информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

целое число

HTTP-статус от APIC

Возвращается при: ошибке или отладке

Пример: 200

url

строка

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

Spec-Zone.ru

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