Create proxcli config file

Options

Examples

• Create a proxmox config file

proxcli config create --hosts "pve1,pve2,pve3" --user root@pam --password rootpassword

Show proxcli configuration

Options

|option|description|Allowed values|

Examples

• show proxcli configuration

proxcli config show

List virtual machines

Options

Examples

• This command will output an unfiltered list of virtual machines available on the cluster

proxcli vms list

• This command will output a list of virtual machines on selected nodes

proxcli vms list --proxmox-nodes pve1,pve2

• This commands will output a list of virtual machines filterd by a regular expression applied on virtual machine name

proxcli vms list --filter-name "^b4p-"

• This command will output a list of virtual machines with the specified status (comma separated list possible)

proxcli vms list --status running

• You can combine the different filters together. This command show running vms matching a filter on virtual machine name on a specified node

proxcli vms list --status running --proxmox-node pve2 --filter-name ".*powerdns.*"

output formating

Info

In the previous exemples, the result is formated as a nice table. you can specify other output formating such as json or yaml. just add the output-format argument. This argument take one of table, yaml or json value.

table	json	yaml

Clone a virtual machine template

Options

Examples

• Clone a virtual machine template

proxcli vms clone --vmid 111 --name test --vm-description test --full-clone --block --target pve2 --storage b4papp 

• Clone a virtual machine template with cloud enabled template

This is the same command as for a normal clone but you need additional steps to set user, password, ssh public key and network configuration. Try the following commands after cloning finishes.

proxcli vms set --vmid 112 --ciuser myuser --cipassword mypassword --ipconfig "ip=dhcp" --sshkey "$(cat ~/.ssh/id_rsa.pub)"
proxcli vms set --vmid 112 --cores 4 --memory 4096
proxcli vms resize --vmid 112 --disk virtio0 --size "50G"

virt-customize -a lunar-server-cloudimg-amd64.img --install qemu-guest-agent 
virt-customize -a lunar-server-cloudimg-amd64.img --run-command "echo -n > /etc/machine-id"

vmid=$(pvesh get /cluster/nextid)
isopath="/mnt/pve/isos/template/iso/lunar-server-cloudimg-amd64.img"
templatename="lunar-server-cloudinit"
memory=2048
storage="b4papp"
scsihw="virtio-scsi-pci"
devname="virtio"
disksize="5G"
qm create $vmid  --memory ${memory} --name ${templatename} --net0 virtio,bridge=vmbr0
qm set $vmid --agent enabled=1
qm importdisk $vmid $isopath $storage
qm set $vmid --scsihw $scsihw --${devname}0 ${storage}:${vmid}/vm-${vmid}-disk-0.raw
qm set $vmid --ide2 ${storage}:cloudinit
qm set $vmid --boot c --bootdisk ${devname}0
qm resize $vmid ${devname}0 ${disksize}    
qm set ${vmid} --serial0 socket --vga serial0  
qm template ${vmid}

/usr/bin/chattr: Operation not supported while reading flags on /mnt/pve/b4papp/images/111/base-111-disk-0.raw

Set virtual machine parameters

Options

Examples

proxcli vms clone --vmid 100 --full-clone --block --name ubuntu-cloud-init-clone --vm-description exemple_clone --target pve1 --storage b4papp

• cloud init configuration of a vm cloned from a cloud init enabled ubuntu virtual machine

proxcli vms set --vmid 110 --ciuser myuser --cipassword mypassword --ipconfig "ip=dhcp" --sshkey "$(cat ~/.ssh/id_rsa.pub)"

• adjust resources of a cloned virtual machine

proxcli vms set --vmid 110 --cores 4 --memory 4096

• start the cloned virtual machine

proxcli vms start --vmid 111

Resize virtual machine disk

Options

Examples

• resize the boot disk

proxcli vms resize --vmid 111 --disk virtio0 --size "60G"

Delete virtual machine

Options

Examples

• delete a virtual machine by its id

proxcli vms delete --vmid 111

• delete all virtual machines matching the specified regex

proxcli vms delete --filter-name "^b4p"

• delete all virtual machines matching the specified regex without any confirmation and wait for all deletion to be finished before exiting

proxcli vms delete --filter-name "^b4p" --confirm --block

Dump virtual machine config

Arguments

Examples

• dump config of a virtual machine

proxcli vms dump_config 111

Migrate a virtual machine

Options

Examples

• migrate a virtual machine from one proxmox node to other

proxcli vms migrate --vmid 111 --target-node pve2 

• migrate multiples virtual machines by selecting the with a regex filter on their name

proxcli vms migrate --filter-name "^b4p" --target-node pve2

Display the next available vm id

Options

Examples

• Display the next available virtual machine id

proxcli vms nextId

virtual machine tags

Set virtual machine status

Description

Virtual machine status commands use the same options interface for every desired status. The following options table apply to all status commands such as start, stop, suspend or reset.

Options

Examples

• Start virtual machine

proxcli vms start --vmid 101

• Stop virtual machine

proxcli vms stop --vmid 101

• Suspend all virtual machines with name matching specified regex

proxcli vms suspend --filter-name "^b4p"

• Reset virtual machine

proxcli vms reset --vmid 101

Wait for virtual machine status

Description

wait for virtual machines to reach the desired status (stopped, running …)

Options

Examples

• wait for every virtual machine with name start with test to be stopped

proxcli vms wait_for_status --filter-name "^test" --status "stopped"

cluster status

Options

Examples

• Show cluster status

proxcli cluster status

Cluster log

Options

Examples

• Show cluster log

proxcli cluster log

• Show errors searching in the last 1000 logs lines

proxcli cluster log --severities critical,error,warning --max-items 1000

High availibility

Definition

High Availability ensures that a VM will stay running even if an individual node is shut down. This means that if the device is either powered off or has any sort of issue, the VM will automatically migrate to another node and start there. This will use all nodes to ensure the VMs configured will stay running as close to 100% of the time as possible.

source: https://www.wundertech.net/how-to-set-up-a-cluster-in-proxmox/

Virtual machine HA in proxmox depend on two concepts:

• groups
• resources

An HA group is a logical configuration specifying on which nodes the vm can be migrated when a proxmox node fail. HA resouces is a virtual machine associated with an HA group. Several resources can be created and associated with a group.

List cluster nodes

Options

Examples

• List all cluster nodes

proxcli nodes list

Nodes Networks

Cluster storages

Show cluster nodes tasks

Options

Examples

• Show tasks on a list of proxmox nodes

proxcli nodes tasks --proxmox-nodes "pve1,pve2"

Show computed proxcli inventory

Options

Examples

• show computed inventory

proxcli inventory show

• show computed inventory with only virtual machine names starting by test

proxcli inventory show --filter-name "^test"

• show computed inventory with only virtual machine names starting by test and exclude production tag

proxcli inventory show --filter-name "^test" --exclude-tag "production"

Save proxcli inventory file

Options

Examples

• save a proxmox inventory file in yaml format

proxcli inventory create --path ./inventory.yaml

• save a proxmox inventory file in yaml format with host names matching regex “^test”

proxcli inventory create --path ./inventory.yaml --filter-name "^test"