Модуль cisco.aci.aci_taboo_contract — управление табу-контрактами (vz:BrCP)

annotation

string

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

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

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

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

certificate_name

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

string

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

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

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

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

description

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

string

Описание табу-контракта.

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.

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.

port

integer

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

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

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

private_key

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

string

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

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

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

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

scope

string

Область действия сервисного контракта.

При создании APIC задаёт значение context по умолчанию, если параметр не указан.

Варианты:

• "application-profile"
• "context"
• "global"
• "tenant"

state

string

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

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

Варианты:

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

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.

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

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

Варианты:

• false
• true

taboo_contract

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

string

Имя табу-контракта.

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 после завершения работы модуля

Возвращается: 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 foo\"/></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"