cisco.aci.aci_vrf_multicast module – Управление объектами многоадресной рассылки VRF (pim:CtxP)

annotation

string

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

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

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

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

any_source_multicast

aliases: asm, any_source

dictionary

Контейнер конфигурации параметров многоадресной рассылки от любого источника (ASM) протокола независимой многоадресной рассылки (PIM).

expiry

aliases: expiry_seconds

integer

Время ожидания в секундах.

Если при создании значение не задано, APIC использует значение default-timeout.

Укажите 0, чтобы сбросить значение до default-timeout.

max_rate

aliases: max_rate_per_second

integer

Максимальная частота в секунду.

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

shared_range_route_map

aliases: shared_range_policy

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

source_group_expiry_route_map

aliases: sg_expiry_route_map

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

source_ip

aliases: source, source_ip_address

string

IP-адрес источника.

auto_rp

aliases: auto

dictionary

Контейнер конфигурации параметров автоматического rendezvous point (Auto-RP) протокола независимой многоадресной рассылки (PIM).

ma_filter

aliases: filter, route_map, route_map_dn

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

rp_updates

aliases: control, ctrl

list / elements=string

Состояние управления политикой автоматического rendezvous point (Auto-RP).

Укажите [], чтобы удалить конфигурацию состояния управления.

Варианты:

• "forward"
• "listen"

bootstrap_router

aliases: bsr, bootstrap

dictionary

Контейнер конфигурации параметров маршрутизатора начальной загрузки (BSR) протокола независимой многоадресной рассылки (PIM).

bsr_filter

aliases: filter, route_map, route_map_dn

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

rp_updates

aliases: control, ctrl

list / elements=string

Состояние управления политикой маршрутизатора начальной загрузки (BSR).

Укажите [], чтобы удалить конфигурацию состояния управления.

Варианты:

• "forward"
• "listen"

certificate_name

aliases: cert_name

string

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

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

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

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

host

aliases: hostname

string

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

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

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.

pim_setting

dictionary

Контейнер конфигурации параметров протокола независимой многоадресной рассылки (PIM).

control_state

aliases: control, ctrl

list / elements=string

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

Укажите [], чтобы удалить конфигурацию состояния управления.

Варианты:

• "fast"
• "strict"

mtu

integer

Размер MTU, поддерживаемый для многоадресной рассылки.

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

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.

resource_policy

dictionary

Контейнер конфигурации политики ресурсов протокола независимой многоадресной рассылки (PIM).

maximum_limit

aliases: max

integer

Максимальное количество записей многоадресной рассылки.

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

Укажите 0, чтобы сбросить значение до unlimited.

reserved_multicast_entries

aliases: rsvd

integer

Зарезервированные записи многоадресной рассылки.

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

Обязательно, если указан reserved_route_map.

reserved_route_map

aliases: route_map, route_map_dn

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

Обязательно, если указан reserved_multicast_entries.

source_specific_multicast

aliases: ssm, specific_source

dictionary

Контейнер конфигурации параметров многоадресной рассылки с указанием источника (SSM) протокола независимой многоадресной рассылки (PIM).

group_range_route_map

aliases: group_range_policy

string

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

state

string

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

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

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

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

Варианты:

• 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

vrf

aliases: vrf_name

string

Имя существующей VRF.

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Информация об ошибке, возвращенная APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная в запросе

Возвращается: failure или debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure или debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, предоставленных пользователем

Возвращается: info

Пример: {"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 \"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure или debug

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

sent

list / elements=string

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

Возвращается: info

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

status

integer

Статус HTTP от APIC

Возвращается: failure или debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure или debug

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