Documentation

proxmox - management of instances in Proxmox VE cluster

New in version 2.0.

Synopsis

allows you to create/delete/stop instances in Proxmox VE cluster Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)

Requirements (on host that executes module)

  • proxmoxer
  • requests

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
        cpus
        		 no 1
          numbers of allocated cpus for instance
          cpuunits
          		 no 1000
            CPU weight for a VM
            disk
            		 no 3
              hard disk size in GB for instance
              force
              		 no
                forcing operations
                can be used only with states present, stopped, restarted
                with state=present force option allow to overwrite existing container
                with states stopped , restarted allow to force stop instance
                hostname
                		 no
                  the instance hostname
                  required only for state=present
                  ip_address
                  		 no
                    specifies the address the container will be assigned
                    memory
                    		 no 512
                      memory size in MB for instance
                      nameserver
                      		 no
                        sets DNS server IP address for a container
                        netif
                        		 no
                          specifies network interfaces for the container
                          node
                          		 no
                            Proxmox VE node, when new VM will be created
                            required only for state=present
                            for another states will be autodiscovered
                            onboot
                            		 no
                              specifies whether a VM will be started during system bootup
                              ostemplate
                              		 no
                                the template for VM creating
                                required only for state=present
                                password
                                		 no
                                  the instance root password
                                  required only for state=present
                                  searchdomain
                                  		 no
                                    sets DNS search domain for a container
                                    state
                                    		 no present
                                    • present
                                    • started
                                    • absent
                                    • stopped
                                    • restarted
                                    Indicate desired state of the instance
                                    storage
                                    		 no local
                                      target storage
                                      swap
                                      		 no
                                        swap memory size in MB for instance
                                        timeout
                                        		 no 30
                                          timeout for operations
                                          validate_certs
                                          		 no
                                            enable / disable https certificate verification
                                            vmid
                                            		 yes
                                              the instance id

                                              Examples

                                              # Create new container with minimal options
- proxmox: vmid=100 node='uk-mc02' api_user='root@pam' api_password='1q2w3e' api_host='node1' password='123456' hostname='example.org' ostemplate='local:vztmpl/ubuntu-14.04-x86_64.tar.gz'

# Create new container with minimal options with force(it will rewrite existing container)
- proxmox: vmid=100 node='uk-mc02' api_user='root@pam' api_password='1q2w3e' api_host='node1' password='123456' hostname='example.org' ostemplate='local:vztmpl/ubuntu-14.04-x86_64.tar.gz' force=yes

# Create new container with minimal options use environment PROXMOX_PASSWORD variable(you should export it before)
- proxmox: vmid=100 node='uk-mc02' api_user='root@pam' api_host='node1' password='123456' hostname='example.org' ostemplate='local:vztmpl/ubuntu-14.04-x86_64.tar.gz'

# Start container
- proxmox: vmid=100 api_user='root@pam' api_password='1q2w3e' api_host='node1' state=started

# Stop container
- proxmox: vmid=100 api_user='root@pam' api_password='1q2w3e' api_host='node1' state=stopped

# Stop container with force
- proxmox: vmid=100 api_user='root@pam' api_password='1q2w3e' api_host='node1' force=yes state=stopped

# Restart container(stopped or mounted container you can't restart)
- proxmox: vmid=100 api_user='root@pam' api_password='1q2w3e' api_host='node1' state=stopped

# Remove container
- proxmox: vmid=100 api_user='root@pam' api_password='1q2w3e' api_host='node1' state=absent

                                              Notes

                                              Note

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

                                              This is an Extras Module

                                              For more information on what this means please read Extras Modules

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