maxhoesel.proxmox.pbs_acl module – Manage ACLs on a Proxmox Backup Server

Note

This module is part of the maxhoesel.proxmox collection (version 5.1.1).

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 maxhoesel.proxmox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: maxhoesel.proxmox.pbs_acl.

New in maxhoesel.proxmox 4.0.0

Synopsis

  • Create, update and delete ACLs for users/tokens on a Proxmox Backup Server

Requirements

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

  • proxmoxer >=1.2

  • 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 also use the PROXMOX_PASSWORD environment variable.

api_user

string / required

Specify the user to authenticate with.

auth_id

string

Authentication ID to assign the ACL to. Example: john@pbs

path

string / required

Access control path.

propagate

boolean

Propagate this ACL so subdirectories (inherit this ACL)

Choices:

  • false

  • true

role

string / required

Role name to be assigned to the ACL. Example: DatastoreAdmin

state

string

Whether this ACL should be present or absent

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Validate SSL certificate of the PVE host upon connecting

Choices:

  • false ← (default)

  • true

Notes

Note

  • Check mode is supported.

Examples

- name: ACL for user john is present
  maxhoesel.proxmox.pbs_acl:
    api_user: root@pam
    api_password: secret
    api_host: helldorado
    path: /datastore/backup1
    role: DatastoreBackup
    auth_id: john@pbs

Authors

  • Max Hösel (@maxhoesel)