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 2.5.1).

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	Choices/Defaults	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 string		Restrict results to a specific group. aliases: groupid, name
validate_certs boolean	Choices: no ← yes	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: List existing groups
  community.general.proxmox_group_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_groups

- name: Retrieve information about the admin group
  community.general.proxmox_group_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) }}"
    group: admin
  register: proxmox_group_admin

Return Values

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

Key		Returned	Description
proxmox_groups list / elements=dictionary		always, but can be empty	List of groups.
	comment string	on success, can be absent	Short description of the group.
	groupid string	on success	Group name.
	users list / elements=string	on success	List of users in the group.

Authors

• Tristan Le Guern (@Aversiste)