Модуль community.general.proxmox_user_info — Получение информации об одном или нескольких пользователях Proxmox VE

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: community.general.proxmox_user_info.

Добавлена в community.general 1.3.0

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

Описание

Получение информации об одном или нескольких пользователях Proxmox VE

Требования

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

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Вы можете использовать переменную среды `PROXMOX_PASSWORD`.
api_port целое число добавлен в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Используется переменная среды `PROXMOX_PORT`, если не указано.
api_token_id строка добавлен в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлен в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
область алиасы: realm строка	Ограничьте результаты определенной областью аутентификации.
пользователь алиасы: имя строка	Ограничьте результаты определенным пользователем.
userid строка	Ограничьте результаты определенным ID пользователя, который представляет собой конкатенацию частей пользователя и области.
validate_certs логическое	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяющими сертификатами. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox добавлен в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменений состояния без изменения целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Вернет подробности о том, что изменилось (или, возможно, должно измениться в `check_mode`), когда режим diff включен.

Примеры

- name: List existing users
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_users

- name: List existing users in the pve authentication realm
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    domain: pve
  register: proxmox_users_pve

- name: Retrieve information about admin@pve
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    userid: admin@pve
  register: proxmox_user_admin

- name: Alternative way to retrieve information about admin@pve
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    user: admin
    domain: pve
  register: proxmox_user_admin

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

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

Ключ	Описание
proxmox_users list / elements=dictionary	Список пользователей. Возвращается: всегда, но может быть пустым
comment string	Краткое описание пользователя. Возвращается: при успехе
domain string	Область проверки подлинности пользователя, также правая часть идентификатора пользователя. Возвращается: при успехе
email string	Адрес электронной почты пользователя. Возвращается: при успехе
enabled boolean	Состояние учетной записи пользователя. Возвращается: при успехе
expire integer	Дата истечения срока действия в секундах с момента EPOCH. Ноль означает отсутствие срока действия. Возвращается: при успехе
firstname string	Имя пользователя. Возвращается: при успехе
groups list / elements=string	Список групп, членом которых является пользователь. Возвращается: при успехе
keys string	Ключи двухфакторной аутентификации пользователя. Возвращается: при успехе
lastname string	Фамилия пользователя. Возвращается: при успехе
tokens list / elements=dictionary	Список токенов API, связанных с пользователем. Возвращается: при успехе
comment string	Краткое описание токена. Возвращается: при успехе
expire integer	Дата истечения срока действия в секундах с момента EPOCH. Ноль означает отсутствие срока действия. Возвращается: при успехе
privsep boolean	Описывает, является ли токен API дополнительно ограниченным с помощью ACL или имеет полные права. Возвращается: при успехе
tokenid string	Имя токена. Возвращается: при успехе
user string	Имя для входа пользователя, также левая часть идентификатора пользователя. Возвращается: при успехе
userid string	Идентификатор пользователя Proxmox, представленный как user@realm. Возвращается: при успехе

Авторы

Tristan Le Guern (@tleguern)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_user_info_module.html