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 строка		Имя сертификата X.509, прикрепленного к пользователю AAA APIC, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, по умолчанию используется `private_key` базовое имя без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. псевдонимы: 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 строка / обязательно		Пароль для аутентификации. Этот параметр взаимно исключающий с `private_key`. Если указан также `private_key`, будет использован он.
phone строка		Номер телефона локально аутентифицированного пользователя.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимно исключающий с `password`. Если указан также `password`, он будет проигнорирован. псевдонимы: 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_password (даже если этот пароль уже был установлен идентичным образом). Похоже, это несоответствие в отношении идемпотентности API REST APIC. Продавцу было сообщено. Дополнительная информация в документации ACI.

См. также

aci_aaa_user_certificate – Управление сертификатами пользователей AAA (aaa:UserCert): Официальная документация по модулю aci_aaa_user_certificate.
Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC aaa:User.
Руководство по 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.8/modules/aci_aaa_user_module.html