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

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

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

Описание

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

Требования

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

python-dateutil

Параметры

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

Примечания

Примечание

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

Примеры

- 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': {'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 строка	ошибка разбора	Необработанный вывод, возвращенный 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

Статус

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

Автор

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_module.html