cisco.aci.aci_aaa_certificate_authority модуль — Управление авторизационными сертифицирующими центрами AAA (pki:TP)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_aaa_certificate_authority.

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

Обзор

Управление авторизационными сертифицирующими центрами AAA на платформах Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION` не определена, используется значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
certificate_chain псевдонимы: cert_data, certificate_data, cert, certificate строка	Цепочка доверия в формате PEM от узла доверия до доверенного корневого удостоверения.
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 строка	Описание Удостоверения Авторитета Сертификации.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемого хостом управления Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
name псевдонимы: certificate_authority, cert_authority, cert_authority_name, certificate_authority_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 строка	Путь к файлу, в который будет записан JSON-конфигурационный объект ACI, сгенерированный модулем. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, который позволяет клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, который позволяет клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_TAG`.
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`.

END_OF_DOCUMENT_MARKER

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:TP.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a Certificate Authority
  cisco.aci.aci_aaa_certificate_authority:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_authority
    certificate_chain: '{{ lookup("file", "pki/example_authority.crt") }}'
    state: present
  delegate_to: localhost

- name: Query a Certificate Authority
  cisco.aci.aci_aaa_certificate_authority:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_authority
    state: query
  delegate_to: localhost
  register: query_result

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

- name: Delete a Certificate Authority
  cisco.aci.aci_aaa_certificate_authority:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_authority
    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_certificate_authority_module.html