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

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook укажите: community.general.proxmox_user_info.

Введено в версии 1.3.0: of community.general

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

Описание

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

Требования

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

proxmoxer
requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_host строка / обязательно		Укажите целевой хост кластера Proxmox VE.
api_password строка		Укажите пароль для аутентификации. Можно использовать переменную среды `PROXMOX_PASSWORD`.
api_token_id строка добавлено в 1.3.0 of community.general		Укажите идентификатор токена.
api_token_secret строка добавлено в 1.3.0 of community.general		Укажите секрет токена.
api_user строка / обязательно		Укажите пользователя для аутентификации.
domain строка		Ограничить результаты определенной областью аутентификации. псевдонимы: realm
user строка		Ограничить результаты определенным пользователем. псевдонимы: name
userid строка		Ограничить результаты определенным идентификатором пользователя, представляющим собой конкатенацию частей пользователя и домена.
validate_certs булево	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.

Примеры

- 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 список / элементы=словарь			всегда, но может быть пустым	Список пользователей.
	comment строка		при успехе	Краткое описание пользователя.
	domain строка		при успехе	Область аутентификации пользователя, также правая часть идентификатора пользователя.
	email строка		при успехе	Электронный адрес пользователя.
	enabled булево		при успехе	Состояние учетной записи пользователя.
	expire целое число		при успехе	Дата истечения срока действия в секундах с момента эпохи. Ноль означает отсутствие истечения срока действия.
	firstname строка		при успехе	Имя пользователя.
	groups список / элементы=строка		при успехе	Список групп, членом которых является пользователь.
	keys строка		при успехе	Ключи двухфакторной аутентификации пользователя.
	lastname строка		при успехе	Фамилия пользователя.
	tokens список / элементы=словарь		при успехе	Список токенов API, связанных с пользователем.
		comment строка	при успехе	Краткое описание токена.
		expire целое число	при успехе	Дата истечения срока действия в секундах с момента эпохи. Ноль означает отсутствие истечения срока действия.
		privsep булево	при успехе	Описывает, если токен API дополнительно ограничен ACL или имеет полные привилегии.
		tokenid строка	при успехе	Имя токена.
	user строка		при успехе	Логин пользователя, также левая часть идентификатора пользователя.
	userid строка		при успехе	Идентификатор пользователя Proxmox, представленный в виде user@realm.

Авторы

Tristan Le Guern (@Aversiste)

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