Documentation

proxmox_template - management of OS templates in Proxmox VE cluster

New in version 2.0.

Synopsis

  • allows you to upload/delete templates in Proxmox VE cluster

Options

parameter required default choices comments
api_host
yes
the host of the Proxmox VE cluster
api_password
no
the password to authenticate with
you can use PROXMOX_PASSWORD environment variable
api_user
yes
the user to authenticate with
content_type
no vztmpl
  • vztmpl
  • iso
content type
required only for state=present
force
no
  • yes
  • no
can be used only with state=present, exists template will be overwritten
node
yes
Proxmox VE node, when you will operate with template
src
no
path to uploaded file
required only for state=present

aliases: path
state
no present
  • present
  • absent
Indicate desired state of the template
storage
no local
target storage
template
no
the template name
required only for states absent, info
timeout
no 30
timeout for operations
validate_certs
no
  • yes
  • no
enable / disable https certificate verification

Examples

# Upload new openvz template with minimal options
- proxmox_template:
    node: uk-mc02
    api_user: [email protected]
    api_password: 1q2w3e
    api_host: node1
    src: ~/ubuntu-14.04-x86_64.tar.gz

# Upload new openvz template with minimal options use environment PROXMOX_PASSWORD variable(you should export it before)
- proxmox_template:
    node: uk-mc02
    api_user: [email protected]
    api_host: node1
    src: ~/ubuntu-14.04-x86_64.tar.gz

# Upload new openvz template with all options and force overwrite
- proxmox_template:
    node: uk-mc02
    api_user: [email protected]
    api_password: 1q2w3e
    api_host: node1
    storage: local
    content_type: vztmpl
    src: ~/ubuntu-14.04-x86_64.tar.gz
    force: yes

# Delete template with minimal options
- proxmox_template:
    node: uk-mc02
    api_user: [email protected]
    api_password: 1q2w3e
    api_host: node1
    template: ubuntu-14.04-x86_64.tar.gz
    state: absent

Notes

Note

  • Requires proxmoxer and requests modules on host. This modules can be installed with pip.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.