Модуль cisco.aci.aci_system_global_aes_passphrase_encryption — управление настройками глобального шифрования парольной фразы AES (pki:ExportEncryptionKey)

annotation

строка

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

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

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

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

certificate_name

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

строка

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

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

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

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

enable

логический тип

Включать ли усиленное шифрование.

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

Обратите внимание: при удалении существующей парольной фразы этому параметру будет присвоено значение False.

Варианты:

• false
• true

host

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

строка

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

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

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.

passphrase

строка

Парольная фраза AES, используемая для шифрования экспортируемой конфигурации.

После установки на APIC изменить её нельзя. Чтобы изменить существующую парольную фразу, необходимо удалить её, отправив запрос со значением состояния absent.

Значение парольной фразы не будет отображаться в результатах query.

password

строка

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

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

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

port

целое число

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

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

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

private_key

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

строка

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

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

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

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

state

строка

Используйте present для создания парольной фразы или изменения настройки enable.

Используйте absent для удаления существующей парольной фразы.

Используйте query для отображения текущей конфигурации.

Варианты:

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

suppress_previous

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

логический тип

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

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

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

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

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

Варианты:

• false
• true

suppress_verification

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

логический тип

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

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

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

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

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

Варианты:

• false
• true

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

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

Существующая конфигурация 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"