модуль cisco.aci.aci_interface_policy_pim — Управление политиками интерфейсов Protocol-Independent Multicast (PIM) (pim:IfPol)

annotation

строка

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

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

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

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

authentication_key

псевдонимы: auth_key

строка

Ключ аутентификации.

authentication_type

псевдонимы: auth_type

строка

Тип аутентификации.

Варианты:

• "none"
• "md5_hmac"

certificate_name

псевдонимы: cert_name

строка

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

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

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

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

control_state

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

Состояние элементов управления политики интерфейса PIM.

Список может содержать один или несколько следующих элементов управления:

multicast_domain_boundary — граница домена многоадресной рассылки.

strict_rfc_compliant — прослушивать только пакеты протокола PIM.

passive — не отправлять и не принимать пакеты протокола PIM.

Варианты:

• "multicast_domain_boundary"
• "strict_rfc_compliant"
• "passive"

description

псевдонимы: descr

строка

Описание политики интерфейса PIM.

designated_router_delay

псевдонимы: delay

целое число

Задержка назначенного маршрутизатора PIM.

Допустимые значения находятся в диапазоне от 1 до 65535.

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

designated_router_priority

псевдонимы: prio

целое число

Приоритет назначенного маршрутизатора PIM.

Допустимые значения находятся в диапазоне от 1 до 4294967295.

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

hello_interval

целое число

Интервал в секундах между пакетами hello, которые PIM отправляет через интерфейс.

Чем меньше интервал hello, тем быстрее обнаруживаются изменения топологии, но при этом увеличивается объём маршрутизирующего трафика.

Допустимые значения находятся в диапазоне от 1 до 18724286.

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

host

псевдонимы: hostname

строка

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

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

inbound_join_prune_filter_policy

псевдонимы: inbound_filter

строка

Политика фильтрации входящих сообщений join/prune на уровне интерфейса.

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Чтобы удалить политику, передайте пустую строку.

join_prune_interval

псевдонимы: jp_interval

целое число

Интервал join/prune в секундах.

Допустимые значения находятся в диапазоне от 60 до 65520.

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

name_alias

строка

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

neighbor_filter_policy

псевдонимы: neighbor_filter

строка

Политика фильтрации соседей на уровне интерфейса.

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Чтобы удалить политику, передайте пустую строку.

outbound_join_prune_filter_policy

псевдонимы: outbound_filter

строка

Политика фильтрации исходящих сообщений join/prune на уровне интерфейса.

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Чтобы удалить политику, передайте пустую строку.

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.

pim

псевдонимы: pim_interface_policy, name

строка

Имя политики интерфейса PIM.

После создания объекта изменить его имя нельзя.

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

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"