### Setup WireGuard Fabric

Source: https://github.com/proxmox/pve-docs/blob/master/pvesdn.adoc

Creates a new WireGuard fabric named 'example' in Proxmox SDN.

```shell
# Configuration is done via the Proxmox GUI under Datacenter > SDN > Fabrics
```

--------------------------------

### Start qmeventd Service

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qmeventd.8-synopsis.adoc

Use this command to start the qmeventd service. Ensure the service is installed and configured.

```bash
systemctl start qmeventd
```

--------------------------------

### qm start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Starts a virtual machine.

```APIDOC
## qm start <vmid> [OPTIONS]

### Description
Start virtual machine.

### Method
POST

### Endpoint
`/vms/{vmid}/start`

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The (unique) ID of the VM (100 - 999999999).

#### Query Parameters
- **force-cpu** (string) - Optional - Override QEMU's -cpu argument with the given string.
- **machine** (string) - Optional - Specify the QEMU machine. Format: `[[type=<machine type>] [,aw-bits=<number>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]]`.
- **migratedfrom** (string) - Optional - The cluster node name.
- **migration_network** (string) - Optional - CIDR of the (sub) network that is used for migration.
- **migration_type** (string) - Optional - Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Allowed values: `insecure`, `secure`.
- **nets-host-mtu** (string) - Optional - Used for migration compat. List of VirtIO network devices and their effective host_mtu setting according to the QEMU object model on the source side of the migration. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. Format: `net\d+=\d+(,net\d+=\d+)*`.
- **skiplock** (boolean) - Optional - Ignore locks - only root is allowed to use this option.
- **stateuri** (string) - Optional - Some command save/restore state from this location.
- **targetstorage** (string) - Optional - Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
- **timeout** (integer) - Optional - Wait maximal timeout seconds (default: max(30, vm memory in GiB)).
- **with-conntrack-state** (boolean) - Optional - Whether to migrate conntrack entries for running VMs (default: 0).
```

--------------------------------

### Start VM using Standard Command

Source: https://github.com/proxmox/pve-docs/blob/master/ha-manager.adoc

Starting a VM with `qm start` automatically updates its requested state in the HA stack.

```bash
# qm start 100
```

--------------------------------

### Resource Affinity Rules Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/ha-manager.adoc

Example configuration file content for resource affinity rules, demonstrating 'keep-together' and 'keep-separate' setups.

```text
resource-affinity: keep-together
        resources vm:100,vm:200
        affinity positive

resource-affinity: keep-separate
        resources vm:200,ct:300
        affinity negative
```

--------------------------------

### pvedaemon start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pvedaemon.8-synopsis.adoc

Start the daemon.

```APIDOC
## pvedaemon start

### Description
Start the daemon.

### Method
CLI

### Endpoint
pvedaemon start [OPTIONS]

### Parameters
#### Query Parameters
- **--debug** (boolean) - Optional - Debug mode - stay in foreground (default: 0)
```

--------------------------------

### Start a Virtual Machine

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Starts a virtual machine with the specified ID.

```bash
# qm start 300
```

--------------------------------

### pveproxy start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pveproxy.8-synopsis.adoc

Starts the pveproxy daemon.

```APIDOC
## pveproxy start

### Description
Start the daemon.

### Parameters
#### Options
- **--debug** (boolean) - Optional - Debug mode - stay in foreground (default = 0)
```

--------------------------------

### Enable VM Start at Boot

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Configures a virtual machine to start automatically when the host system boots.

```bash
qm set <vmid> -start at boot=1
```

--------------------------------

### Install Cloud-Init on Debian/Ubuntu

Source: https://github.com/proxmox/pve-docs/blob/master/qm-cloud-init.adoc

Install the Cloud-Init package inside the guest VM to enable initialization support.

```bash
apt-get install cloud-init
```

--------------------------------

### Start a virtual machine

Source: https://github.com/proxmox/pve-docs/blob/master/pvesr.adoc

Command to start a specific virtual machine by its ID.

```bash
# pct start 200
```

--------------------------------

### Start All VMs and Containers on a Node

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pvenode.1-synopsis.adoc

Starts all VMs and containers on the specified node. Optionally, it can force the start command even if 'onboot' is not set or issue a start command for specific VMs.

```bash
pvenode startall [OPTIONS]

```

```bash
pvenode startall --force 1

```

```bash
pvenode startall --vms "100,101"

```

--------------------------------

### pvestatd start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pvestatd.8-synopsis.adoc

Starts the pvestatd daemon.

```APIDOC
## pvestatd start

### Description
Start the daemon.

### Parameters
#### Options
- **--debug** (boolean) - Optional - Debug mode - stay in foreground (default: 0)
```

--------------------------------

### Example VM Configuration File

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

An example of a virtual machine configuration file format. These files are stored in /etc/pve/qemu-server/<VMID>.conf and use a colon-separated key/value format.

```text
boot: order=virtio0;net0
cores: 1
sockets: 1
memory: 512
name: webmail
ostype: l26
net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0
virtio0: local:vm-100-disk-1,size=32G
```

--------------------------------

### pvecm qdevice setup

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pvecm.1-synopsis.adoc

Setup the use of a QDevice

```APIDOC
## pvecm qdevice setup

### Description
Setup the use of a QDevice

### Method
CLI Command

### Endpoint
pvecm qdevice setup `<address>` `[OPTIONS]`

### Parameters
#### Path Parameters
- **address** (string) - Required - Specifies the network address of an external corosync QDevice

#### Query Parameters
- **--force** (boolean) - Optional - Do not throw error on possible dangerous operations.
- **--network** (string) - Optional - The network which should be used to connect to the external qdevice

### Request Example
```
pvecm qdevice setup corosync-qdevice.example.com --network net0
```

### Response
(No specific success response fields detailed in the source.)

### Error Handling
(No specific error handling details provided in the source.)
```

--------------------------------

### Corosync Configuration File Example (Before Change)

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

This is an example of the corosync.conf file before modifying network addresses. Note the 'ring0_addr' properties.

```text
logging {
  debug: off
  to_syslog: yes
}

nodelist {

  node {
    name: due
    nodeid: 2
    quorum_votes: 1
    ring0_addr: due
  }

  node {
    name: tre
    nodeid: 3
    quorum_votes: 1
    ring0_addr: tre
  }

  node {
    name: uno
    nodeid: 1
    quorum_votes: 1
    ring0_addr: uno
  }

}

quorum {
  provider: corosync_votequorum
}

totem {
  cluster_name: testcluster
  config_version: 3
  ip_version: ipv4-6
  secauth: on
  version: 2
  interface {
    linknumber: 0
  }

}
```

--------------------------------

### Example Container Configuration File

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

This is an example of a container configuration file found at '/etc/pve/lxc/<CTID>.conf'. It defines parameters like OS type, hostname, memory, network, and root filesystem.

```text
ostype: debian
arch: amd64
hostname: www
memory: 512
swap: 512
net0: bridge=vmbr0,hwaddr=66:64:66:64:64:36,ip=dhcp,name=eth0,type=veth
rootfs: local:107/vm-107-disk-1.raw,size=7G
```

--------------------------------

### Corosync Configuration File Example (After Change)

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

This is an example of the corosync.conf file after updating 'ring0_addr' properties to new IP addresses and incrementing 'config_version'.

```text
logging {
  debug: off
  to_syslog: yes
}

nodelist {

  node {
    name: due
    nodeid: 2
    quorum_votes: 1
    ring0_addr: 10.10.10.2
  }

  node {
    name: tre
    nodeid: 3
    quorum_votes: 1
    ring0_addr: 10.10.10.3
  }

  node {
    name: uno
    nodeid: 1
    quorum_votes: 1
    ring0_addr: 10.10.10.1
  }

}

quorum {
  provider: corosync_votequorum
}

totem {
  cluster_name: testcluster
  config_version: 4
  ip_version: ipv4-6
  secauth: on
  version: 2
  interface {
    linknumber: 0
  }

}
```

--------------------------------

### Setup QDevice on Proxmox VE Node

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

Initiates the QDevice setup on one of the Proxmox VE nodes, connecting it to the external QDevice IP address. This command automatically copies SSH keys and configures the QDevice.

```bash
pvecm qdevice setup <QDEVICE-IP>
```

--------------------------------

### Node Affinity Rules Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/ha-manager.adoc

Example configuration file content showing defined node affinity rules.

```text
node-affinity: ha-rule-vm100
        resources vm:100
        nodes node1
        strict 1

node-affinity: priority-cascade
        resources vm:200,ct:300
        nodes node1:2,node2:1,node3:1,node4
```

--------------------------------

### Set VM Boot Order

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Configure the start and shutdown order for a virtual machine. Set to '1' for the first VM to start. VMs without this parameter start after those with it. This is enforced per host, not cluster-wide.

```bash
qm set <vmid> -onboot 1
```

--------------------------------

### Install corosync-qdevice Package

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

Installs the corosync-qdevice package on all Proxmox VE cluster nodes.

```bash
apt install corosync-qdevice
```

--------------------------------

### Install corosync-qnetd Package

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

Installs the corosync-qnetd package on the external server, which is required for the QDevice arbitrator.

```bash
apt install corosync-qnetd
```

--------------------------------

### LVM Storage Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-storage-lvm.adoc

Example of how to configure an LVM storage backend in `/etc/pve/storage.cfg`. Specifies the volume group name and content types.

```config
lvm: myspace
	vgname myspace
	content rootdir,images
```

--------------------------------

### Start Container with lxc-start and Debug Log

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

Use 'lxc-start' with specific flags to run a container in foreground mode and save debug logs to a specified file. This is an alternative to 'pct start --debug'.

```bash
# lxc-start -n CTID -F -l DEBUG -o /tmp/lxc-CTID.log
```

--------------------------------

### CIFS Storage Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-storage-cifs.adoc

Example configuration for a CIFS storage backend in `/etc/pve/storage.cfg`. Ensure to replace placeholders with your specific server, share, and username details. The `options` field allows for additional CIFS mount options.

```shell
cifs: backup
	path /mnt/pve/backup
	server 10.0.0.11
	share VMData
	content backup
	options noserverino,echo_interval=30
	username anna
	smbversion 3
	subdir /data
```

--------------------------------

### ZFS Pool Storage Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-storage-zfspool.adoc

Example configuration for a ZFS pool storage backend in `/etc/pve/storage.cfg`. Specifies the ZFS pool, content types, and enables sparse volumes for thin-provisioning.

```shell
zfspool: vmdata
        pool tank/vmdata
        content rootdir,images
        sparse
```

--------------------------------

### Start Proxmox VE HA Simulator

Source: https://github.com/proxmox/pve-docs/blob/master/ha-manager.adoc

Start the HA simulator by passing the created working directory as a parameter. This command initiates the simulation environment.

```bash
pve-ha-simulator working/
```

--------------------------------

### Start a virtual machine

Source: https://github.com/proxmox/pve-docs/blob/master/pvesr.adoc

Initiate the startup process for a specific virtual machine.

```bash
# qm start 100
```

--------------------------------

### Install Suricata and Load Kernel Module

Source: https://github.com/proxmox/pve-docs/blob/master/pve-firewall.adoc

Install the Suricata IPS package and load the nfnetlink_queue kernel module. Ensure nfnetlink_queue is added to /etc/modules for persistence across reboots.

```bash
# apt-get install suricata
# modprobe nfnetlink_queue
```

--------------------------------

### CephFS External Cluster Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-storage-cephfs.adoc

Example configuration for an external Ceph cluster in `/etc/pve/storage.cfg`. Ensure Ceph client packages are correctly installed.

```prolog
cephfs: cephfs-external
        monhost 10.1.1.20 10.1.1.21 10.1.1.22
        path /mnt/pve/cephfs-external
        content backup
        username admin
        fs-name cephfs
```

--------------------------------

### InfluxDB UDP Configuration Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-external-metric-server.adoc

Example configuration for receiving metric data via UDP in InfluxDB. This setup listens on all interfaces and writes to the 'proxmox' database.

```ini
[udp]
   enabled = true
   bind-address = "0.0.0.0:8089"
   database = "proxmox"
   batch-size = 1000
   batch-timeout = "1s"
```

--------------------------------

### qm guest exec-status

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Gets the status of a process ID (PID) that was started by the guest agent.

```APIDOC
## qm guest exec-status

### Description
Gets the status of a process ID (PID) that was started by the guest agent.

### Method
`qm guest exec-status`

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The unique ID of the VM.
- **pid** (integer) - Required - The PID to query.
```

--------------------------------

### Prepare Cloud-Init VM Image

Source: https://github.com/proxmox/pve-docs/blob/master/qm-cloud-init.adoc

Download a cloud image and create a new VM with the necessary hardware configuration.

```bash
# download the image
wget https://cloud-images.ubuntu.com/bionic/current/bionic-server-cloudimg-amd64.img

# create a new VM with VirtIO SCSI controller
qm create 9000 --memory 2048 --net0 virtio,bridge=vmbr0 --scsihw virtio-scsi-pci
```

--------------------------------

### Configure routed network

Source: https://github.com/proxmox/pve-docs/blob/master/pve-network.adoc

Example /etc/network/interfaces configuration for a routed setup to avoid MAC address restrictions.

```text
auto lo
iface lo inet loopback

auto eno0
iface eno0 inet static
        address  198.51.100.5/29
        gateway  198.51.100.1
        post-up echo 1 > /proc/sys/net/ipv4/ip_forward
        post-up echo 1 > /proc/sys/net/ipv4/conf/eno0/proxy_arp


auto vmbr0
iface vmbr0 inet static
        address  203.0.113.17/28
        bridge-ports none
        bridge-stp off
        bridge-fd 0
```

--------------------------------

### Live Import Configuration

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Immediately starts the virtual machine and copies the data in the background.

```APIDOC
## --live-import

### Description
Immediately start the VM and copy the data in the background.

### Parameters
#### Request Body
- **boolean** (boolean) - Optional - '1' to enable, '0' to disable. Defaults to '0'.
```

--------------------------------

### Configure default bridge network

Source: https://github.com/proxmox/pve-docs/blob/master/pve-network.adoc

Example /etc/network/interfaces configuration for a standard bridged setup using vmbr0.

```text
auto lo
iface lo inet loopback

iface eno1 inet manual

auto vmbr0
iface vmbr0 inet static
        address 192.168.10.2/24
        gateway 192.168.10.1
        bridge-ports eno1
        bridge-stp off
        bridge-fd 0
```

--------------------------------

### qm showcmd

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Displays the command line used to start a virtual machine, useful for debugging purposes.

```APIDOC
## qm showcmd <vmid> [OPTIONS]

### Description
Show command line which is used to start the VM (debug info).

### Method
GET (or equivalent for CLI)

### Endpoint
`/vms/{vmid}/showcmd` (Conceptual representation)

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The (unique) ID of the VM (100 - 999999999).

#### Query Parameters
- **pretty** (boolean) - Optional - Puts each option on a new line to enhance human readability (default: 0).
- **snapshot** (string) - Optional - Fetch config values from given snapshot.
```

--------------------------------

### Corosync Quorum Error Message

Source: https://github.com/proxmox/pve-docs/blob/master/pvecm.adoc

This is an example of an error message that may appear in the system log when corosync starts to fail due to quorum issues. It indicates that corosync_votequorum failed to initialize.

```text
...
corosync[1647]:  [QUORUM] Quorum provider: corosync_votequorum failed to initialize.
...
```

--------------------------------

### Check ZFS Pool Status

Source: https://github.com/proxmox/pve-docs/blob/master/local-zfs.adoc

Use the `zpool status` command to view the health and configuration of your ZFS pools after installation. This example shows a pool named `rpool` with a mirrored configuration.

```shell
# zpool status
  pool: rpool
 state: ONLINE
  scan: none requested
config:
	NAME        STATE     READ WRITE CKSUM
	rpool       ONLINE       0     0     0
	  mirror-0  ONLINE       0     0     0
	    sda2    ONLINE       0     0     0
	    sdb2    ONLINE       0     0     0
	  mirror-1  ONLINE       0     0     0
	    sdc     ONLINE       0     0     0
	    sdd     ONLINE       0     0     0

errors: No known data errors
```

--------------------------------

### Default LVM-Thin Storage Configuration

Source: https://github.com/proxmox/pve-docs/blob/master/pvesm.adoc

Example of a default LVM-thin storage pool, typically used for root directories and images on LVM-based installations. It defines the thin pool name, volume group, and content types.

```config
lvmthin: local-lvm
	thinpool data
	vgname pve
	content rootdir,images
```

--------------------------------

### On Boot Configuration

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Specifies whether the virtual machine will be automatically started during system bootup.

```APIDOC
## --onboot

### Description
Specifies whether a VM will be started during system bootup.

### Parameters
#### Request Body
- **boolean** (boolean) - Optional - '1' to enable auto-start, '0' to disable. Defaults to '0'.
```

--------------------------------

### Install VirGL Support Libraries

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Install necessary libraries for VirGL (virtio-gl) support. These are not installed by default due to their size and licensing.

```bash
apt install libgl1 libegl1
```

--------------------------------

### qm create

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Creates or restores a virtual machine.

```APIDOC
## qm create

### Description
Create or restore a virtual machine.

### Method
CLI

### Endpoint
qm create <vmid> [OPTIONS]

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The (unique) ID of the VM.

#### Query Parameters
- **acpi** (boolean) - Optional - Enable/disable ACPI. Defaults to 1.
- **affinity** (string) - Optional - List of host cores used to execute guest processes, for example: 0,5,8-11.
- **agent** (string) - Optional - Enable/disable communication with the QEMU Guest Agent and its properties. Format: enabled=<1|0> [,freeze-fs=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>].
- **allow-ksm** (boolean) - Optional - Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). Defaults to 1.
- **amd-sev** (string) - Optional - Secure Encrypted Virtualization (SEV) features by AMD CPUs. Format: [type=<sev-type>] [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>].
- **arch** (string) - Optional - Virtual processor architecture. Defaults to the host architecture.
- **archive** (string) - Optional - The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.
- **args** (string) - Optional - Arbitrary arguments passed to kvm.
- **audio0** (string) - Optional - Configure a audio device, useful in combination with QXL/Spice. Format: device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>].
- **autostart** (boolean) - Optional - Automatic restart after crash (currently ignored). Defaults to 0.
- **balloon** (integer) - Optional - Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero.
- **bios** (string) - Optional - Select BIOS implementation. Defaults to seabios.
- **boot** (string) - Optional - Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. Format: [[legacy=<[acdn]{1,4}>] [,order=<device[;device...]>]].
- **bootdisk** (string) - Optional - Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
- **bwlimit** (integer) - Optional - Override I/O bandwidth limit (in KiB/s). Defaults to restore limit from datacenter or storage config.
- **cdrom** (string) - Optional - This is an alias for option -ide2.
- **cicustom** (string) - Optional - cloud-init: Specify custom files to replace the automatically generated ones at start. Format: [meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>].
```

--------------------------------

### pveceph install

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pveceph.1-synopsis.adoc

Installs Ceph-related packages.

```APIDOC
## pveceph install

### Description
Install ceph related packages.

### Command
pveceph install [OPTIONS]

### Options
#### --allow-experimental (boolean)
- Optional
- Allow experimental versions. Use with care!
- Default: `0`

#### --repository (enterprise | manual | no-subscription | test)
- Optional
- Ceph repository to use. The 'manual' option will not configure any repositories. Use it if the host cannot access the public repositories, for example if Proxmox Offline Mirror is used. A repository that contains the Ceph packages for the version needs to be manually configured before starting the installation!
- Default: `enterprise`

#### --version (squid | tentacle)
- Optional
- Ceph version to install.
- Default: `tentacle`
```

--------------------------------

### Create a New Virtual Machine

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Creates a new virtual machine with specified parameters, including IDE disk and network configuration, using an ISO file for installation.

```bash
# qm create 300 -ide0 local-lvm:4 -net0 e1000 -cdrom local:iso/proxmox-mailgateway_2.1.iso
```

--------------------------------

### Install Proxmox VE on Debian

Source: https://github.com/proxmox/pve-docs/blob/master/pve-installation.adoc

Install Proxmox VE as a set of Debian packages on top of a standard Debian installation. Ensure repositories are configured first.

```bash
# apt-get update
# apt-get install proxmox-ve
```

--------------------------------

### pve-firewall start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pve-firewall.8-synopsis.adoc

Starts the Proxmox VE firewall service.

```APIDOC
## pve-firewall start

### Description
Start the Proxmox VE firewall service.

### Method
CLI

### Endpoint
pve-firewall start `[OPTIONS]`

### Parameters
#### Query Parameters
- **--debug** (boolean) - Optional - Debug mode - stay in foreground (default = `0`)
```

--------------------------------

### VM Configuration with Snapshot

Source: https://github.com/proxmox/pve-docs/blob/master/qm.adoc

Illustrates the structure of a VM configuration file after a snapshot is created, showing original and snapshot-specific sections.

```text
memory: 512
swap: 512
parent: testsnaphot
...

[testsnaphot]
memory: 512
swap: 512
snaptime: 1457170803
...
```

--------------------------------

### Ensure ifupdown2 is Installed

Source: https://github.com/proxmox/pve-docs/blob/master/pvesdn.adoc

Verify or install the 'ifupdown2' package, which is required for network configuration management in Proxmox VE 7.0 and above. This package is installed by default on newer versions.

```bash
apt update
apt install ifupdown2
```

--------------------------------

### Initialize proxmox-boot-tool for GRUB

Source: https://github.com/proxmox/pve-docs/blob/master/system-booting.adoc

This command initializes the proxmox-boot-tool to set up GRUB for booting via a specified EFI system partition (ESP). Replace '/dev/sda2' with the actual device path of your ESP.

```bash
# proxmox-boot-tool init /dev/sda2 grub

```

--------------------------------

### Start Container with Debugging Output

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

Enable detailed debugging output when starting a container by adding the '--debug' flag to 'pct start'. Replace 'CTID' with the actual container ID.

```bash
# pct start CTID --debug
```

--------------------------------

### Configure Container Startup at Boot

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

Enables automatic container startup when the host system boots.

```bash
# pct set CTID -onboot 1
```

--------------------------------

### spiceproxy start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/spiceproxy.8-synopsis.adoc

Start the spiceproxy daemon. Supports a debug mode option.

```APIDOC
## spiceproxy start

### Description
Start the daemon.

### Method
CLI

### Endpoint
spiceproxy start [OPTIONS]

### Parameters
#### Query Parameters
- **--debug** (boolean) - Optional - Debug mode - stay in foreground. Defaults to 0.

### Request Example
```
spiceproxy start --debug
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the start operation.

#### Response Example
```json
{
  "status": "started"
}
```
```

--------------------------------

### Configure Container CPU Limits

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

Example configuration for setting CPU cores and limiting overall CPU consumption.

```text
cores: 2
cpulimit: 0.5
```

--------------------------------

### Firewall Rules Syntax Example

Source: https://github.com/proxmox/pve-docs/blob/master/pve-firewall.adoc

Demonstrates the basic syntax for defining firewall rules, including directions, actions, and comments.

```firewall
[RULES]

DIRECTION ACTION [OPTIONS]
|DIRECTION ACTION [OPTIONS] # disabled rule

DIRECTION MACRO(ACTION) [OPTIONS] # use predefined macro
```

--------------------------------

### pve-ha-crm start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pve-ha-crm.8-synopsis.adoc

Start the High Availability Cluster Resource Manager daemon.

```APIDOC
## pve-ha-crm start

### Description
Start the daemon.

### Method
CLI

### Endpoint
pve-ha-crm start [OPTIONS]

### Parameters
#### Query Parameters
- **--debug** (boolean) - Optional - Debug mode - stay in foreground. Defaults to '0'.

### Request Example
```
pve-ha-crm start --debug 1
```

### Response
#### Success Response (200)
- **status** (string) - Indicates if the daemon started successfully.
```

--------------------------------

### Configure Cloudbase-Init Disk and Create Template

Source: https://github.com/proxmox/pve-docs/blob/master/qm-cloud-init.adoc

Add a Cloud-Init disk to a VM and then convert it into a template for future use. Ensure the VM is shut down before performing these actions.

```bash
qm set 9000 --ide2 local-lvm:cloudinit
```

```bash
qm template 9000
```

--------------------------------

### Install ifupdown2

Source: https://github.com/proxmox/pve-docs/blob/master/pve-network.adoc

Command to install the ifupdown2 package, which is required for live-reloading network configurations.

```bash
apt install ifupdown2
```

--------------------------------

### Configure Root Filesystem

Source: https://github.com/proxmox/pve-docs/blob/master/pct.adoc

Example of a typical rootfs configuration for a container.

```text
rootfs: thin1:base-100-disk-1,size=8G
```

--------------------------------

### Configure Proxmox Backup Server Storage

Source: https://github.com/proxmox/pve-docs/blob/master/pve-storage-pbs.adoc

Example configuration block for /etc/pve/storage.cfg defining a PBS storage backend.

```text
pbs: backup
        datastore main
        server enya.proxmox.com
        content backup
        fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
        prune-backups keep-all=1
        username archiver@pbs
        encryption-key a9:ee:c8:02:13:..snip..:2d:53:2c:98
        master-pubkey 1
```

--------------------------------

### pct start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pct.1-synopsis.adoc

Starts a container. Optionally, debug logging can be enabled during startup, and locks can be ignored.

```APIDOC
## pct start <vmid> [OPTIONS]

### Description
Start the container.

### Method
N/A (CLI command)

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The (unique) ID of the VM.

#### Query Parameters
- **debug** (boolean) - Optional - If set, enables very verbose debug log-level on start. Defaults to 0.
- **skiplock** (boolean) - Optional - Ignore locks - only root is allowed to use this option.
```

--------------------------------

### pvescheduler start

Source: https://github.com/proxmox/pve-docs/blob/master/generated/pvescheduler.8-synopsis.adoc

Start the scheduler daemon. Supports a --debug option to run in the foreground.

```APIDOC
## pvescheduler start

### Description
Start the daemon.

### Method
CLI

### Endpoint
pvescheduler start [OPTIONS]

### Parameters
#### Query Parameters
- **--debug** (boolean) - Optional - Debug mode - stay in foreground (default: 0)

### Request Example
```
pvescheduler start --debug
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
```

--------------------------------

### qm cloudinit dump

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Retrieves automatically generated cloud-init configuration.

```APIDOC
## qm cloudinit dump

### Description
Get automatically generated cloudinit config.

### Method
CLI

### Endpoint
qm cloudinit dump <vmid> <type>

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The (unique) ID of the VM.
- **type** (string) - Required - Config type: meta, network, or user.
```

--------------------------------

### Install proxmox-firewall Package

Source: https://github.com/proxmox/pve-docs/blob/master/pve-firewall.adoc

Installs the nftables-based firewall package. This is the first step to enable the proxmox-firewall.

```bash
apt install proxmox-firewall
```

--------------------------------

### Start VM Backup with Fleecing

Source: https://github.com/proxmox/pve-docs/blob/master/vzdump.adoc

Initiates a manual backup for a specific VM using a designated storage for fleecing images.

```bash
vzdump 123 --fleecing enabled=1,storage=local-lvm
```

--------------------------------

### Enable Live VM Import and Background Data Copy

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Immediately start the VM and copy the data in the background. Defaults to disabled.

```bash
--live-import 1
```

--------------------------------

### Install Suricata IPS

Source: https://github.com/proxmox/pve-docs/blob/master/pve-firewall.adoc

Installs the Suricata Intrusion Prevention System package on the Proxmox host.

```bash
apt install suricata
```

--------------------------------

### Markdown Unordered List Example

Source: https://github.com/proxmox/pve-docs/blob/master/markdown-primer.adoc

Provides an example of creating an unordered list using asterisks.

```markdown
* Item 1
* Item 2
* Item 2a
* Item 2b
```

--------------------------------

### Enable VM Boot on System Startup

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Specifies whether a VM will be automatically started during system bootup. Defaults to disabled.

```bash
--onboot 1
```

--------------------------------

### qm guest cmd

Source: https://github.com/proxmox/pve-docs/blob/master/generated/qm.1-synopsis.adoc

Executes QEMU Guest Agent commands within a virtual machine.

```APIDOC
## qm guest cmd

### Description
Executes QEMU Guest Agent commands within a virtual machine.

### Method
`qm guest cmd`

### Parameters
#### Path Parameters
- **vmid** (integer) - Required - The unique ID of the VM.
- **command** (string) - Required - The QGA command to execute. Supported commands include fsfreeze-freeze, fsfreeze-status, fsfreeze-thaw, fstrim, get-fsinfo, get-host-name, get-memory-block-info, get-memory-blocks, get-osinfo, get-time, get-timezone, get-users, get-vcpus, info, network-get-interfaces, ping, shutdown, suspend-disk, suspend-hybrid, suspend-ram.
```

--------------------------------

### LDAP User Entry Example

Source: https://github.com/proxmox/pve-docs/blob/master/pveum.adoc

An example of a user entry in an LDAP directory, showing the structure and attributes.

```ldif
dn: uid=user1,ou=People,dc=ldap-test,dc=com
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
uid: user1
cn: Test User 1
sn: Testers
description: This is the first test user.
```