cisco.aci.aci_system_global_aes_passphrase_encryption модуль — Управление настройками шифрования пароля AES глобального уровня (pki:ExportEncryptionKey)
Примечание
Этот модуль является частью коллекции cisco.aci (версия 2.10.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в плейбуке укажите: cisco.aci.aci_system_global_aes_passphrase_encryption.
Обзор
- Управление настройками шифрования пароля AES глобального уровня на фабриках Cisco ACI.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано в задаче и переменной среды По умолчанию: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
enable boolean | Включить ли сильное шифрование. APIC использует значение по умолчанию Обратите внимание, что это значение будет установлено в False при удалении существующего пароля. Варианты:
|
host aliases: hostname string | IP-адрес или имя хоста APIC, разрешимые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
output_path string | Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
owner_key string | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
owner_tag string | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
passphrase string | Пароль AES, используемый для шифрования экспорта конфигурации. Это значение не может быть изменено после установки в APIC. Для изменения существующего пароля необходимо удалить его, отправив запрос со значением state Значение пароля не будет отображаться в результатах |
password string | Пароль, используемый для аутентификации. Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будет использовано значение переменных среды |
port integer | Номер порта, используемого для подключения REST. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key aliases: cert_key string | Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
state string | Используйте Используйте Используйте Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Варианты:
|
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true, когда соединение локальное. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды Значение по умолчанию — admin. |
validate_certs boolean | Если Это следует задавать как Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
См. также
См. также
- APIC Management Information Model reference
-
Дополнительная информация о внутренней модели класса APIC pki:ExportEncryptionKey.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия.
Примеры
- name: Enable encryption with a passphrase
cisco.aci.aci_system_global_aes_passphrase_encryption:
host: apic
username: admin
password: SomeSecretPassword
passphrase: ansible_passphrase
enable: 'yes'
state: present
delegate_to: localhost
- name: Query passphrase settings
cisco.aci.aci_system_global_aes_passphrase_encryption:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
- name: Clear encryption key
cisco.aci.aci_system_global_aes_passphrase_encryption:
host: apic
username: admin
password: SomeSecretPassword
state: absent
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Существующая конфигурация из APIC после завершения модуля Возвращено: успех Пример: |
error словарь | Информация об ошибке, возвращенная из APIC Возвращено: неудача Пример: |
filter_string строка | Используемая строка фильтра для запроса Возвращено: неудача или отладка Пример: |
method строка | Используемый HTTP-метод для запроса к APIC Возвращено: неудача или отладка Пример: |
previous список / элементы=строка | Исходная конфигурация из APIC до запуска модуля Возвращено: информация Пример: |
proposed словарь | Собраная конфигурация из параметров, предоставленных пользователем Возвращено: информация Пример: |
raw строка | Необработанный вывод, возвращенный API REST APIC (xml или json) Возвращено: ошибка парсинга Пример: |
response строка | HTTP-ответ от APIC Возвращено: неудача или отладка Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: |
status целое число | HTTP-статус от APIC Возвращено: неудача или отладка Пример: |
url строка | Используемый HTTP-URL для запроса к APIC Возвращено: неудача или отладка Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_system_global_aes_passphrase_encryption_module.html