aci_aaa_user_certificate — Управление сертификатами пользователей AAA (aaa:UserCert)

Новая версия с 2.5.

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус
- Автор

Обзор

Управление сертификатами пользователей AAA на устройствах Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aaa_user		Имя пользователя, которому нужно добавить сертификат.
aaa_user_type	Варианты: user ← appuser	Является ли это обычным пользователем или appuser.
certificate		Открытый ключ в формате PEM, извлеченный из сертификата X.509. Псевдонимы: cert_data, certificate_data
certificate_name	Значение по умолчанию: C(private_key) basename	Имя записи сертификата пользователя в ACI. Псевдонимы: cert_name
host обязательно		IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible. Псевдонимы: hostname
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` означает информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` означает отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password обязательно		Пароль для аутентификации.
port	Значение по умолчанию: 443 (для https) и 80 (для http)	Номер порта для подключения REST.
private_key		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `certificate_name`. Псевдонимы: cert_key
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода объекта или нескольких объектов.
timeout	Значение по умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
use_ssl	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
username обязательно	Значение по умолчанию: admin	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует задать только для `no` используемых на сайтах с собственным сертификатом.

Примечания

Примечание

Перед использованием этого модуля в вашей книге задач должен существовать aaa_user. Модуль aci_aaa_user может быть использован для этого.
Дополнительную информацию о внутреннем классе APIC aaa:UserCert можно найти в справочнике по модели управления информацией APIC.
По умолчанию, если на целевом узле установлена переменная окружения <protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. настройка среды) или с помощью параметра use_proxy.
HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов правильна.

Примеры

- name: Add a certificate to user
  aci_aaa_user_certificate:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: admin
    certificate_name: admin
    certificate_data: '{{ lookup("file", "pki/admin.crt") }}'
    state: present

- name: Remove a certificate of a user
  aci_aaa_user_certificate:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: admin
    certificate_name: admin
    state: absent

- name: Query a certificate of a user
  aci_aaa_user_certificate:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: admin
    certificate_name: admin
    state: query

- name: Query all certificates of a user
  aci_aaa_user_certificate:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: admin
    state: query

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

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

Ключ	Возвращаемое значение	Описание
current список	успех	Текущая конфигурация из APIC после завершения модуля. Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращенная из APIC. Пример: {'text': 'неизвестный класс управляемого объекта foo', 'code': '122'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса. Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	Метод HTTP, используемый для запроса к APIC. Пример: POST
previous список	информация	Исходная конфигурация из APIC до запуска модуля. Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производство', 'nameAlias': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров пользователя. Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращенный REST API APIC (xml или json). Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC. Пример: OK (30 байт)
sent список	информация	Фактическая/минимальная конфигурация, отправленная в APIC. Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус от APIC. Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC. Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

Dag Wieers (@dagwieers)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/aci_aaa_user_certificate_module.html