модуль cisco.aci.aci_contract_subject – Управление начальными темами контрактов (vz:Subj)

annotation

string

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

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

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

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

apply_both_direction

string

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

Варианты:

• "both" ← (по умолчанию)
• "one-way"

certificate_name

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

string

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

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

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

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

consumer_match

string

Критерии сопоставления для потребителей.

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

Варианты:

• "all"
• "at_least_one"
• "at_most_one"
• "none"

contract

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

string

Имя контракта.

contract_type

string

Тип контракта: стандартный или Out of Band (oob).

Варианты:

• "standard" ← (по умолчанию)
• "oob"

description

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

string

Описание темы контракта.

dscp

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

string

Целевое значение DSCP.

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

Варианты:

• "AF11"
• "AF12"
• "AF13"
• "AF21"
• "AF22"
• "AF23"
• "AF31"
• "AF32"
• "AF33"
• "AF41"
• "AF42"
• "AF43"
• "CS0"
• "CS1"
• "CS2"
• "CS3"
• "CS4"
• "CS5"
• "CS6"
• "CS7"
• "EF"
• "VA"
• "unspecified"

dscp_consumer_to_provider

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

string

Целевое значение DSCP для цепочки фильтров от потребителя к поставщику.

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

Варианты:

• "AF11"
• "AF12"
• "AF13"
• "AF21"
• "AF22"
• "AF23"
• "AF31"
• "AF32"
• "AF33"
• "AF41"
• "AF42"
• "AF43"
• "CS0"
• "CS1"
• "CS2"
• "CS3"
• "CS4"
• "CS5"
• "CS6"
• "CS7"
• "EF"
• "VA"
• "unspecified"

dscp_provider_to_consumer

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

string

Целевое значение DSCP для цепочки фильтров от поставщика к потребителю.

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

Варианты:

• "AF11"
• "AF12"
• "AF13"
• "AF21"
• "AF22"
• "AF23"
• "AF31"
• "AF32"
• "AF33"
• "AF41"
• "AF42"
• "AF43"
• "CS0"
• "CS1"
• "CS2"
• "CS3"
• "CS4"
• "CS5"
• "CS6"
• "CS7"
• "EF"
• "VA"
• "unspecified"

host

псевдонимы: 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.

password

string

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

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

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

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

priority

string

Класс QoS.

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

Варианты:

• "level1"
• "level2"
• "level3"
• "unspecified"

priority_consumer_to_provider

string

Класс QoS для цепочки фильтров от потребителя к поставщику.

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

Варианты:

• "level1"
• "level2"
• "level3"
• "unspecified"

priority_provider_to_consumer

string

Класс QoS для цепочки фильтров от поставщика к потребителю.

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

Варианты:

• "level1"
• "level2"
• "level3"
• "unspecified"

private_key

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

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.

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

provider_match

string

Критерии сопоставления для поставщиков.

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

Варианты:

• "all"
• "at_least_one"
• "at_most_one"
• "none"

reverse_filter

boolean

Определяет, должен ли APIC поменять местами исходный и целевой порты, чтобы разрешить обратный трафик, поскольку фильтр ACI не отслеживает состояние.

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

Варианты:

• false
• true

state

string

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

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

Варианты:

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

subject

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

string

Имя темы контракта.

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

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

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

Варианты:

• false
• true

tenant

псевдонимы: 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

string

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

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

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

validate_certs

boolean

Если 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"