Модуль community.proxmox.proxmox_user — управление пользователями в кластере Proxmox VE

Примечание

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

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

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

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

Добавлено в community.proxmox 1.2.0

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

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

Создание или удаление пользователя в кластере 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	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
comment string	Укажите описание пользователя.
email string
enable boolean	Определяет, активна ли учётная запись. Варианты: `false` `true` ← (по умолчанию)
expire integer	Дата истечения срока действия пользователя в секундах с начала эпохи. Значение 0 означает отсутствие даты истечения срока действия. По умолчанию: `0`
firstname string	Имя пользователя.
groups list / элементы=string	Список групп, в которые входит пользователь.
keys string	Ключи для двухфакторной аутентификации (yubico).
lastname string	Фамилия пользователя.
password string	Начальный пароль. Только для пользователей области аутентификации PVE. Параметр игнорируется, если пользователь уже существует или `state=absent`.
state string	Укажите требуемое состояние пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
userid псевдонимы: name string / обязательный	Имя пользователя. Должно содержать требуемую область аутентификации PVE.
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	Поддержка: full	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Create new Proxmox VE user
  community.proxmox.proxmox_user:
    api_host: node1
    api_user: root@pam
    api_password: password
    name: user@pve
    comment: Expires on 2026-01-01 00:00:00
    email: user@example.nl
    enable: true
    expire: 1767222000
    firstname: User
    groups:
      - admins
    password: GoBananas!
    lastname: Some Guy

- name: Delete a Proxmox VE user
  community.proxmox.proxmox_user:
    api_host: node1
    api_user: root@pam
    api_password: password
    name: user@pve
    state: absent

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

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

Ключ	Описание
msg string	Краткое сообщение о выполненных модулем действиях. Возвращается: всегда Пример: `"User administrators successfully created"`
userid string	Имя пользователя. Возвращается: при успешном выполнении Пример: `"test"`

Авторы

Jeffrey van Pelt (@Thulium-Drake)
Kevin Quick (@kevinquick)

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

© 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_module.html