community / community.general / 1.3.14 / module / proxmox_group_info Retrieve information about one or more Proxmox VE groups | "added in version" 1.3.0 of community.general" Authors: Tristan Le Guern (@tleguern)community.general.proxmox_group_info (1.3.14) — module
Install with ansible-galaxy collection install community.general:==1.3.14
collections: - name: community.general version: 1.3.14
Retrieve information about one or more Proxmox VE groups
- 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
group: aliases: - groupid - name description: - Restrict results to a specific group. type: str api_host: description: - Specify the target host of the Proxmox VE cluster. required: true type: str api_user: description: - Specify the user to authenticate with. required: true type: str api_password: description: - Specify the password to authenticate with. - You can use C(PROXMOX_PASSWORD) environment variable. type: str api_token_id: description: - Specify the token ID. type: str version_added: 1.3.0 version_added_collection: community.general validate_certs: default: false description: - If C(no), SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates. type: bool api_token_secret: description: - Specify the token secret. type: str version_added: 1.3.0 version_added_collection: community.general
proxmox_groups: contains: comment: description: Short description of the group. returned: on success, can be absent type: str groupid: description: Group name. returned: on success type: str users: description: List of users in the group. elements: str returned: on success type: list description: List of groups. elements: dict returned: always, but can be empty type: list