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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_user_info.

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

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

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

Требования

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

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой хост кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите ID токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
domain псевдонимы: realm string	Ограничить результаты указанной областью аутентификации.
user псевдонимы: name string	Ограничить результаты указанным пользователем.
userid string	Ограничить результаты указанным ID пользователя, который представляет собой объединение частей пользователя и домена.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время значение по умолчанию — `false`; в community.proxmox 2.0.0 оно изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`

Атрибуты

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

Примеры

- name: List existing users
  community.proxmox.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.proxmox.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.proxmox.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.proxmox.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 / элементы=dictionary	Список пользователей. Возвращается: всегда, но список может быть пустым
comment string	Краткое описание пользователя. Возвращается: при успешном выполнении
domain string	Область аутентификации пользователя, также правая часть ID пользователя. Возвращается: при успешном выполнении
email string	Адрес электронной почты пользователя. Возвращается: при успешном выполнении
enabled boolean	Состояние учётной записи пользователя. Возвращается: при успешном выполнении
expire integer	Дата истечения срока действия в секундах с начала эпохи (EPOCH). Ноль означает отсутствие срока действия. Возвращается: при успешном выполнении
firstname string	Имя пользователя. Возвращается: при успешном выполнении
groups list / элементы=string	Список групп, в которые входит пользователь. Возвращается: при успешном выполнении
keys string	Ключи двухфакторной аутентификации пользователя. Возвращается: при успешном выполнении
lastname string	Фамилия пользователя. Возвращается: при успешном выполнении
tokens list / элементы=dictionary	Список API-токенов, связанных с пользователем. Возвращается: при успешном выполнении
comment string	Краткое описание токена. Возвращается: при успешном выполнении
expire integer	Дата истечения срока действия в секундах с начала эпохи (EPOCH). Ноль означает отсутствие срока действия. Возвращается: при успешном выполнении
privsep boolean	Показывает, ограничен ли API-токен дополнительными ACL или обладает полными привилегиями. Возвращается: при успешном выполнении
tokenid string	Имя токена. Возвращается: при успешном выполнении
user string	Имя входа пользователя, также левая часть ID пользователя. Возвращается: при успешном выполнении
userid string	ID пользователя Proxmox в формате user@realm. Возвращается: при успешном выполнении

Авторы

Tristan Le Guern (@tleguern)

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

© 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/community/proxmox/proxmox_user_info_module.html