julien_lecomte.proxmox.group (1.0.2) — module

Install collection

Install with ansible-galaxy collection install julien_lecomte.proxmox:==1.0.2

Add to requirements.yml

  collections:
    - name: julien_lecomte.proxmox
      version: 1.0.2

Description

Adds, modifies, or removes a Proxmox group.

Returned values will exist in a variable named 'group'.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create group 'example'
  julien_lecomte.proxmox.group:
    name: 'example'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create group 'example' with a comment
  julien_lecomte.proxmox.group:
    name: 'example'
    comment: 'Lorem ipsum'

Inputs

    
name:
    description:
    - The group name.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Specify if the group should exist (present) or absent.
    type: str

comment:
    description:
    - Optionally sets the comment field.
    type: str

Outputs

comment:
  description: Comment field.
  returned: when group exists
  type: str
name:
  description: Proxmox group name.
  returned: always
  type: str
state:
  description: State ("absent" or "present").
  returned: always
  type: str
users:
  description: Group users.
  elements: str
  returned: when group exists
  type: list

See also

• PVE API: Proxmox VE Application Programming Interface link