Parameter |
Choices/Defaults |
Comments |
api_host
required |
|
the host of the Proxmox VE cluster
|
api_password
|
|
the password to authenticate with
you can use PROXMOX_PASSWORD environment variable
|
api_user
required |
|
the user to authenticate with
|
cores
(added in 2.4) |
Default:
1
|
Specify number of cores per socket.
|
cpus
|
Default:
1
|
numbers of allocated cpus for instance
|
cpuunits
|
Default:
1000
|
CPU weight for a VM
|
disk
|
Default:
3
|
hard disk size in GB for instance
|
force
bool |
|
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
|
|
the instance hostname
required only for state=present
must be unique if vmid is not passed
|
ip_address
|
|
specifies the address the container will be assigned
|
memory
|
Default:
512
|
memory size in MB for instance
|
mounts
(added in 2.2) |
|
specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points
|
nameserver
|
|
sets DNS server IP address for a container
|
netif
|
|
specifies network interfaces for the container. As a hash/dictionary defining interfaces.
|
node
|
|
Proxmox VE node, when new VM will be created
required only for state=present
for another states will be autodiscovered
|
onboot
bool |
|
specifies whether a VM will be started during system bootup
|
ostemplate
|
|
the template for VM creating
required only for state=present
|
password
|
|
the instance root password
required only for state=present
|
pool
(added in 2.3) |
|
Proxmox VE resource pool
|
pubkey
(added in 2.3) |
|
Public key to add to /root/.ssh/authorized_keys. This was added on Proxmox 4.2, it is ignored for earlier versions
|
searchdomain
|
|
sets DNS search domain for a container
|
state
|
Choices:
present ←
- started
- absent
- stopped
- restarted
|
Indicate desired state of the instance
|
storage
|
Default:
local
|
target storage
|
swap
|
Default:
0
|
swap memory size in MB for instance
|
timeout
|
Default:
30
|
timeout for operations
|
unprivileged
bool
(added in 2.3) |
|
Indicate if the container should be unprivileged
|
validate_certs
bool |
|
enable / disable https certificate verification
|
vmid
|
|
the instance id
if not set, the next available VM ID will be fetched from ProxmoxAPI.
if not set, will be fetched from PromoxAPI based on the hostname
|