Модуль cisco.aci.aci_aaa_user — управление пользователями AAA (aaa:User)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_aaa_user.

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python-dateutil

Параметры

Параметр	Описание
aaa_password строка	Пароль пользователя, аутентифицируемого локально. Указание этого параметра всегда приводит к изменению, поскольку это защищённое свойство, которое невозможно получить из APIC.
aaa_password_lifetime целое число	Срок действия пароля пользователя, аутентифицируемого локально.
aaa_password_update_required логический	Требуется ли для этой учётной записи обновление пароля. Варианты: `false` `true`
aaa_user псевдонимы: name строка	Имя пользователя, аутентифицируемого локально, которого нужно добавить.
annotation строка	Определяемая пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю AAA APIC и используемого для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
clear_password_history логический	Следует ли очистить историю паролей пользователя, аутентифицируемого локально. Варианты: `false` `true`
description псевдонимы: descr строка	Описание пользователя AAA.
email строка
enabled логический	Состояние учётной записи пользователя, аутентифицируемого локально. Варианты: `false` `true`
expiration строка	Дата истечения срока действия учётной записи пользователя, аутентифицируемого локально.
expires логический	Следует ли включить дату истечения срока действия учётной записи пользователя, аутентифицируемого локально. Варианты: `false` `true`
first_name строка	Имя пользователя, аутентифицируемого локально.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
last_name строка	Фамилия пользователя, аутентифицируемого локально.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Управляет выводом этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Определяемая пользователем строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Определяемая пользователем строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использован он. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
phone строка	Номер телефона пользователя, аутентифицируемого локально.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — возвращаемое значение previous будет пустым. Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после отправки POST-запроса на обновление в APIC проверочный GET-запрос отправлен не будет. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — возвращаемому значению current будет присвоено предлагаемое значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy логический	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логический	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте значение `false` только для контролируемых вами сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

Примечания

Примечание

Этот модуль не является идемпотентным при использовании aaa_password (даже если такой пароль уже был установлен и совпадает). По-видимому, это несоответствие идемпотентному поведению REST API APIC. Производитель уведомлён. Дополнительные сведения см. в :ref:`документации ACI <aci_guide_known_issues>`.

См. также

cisco.aci.aci_aaa_user_certificate: Управление сертификатами пользователей AAA (aaa:UserCert).
Справочник информационной модели управления APIC: Дополнительные сведения о внутреннем классе APIC aaa:User.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

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

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

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

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

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

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

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

Авторы

Dag Wieers (@dagwieers)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_aaa_user_module.html