community.general.proxmox_group_info – Retrieve information about one or more Proxmox VE groups

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.proxmox_group_info.

New in version 1.3.0: of community.general

Synopsis

  • Retrieve information about one or more Proxmox VE groups

Requirements

The below requirements are needed on the host that executes this module.

  • proxmoxer

  • requests

Parameters

Parameter

Comments

api_host

string / required

Specify the target host of the Proxmox VE cluster.

api_password

string

Specify the password to authenticate with.

You can use PROXMOX_PASSWORD environment variable.

api_token_id

string

added in 1.3.0 of community.general

Specify the token ID.

api_token_secret

string

added in 1.3.0 of community.general

Specify the token secret.

api_user

string / required

Specify the user to authenticate with.

group

aliases: groupid, name

string

Restrict results to a specific group.

validate_certs

boolean

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • no ← (default)

  • yes

Examples

- name: List existing groups
  community.general.proxmox_group_info:
    api_host: helldorado
    api_user: [email protected]
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_groups

- name: Retrieve information about the admin group
  community.general.proxmox_group_info:
    api_host: helldorado
    api_user: [email protected]
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    group: admin
  register: proxmox_group_admin

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

proxmox_groups

list / elements=dictionary

List of groups.

Returned: always, but can be empty

comment

string

Short description of the group.

Returned: on success, can be absent

groupid

string

Group name.

Returned: on success

users

list / elements=string

List of users in the group.

Returned: on success

Authors

  • Tristan Le Guern (@tleguern)