maxhoesel.proxmox.pbs_user (5.0.1) — module

Install collection

Install with ansible-galaxy collection install maxhoesel.proxmox:==5.0.1

Add to requirements.yml

  collections:
    - name: maxhoesel.proxmox
      version: 5.0.1

Description

Create, update and delete user accounts on a Proxmox Backup Server instance.

Requirements

• proxmoxer >=1.2
• requests

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure that the user john@pbs exists
  maxhoesel.proxmox.pbs_user:
    api_user: root@pam
    api_password: secret
    api_host: helldorado
    userid: john@pbs
    firstname: John
    lastname: Smith
    password: johnsverysecretpassword
    email: john@example.org
    state: present

Scanned by Steampunk Spotter

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

- name: Ensure that the user john@smith does not exist
  maxhoesel.proxmox.pbs_user:
    api_user: root@pam
    api_password: secret
    api_host: helldorado
    userid: john@pbs
    state: absent

Inputs

    
email:
    description: E-Mail Address of the user
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: C(present) makes sure the user exists, C(absent) makes sure the user
      is removed.
    type: str

expire:
    description: Account expiration data (seconds since UNIX epoch). 0 means no expiration
      date
    type: int

userid:
    aliases:
    - name
    - id
    description: 'User ID, in the format C(user@realm). Example: C(john@pbs)

      '
    required: true
    type: str

comment:
    description: User account comment
    type: str

enabled:
    description: Whether to enable the account. false means disabled.
    type: bool

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

lastname:
    description: User Last Name
    type: str

password:
    description: 'Password for the user. Note that this module does B(not) update the
      password by default! To force this behavior (this also causes the module to always
      return as changed), set I(password_update) to True

      '
    type: str

firstname:
    description: User First Name
    type: str

api_password:
    description:
    - Specify the password to authenticate with.
    - You can also use the C(PROXMOX_PASSWORD) environment variable.
    type: str

validate_certs:
    default: false
    description:
    - Validate SSL certificate of the PVE host upon connecting
    type: bool

password_update:
    aliases:
    - update_password
    default: false
    description: Whether to force update the password of an existing user
    type: bool