cisco.aci.aci_tenant_action_rule_profile module – Управление профилями правил действий (rtctrl:AttrP)

action_rule

aliases: action_rule_name, name

string

Имя профиля правила действия.

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.

description

aliases: descr

string

Описание профиля правила действия.

host

aliases: hostname

string

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

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

multipath

boolean

Настроить правило действия на основе конфигурации set redistribute multipath.

Нельзя настроить одновременно с set_route_tag.

Нельзя настроить для APIC версии 4.2 и ниже.

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

Варианты:

• false
• true

name_alias

string

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

next_hop_propagation

boolean

Настроить правило действия на основе конфигурации nexthop unchanged.

Нельзя настроить одновременно с set_route_tag.

Нельзя настроить для APIC версии 4.2 и ниже.

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

Варианты:

• false
• true

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.

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.

set_as_path

list / elements=dictionary

Список конфигураций добавления префикса к пути автономной системы (AS).

Передача пустого списка set_as_path=[] удалит все конфигурации пути AS.

Поддерживается только в Cisco ACI версии 6.0(2) и выше.

asns

list / elements=dictionary

Список ASN для добавления в начало.

Применимо только при критерии prepend.

asn

string / обязательный

ASN для добавления в начало.

order

integer / обязательный

Порядок ASN в списке добавления префиксов.

criteria

string

Критерий пути AS.

Варианты:

• "prepend"
• "prepend-last-as"

last_num

integer

Количество добавлений последней AS в начало.

Применимо только при критерии prepend-last-as.

set_communities

list / elements=dictionary

Список дополнительных community, добавляемых в профиль правила действия с использованием критерия append.

Передача пустого списка set_communities=[] удалит все community.

Поддерживается только в Cisco ACI версии 6.0(2) и выше.

community

string / обязательный

Значение community (например, no-advertise, no-export или regular:as2-nn2:4:15).

description

aliases: descr

string

Описание community.

set_community

dictionary

Настроить правило действия на основе community.

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

community

string

Значение community.

criteria

string

Критерий community.

Вариант добавления или замены значения community.

Варианты:

• "append"
• "replace"
• "none"

set_dampening

dictionary

Настроить правило действия на основе подавления колебаний маршрутов.

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

half_life

integer

Период полураспада (в минутах).

max_suppress_time

integer

Максимальное время подавления (в минутах).

reuse

integer

Пороговое значение повторного использования.

suppress

integer

Пороговое значение подавления.

set_metric

string

Настроить правило действия на основе метрики.

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

set_metric_type

string

Настроить правило действия на основе типа метрики.

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

Варианты:

• "ospf_type_1"
• "ospf_type_2"
• ""

set_next_hop

string

Настроить правило действия на основе адреса следующего перехода.

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

set_policy_tag

dictionary

Настроить правило действия на основе тега политики (внешняя EPG или ESG).

Передача пустого словаря set_policy_tag={} удалит этот атрибут.

Необходимо настроить либо внешнюю EPG (l3out и external_epg), либо ESG (ap и esg), но не обе одновременно.

Поддерживается только в Cisco ACI версии 6.0(2) и выше.

ap

aliases: app_profile

string

Имя профиля приложения.

Обязательно указывать вместе с esg.

Несовместимо с l3out и external_epg.

esg

string

Имя группы безопасности конечных точек (ESG).

Обязательно указывать вместе с ap.

Несовместимо с l3out и external_epg.

external_epg

aliases: extepg, inst_p

string

Имя внешней EPG.

Обязательно указывать вместе с l3out.

Несовместимо с ap и esg.

l3out

string

Имя L3Out.

Обязательно указывать вместе с external_epg.

Несовместимо с ap и esg.

set_preference

string

Настроить правило действия на основе предпочтения.

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

set_route_tag

string

Настроить правило действия на основе тега маршрута.

Нельзя настроить одновременно с next_hop_propagation и multipath.

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

set_weight

string

Настроить правило действия на основе веса.

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

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

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

строка

Имя пользователя для аутентификации.

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

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

validate_certs

логический

Если false, сертификаты SSL проверяться не будут.

Устанавливайте значение false только на контролируемых вами сайтах, использующих самоподписанные сертификаты.

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

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

Варианты:

• false
• true

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

строка

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

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

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