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

Примечание

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

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

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

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

Добавлено в community.proxmox 1.6.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`.
privs псевдонимы: privileges list / elements=string	Список привилегий роли.
roleid псевдонимы: name string / обязательный	Идентификатор роли.
state string	Укажите требуемое состояние роли. Для пользовательских ролей запрещено использовать зарезервированный префикс PVE. Варианты: `"present"` ← (по умолчанию) `"absent"`
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 role
  community.proxmox.proxmox_role:
    api_host: node1
    api_user: root@pam
    api_password: password
    roleid: test
    privs:
      - VM.PowerMgmt
      - VM.Console

- name: Delete Proxmox VE role
  community.proxmox.proxmox_role:
    api_host: node1
    api_user: root@pam
    api_password: password
    roleid: test
    state: absent

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

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

Ключ	Описание
msg string	Краткое сообщение о выполненных модулем действиях. Возвращается: всегда Пример: `"Role test successfully created"`
privs list / elements=string	Список привилегий роли Возвращается: если состояние — present Пример: `["VM.PowerMgmt", "VM.Console"]`
roleid string	Идентификатор созданной, обновлённой или удалённой роли. Возвращается: при успешном выполнении Пример: `"test"`

Авторы

Clément Cruau (@PendaGTP)

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

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