maxhoesel.proxmox.pbs_token (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 API tokens 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: Create an API token for a user
  maxhoesel.proxmox.pbs_token:
    api_user: root@pam
    api_password: secret
    api_host: helldorado
    name: mytoken
    userid: john@pbs

Inputs

    
name:
    aliases:
    - token_name
    description: 'Name of the token that will be part of the authid. Example: C(token1)
      results in the authid C(user@pbs!token1)'
    required: true
    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: Token expiration data (seconds since UNIX epoch). 0 means no expiration
      date
    type: int

userid:
    description: User that the token will be created for. Must be in C(user@realm) format
      (e.g. C(john@pbs))
    required: true
    type: str

comment:
    description: Comment for the token
    type: str

enabled:
    description: Whether to enable the token. 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

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

Outputs

secret:
  description: API Token secret
  returned: When the token is created
  type: str
tokenid:
  description: API Token identifier
  returned: always
  type: str