aci_aaa_user – Управление пользователями AAA (aaa:User)

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

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

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python-dateutil

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aaa_password -		Пароль пользователя с локальной аутентификацией.
aaa_password_lifetime integer		Срок действия пароля пользователя с локальной аутентификацией.
aaa_password_update_required boolean	Варианты: no yes	Требуется ли обновление пароля для этой учетной записи.
aaa_user -		Имя пользователя с локальной аутентификацией, которого нужно добавить. Псевдонимы: name, user
certificate_name -		Имя сертификата X.509, прикрепленного к пользователю AAA APIC, используемому для аутентификации на основе подписи. По умолчанию равно `private_key` basename без расширения. Псевдонимы: cert_name
clear_password_history boolean	Варианты: no yes	Очистить историю паролей пользователя с локальной аутентификацией.
description -		Описание пользователя AAA. Псевдонимы: descr
email -		Электронный адрес пользователя с локальной аутентификацией.
enabled boolean	Варианты: no yes	Статус учетной записи пользователя с локальной аутентификацией.
expiration -		Дата истечения срока действия учетной записи пользователя с локальной аутентификацией.
expires boolean	Варианты: no yes	Включить дату истечения срока действия учетной записи пользователя с локальной аутентификацией.
first_name -		Имя пользователя с локальной аутентификацией.
host - / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Псевдонимы: hostname
last_name -		Фамилия пользователя с локальной аутентификацией.
output_level -	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password - / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если указан также `private_key`, он будет использован вместо него.
phone -		Номер телефона пользователя с локальной аутентификацией.
port -		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key - / обязательно		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `certificate_name`. Этот параметр взаимоисключающий с `password`. Если указан также `password`, он будет проигнорирован. Псевдонимы: cert_key
state -	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
timeout integer	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy boolean	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
use_ssl boolean	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
username -	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при использовании на сайтах под вашим контролем с самозаверяющими сертификатами.

Примечания

Примечание

Этот модуль не идемпотентен, когда используется aaa_password (даже если этот пароль уже был установлен идентично). Похоже, это несоответствие в отношении идемпотентности REST API APIC. Продавцу было сообщено об этом.
Дополнительную информацию см. в документации ACI.
Дополнительную информацию об внутреннем классе APIC aaa:User см. в справке по модели управления информацией APIC.

См. также

Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a user
  aci_aaa_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: dag
    aaa_password: AnotherSecretPassword
    expiration: never
    expires: no
    email: dag@wieers.com
    phone: 1-234-555-678
    first_name: Dag
    last_name: Wieers
    state: present
  delegate_to: localhost

- name: Remove a user
  aci_aaa_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: dag
    state: absent
  delegate_to: localhost

- name: Query a user
  aci_aaa_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: dag
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all users
  aci_aaa_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Возвращено	Описание
current список	успешно	Текущая конфигурация из APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая из APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация из APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка парсинга	Необработанный вывод, возвращённый API REST 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

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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.7/modules/aci_aaa_user_module.html