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

Примечание

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

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

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

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

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

Краткое описание

Управление связками ключей AAA на фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Строка, определяемая пользователем, для добавления аннотации к объекту. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не задано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate aliases: cert_data, certificate_data, cert string	Сертификат связки ключей. Сертификат содержит открытый ключ и подписанные сведения для проверки личности.
certificate_authority aliases: cert_authority, cert_authority_name, certificate_authority_name string	Имя центра сертификации.
certificate_name aliases: cert_name string	Имя сертификата X.509, привязанного к пользователю AAA APIC, который используется для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
cloud_tenant aliases: tenant, tenant_name string	Имя облачного арендатора. Этот атрибут применим только для Cloud APIC.
description aliases: descr string	Описание связки ключей.
ecc_curve aliases: curve string	Кривая закрытого ключа. Для этого атрибута требуется `key_type=ecc`. Этот атрибут можно настраивать только в ACI версии 6.0(2h) и выше. Варианты: `"P256"` `"P384"` `"P521"` `"none"`
host aliases: hostname string	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
key string	Закрытый ключ сертификата. Указание этого параметра всегда приводит к изменению, поскольку это защищённое свойство, которое невозможно получить из APIC.
key_type string	Тип закрытого ключа. Этот атрибут можно настраивать только в ACI версии 6.0(2h) и выше. Варианты: `"rsa"` `"ecc"`
modulus integer	Длина ключа в битах. Варианты: `512` `1024` `1536` `2048`
name aliases: key_ring, key_ring_name string	Имя связки ключей.
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 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`, перед обновлением POST в APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта проверяться не будет, а обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST в APIC не будет отправлен GET-запрос для проверки. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `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`, вместо подключения HTTPS по умолчанию будет использоваться подключение HTTP. Если значение не задано в задаче, вместо него будет использоваться значение переменной среды `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: Дополнительная информация о внутреннем классе 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 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 or debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure or 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) Возвращается: parse error Пример: `"<?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 or debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: failure or debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_aaa_key_ring_module.html