maxhoesel.proxmox.pbs_datastore (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 datastores on a Proxmox Backup Server

Requirements

• proxmoxer >=1.2
• requests

Usage examples

Scanned by Steampunk Spotter

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

- name: Create/Update a datastore
  maxhoesel.proxmox.pbs_datastore:
    api_user: root@pam
    api_password: secret
    api_host: helldorado
    name: test-datastore
    path: /mnt/somedisk/thisdirectory
    gc_schedule: daily
    prune_schedule: daily
    keep_daily: 7
    keep_weekly: 4
    keep_monthly: 6
    notify:
      gc: error
      verify: error
      sync: error
    verify_new: yes

Inputs

    
name:
    description: Name of the datastore
    required: true
    type: str

path:
    description: Backing path for the datastore. Required when creating a new datastore
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Whether this datastore should be C(present) or C(absent)
    type: str

notify:
    description: Datastore notification settings
    suboptions:
      gc:
        choices:
        - always
        - never
        - error
        description: Garbage Collection notification setting
        type: str
      sync:
        choices:
        - always
        - never
        - error
        description: Sync Jobs notification setting
        type: str
      verify:
        choices:
        - always
        - never
        - error
        description: Verification notification setting
        type: str
    type: dict

comment:
    description: Comment for the datastore (visible in UI)
    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

keep_last:
    description: Number of backups to keep
    type: int

keep_daily:
    description: Number of daily backups to keep
    type: int

verify_new:
    description: If enabled, all new backups will be verified right after completion
    type: bool

gc_schedule:
    description: Run garbace collection job at specified schedule. Must be a calendar
      event (i.e C(daily), C(Tue 04:27))
    type: str

keep_hourly:
    description: Number of hourly backups to keep
    type: int

keep_weekly:
    description: Number of weekly backups to keep
    type: int

keep_yearly:
    description: Number of yearly backups to keep
    type: int

notify_user:
    description: User ID to notify
    type: str

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

keep_monthly:
    description: Number of monthly backups to keep
    type: int

prune_schedule:
    description: Run prune job at specified schedule. Must be a calendar event (i.e C(daily),
      C(Tue 04:27))
    type: str

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