Модуль cisco.aci.aci_aaa_key_ring – Управление кольцами AAA ключей (pki:KeyRing)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_aaa_key_ring.

Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Управление кольцами AAA ключей на ЦИСКИ ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate псевдонимы: cert_data, certificate_data, cert строка	Сертификат кольца ключей. Сертификат содержит открытый ключ и подписанную информацию для проверки подлинности.
certificate_authority псевдонимы: cert_authority, cert_authority_name, certificate_authority_name строка	Имя центра сертификации.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
cloud_tenant псевдонимы: tenant, tenant_name строка	Имя облачного арендатора. Этот атрибут применим только для облачного APIC.
description псевдонимы: descr строка	Описание кольца ключей.
ecc_curve псевдонимы: curve строка	Кривая закрытого ключа. Этот атрибут требует `key_type=ecc`. Этот атрибут настраивается только в версиях ACI 6.0(2h) и выше. Варианты: `"P256"` `"P384"` `"P521"` `"none"`
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемый хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
key строка	Закрытый ключ для сертификата. Предоставление этого параметра всегда приведет к изменению, поскольку это защищенное свойство, которое нельзя получить из APIC.
key_type строка	Тип закрытого ключа. Этот атрибут настраивается только в версиях ACI 6.0(2h) и выше. Варианты: `"rsa"` `"ecc"`
modulus целое число	Модуль — это длина ключа в битах. Варианты: `512` `1024` `1536` `2048`
name псевдонимы: key_ring, key_ring_name строка	Имя кольца ключей.
name_alias строка	Псевдоним для текущего объекта. Он относится к полю nameAlias в ACI.
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 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 aliases: cert_key string	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на используемый по умолчанию `certificate_name`. Этот параметр взаимоисключающий с `password`. Если указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменных среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Выбор: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, используется значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Выбор: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, GET-запрос проверки не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, используется значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Выбор: `false` `true`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если оно определено в переменной среды на целевых хостах. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Выбор: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true при локальном соединении. Выбор: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, используются значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при использовании на сайтах под собственным контролем с самозаверяемыми сертификатами. Если значение не указано в задаче, используется значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Выбор: `false` `true`

Примечания

Примечание

Используемый cloud_tenant должен существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

APIC Management Information Model reference: Дополнительная информация о внутренней APIC-классе pki:KeyRing.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- name: Create a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    certificate: '{{ lookup("file", "pki/example_certificate.crt") }}'
    modulus: 2048
    certificate_authority: example_certificate_authority
    key: '{{ lookup("file", "pki/example_key.key") }}'
    state: present
  delegate_to: localhost

- name: Query a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Certificate Authorities
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    state: absent
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
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 строка	Необработанный вывод, возвращённый API REST 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 строка	Используемый HTTP-URL для запроса к APIC Возвращено: ошибка или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

Ссылки на коллекцию

© 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_aaa_key_ring_module.html