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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

python-dateutil

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aaa_password		Пароль пользователя, аутентифицируемого локально.
aaa_password_lifetime		Срок действия пароля пользователя, аутентифицируемого локально.
aaa_password_update_required bool	Варианты: no yes	Требуется ли обновление пароля для этой учетной записи.
aaa_user		Имя пользователя, аутентифицируемого локально, для добавления. Псевдонимы: name, user
certificate_name		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию соответствует `private_key` имени без расширения. Псевдонимы: cert_name
clear_password_history bool	Варианты: no yes	Необходимо ли очистить историю паролей для пользователя, аутентифицируемого локально?
description		Описание пользователя AAA. Псевдонимы: descr
email		Адрес электронной почты пользователя, аутентифицируемого локально.
enabled bool	Варианты: no yes	Статус учетной записи пользователя, аутентифицируемого локально.
expiration		Дата истечения срока действия учетной записи пользователя, аутентифицируемого локально.
expires bool	Варианты: 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 int	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует устанавливать в значение `no` только при работе с сайтами, контролируемыми лично, использующими самозаверенные сертификаты.

Примечания

Примечание

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

Примеры

- 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

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

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

- name: Query all users
  aci_aaa_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

Возвращаемые значения

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

Ключ	Результат	Описание
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 строка	ошибка разбора	Необработанный вывод, возвращенный APIC REST API (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. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/aci_aaa_user_module.html