Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-11-28 00:23:44 +03:00
Code Releases Activity

update generated cli synopsis files

Browse Source 
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Link: https://lore.proxmox.com/20250812095637.444463-6-c.heiss@proxmox.com
This commit is contained in:
Christoph Heiss
2025-08-12 11:56:29 +02:00
committed by Thomas Lamprecht
parent 33550ee942
commit 60d2f90743
22 changed files with 360 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
ha-manager.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_ha-manager]]
*ha-manager* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_ha-manager_add]]
*ha-manager add* `<sid>` `[OPTIONS]`
Create a new HA resource.
@@ -36,6 +38,7 @@ Requested resource state.
Resource type.
[[cli_ha-manager_config]]
*ha-manager config* `[OPTIONS]`
List HA resources.
@@ -44,6 +47,7 @@ List HA resources.
Only list resources of specific type
[[cli_ha-manager_crm-command_migrate]]
*ha-manager crm-command migrate* `<sid> <node>`
Request resource migration (online) to another node.
@@ -56,6 +60,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
Target node.
[[cli_ha-manager_crm-command_node-maintenance_disable]]
*ha-manager crm-command node-maintenance disable* `<node>`
Change the node-maintenance request state.
@@ -64,6 +69,7 @@ Change the node-maintenance request state.
The cluster node name.
[[cli_ha-manager_crm-command_node-maintenance_enable]]
*ha-manager crm-command node-maintenance enable* `<node>`
Change the node-maintenance request state.
@@ -72,6 +78,7 @@ Change the node-maintenance request state.
The cluster node name.
[[cli_ha-manager_crm-command_relocate]]
*ha-manager crm-command relocate* `<sid> <node>`
Request resource relocatzion to another node. This stops the service on the
@@ -85,6 +92,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
Target node.
[[cli_ha-manager_crm-command_stop]]
*ha-manager crm-command stop* `<sid> <timeout>`
Request the service to be stopped.
@@ -97,6 +105,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
Timeout in seconds. If set to 0 a hard stop will be performed.
[[cli_ha-manager_groupadd]]
*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
Create a new HA group. (deprecated in favor of HA rules)
@@ -125,10 +134,12 @@ Resources bound to restricted groups may only run on nodes defined by the group.
Group type.
[[cli_ha-manager_groupconfig]]
*ha-manager groupconfig*
Get HA groups. (deprecated in favor of HA rules)
[[cli_ha-manager_groupremove]]
*ha-manager groupremove* `<group>`
Delete ha group configuration. (deprecated in favor of HA rules)
@@ -137,6 +148,7 @@ Delete ha group configuration. (deprecated in favor of HA rules)
The HA group identifier.
[[cli_ha-manager_groupset]]
*ha-manager groupset* `<group>` `[OPTIONS]`
Update ha group configuration. (deprecated in favor of HA rules)
@@ -169,6 +181,7 @@ The CRM tries to run services on the node with the highest priority. If a node w
Resources bound to restricted groups may only run on nodes defined by the group.
[[cli_ha-manager_help]]
*ha-manager help* `[OPTIONS]`
Get help about specified command.
@@ -181,14 +194,17 @@ Shows help for a specific command
Verbose output format.
[[cli_ha-manager_migrate]]
*ha-manager migrate*
An alias for 'ha-manager crm-command migrate'.
[[cli_ha-manager_relocate]]
*ha-manager relocate*
An alias for 'ha-manager crm-command relocate'.
[[cli_ha-manager_remove]]
*ha-manager remove* `<sid>`
Delete resource configuration.
@@ -197,6 +213,7 @@ Delete resource configuration.
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
[[cli_ha-manager_rules_add]]
*ha-manager rules add* `<type> <rule> --resources <string>` `[OPTIONS]`
Create HA rule.
@@ -242,6 +259,7 @@ Describes whether the node affinity rule is strict or non-strict.
Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative').
[[cli_ha-manager_rules_config]]
*ha-manager rules config* `[OPTIONS]` `[FORMAT_OPTIONS]`
Get HA rules.
@@ -254,6 +272,7 @@ Limit the returned list to rules affecting the specified resource.
Limit the returned list to the specified rule type.
[[cli_ha-manager_rules_list]]
*ha-manager rules list* `[OPTIONS]` `[FORMAT_OPTIONS]`
Get HA rules.
@@ -266,6 +285,7 @@ Limit the returned list to rules affecting the specified resource.
Limit the returned list to the specified rule type.
[[cli_ha-manager_rules_remove]]
*ha-manager rules remove* `<rule>`
Delete HA rule.
@@ -274,6 +294,7 @@ Delete HA rule.
HA rule identifier.
[[cli_ha-manager_rules_set]]
*ha-manager rules set* `<type> <rule>` `[OPTIONS]`
Update HA rule.
@@ -327,6 +348,7 @@ Describes whether the node affinity rule is strict or non-strict.
Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative').
[[cli_ha-manager_set]]
*ha-manager set* `<sid>` `[OPTIONS]`
Update resource configuration.
@@ -367,6 +389,7 @@ Maximal number of tries to restart the service on a node after its start failed.
Requested resource state.
[[cli_ha-manager_status]]
*ha-manager status* `[OPTIONS]`
Display HA manger status.

40
pct.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pct]]
*pct* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pct_clone]]
*pct clone* `<vmid> <newid>` `[OPTIONS]`
Create a container clone/copy
@@ -44,6 +46,7 @@ Target storage for full clone.
Target node. Only allowed if the original VM is on shared storage.
[[cli_pct_config]]
*pct config* `<vmid>` `[OPTIONS]`
Get container configuration.
@@ -60,6 +63,7 @@ Get current values (instead of pending values).
Fetch config values from given snapshot.
[[cli_pct_console]]
*pct console* `<vmid>` `[OPTIONS]`
Launch a console for the specified container.
@@ -72,10 +76,12 @@ The (unique) ID of the VM.
Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
[[cli_pct_cpusets]]
*pct cpusets*
Print the list of assigned CPU sets.
[[cli_pct_create]]
*pct create* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
@@ -252,6 +258,7 @@ Makes the container run as unprivileged user. (Should not be modified manually.)
Reference to unused volumes. This is used internally, and should not be modified manually.
[[cli_pct_delsnapshot]]
*pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
Delete a LXC snapshot.
@@ -268,6 +275,7 @@ The name of the snapshot.
For removal from config file, even if removing disk snapshots fails.
[[cli_pct_destroy]]
*pct destroy* `<vmid>` `[OPTIONS]`
Destroy the container (also delete all uses files).
@@ -288,6 +296,7 @@ Force destroy, even if running.
Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
[[cli_pct_df]]
*pct df* `<vmid>`
Get the container's current disk usage.
@@ -296,6 +305,7 @@ Get the container's current disk usage.
The (unique) ID of the VM.
[[cli_pct_enter]]
*pct enter* `<vmid>` `[OPTIONS]`
Launch a shell for the specified container.
@@ -308,6 +318,7 @@ The (unique) ID of the VM.
Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
[[cli_pct_exec]]
*pct exec* `<vmid> [<extra-args>]` `[OPTIONS]`
Launch a command inside the specified container.
@@ -324,6 +335,7 @@ Extra arguments as array
Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
[[cli_pct_fsck]]
*pct fsck* `<vmid>` `[OPTIONS]`
Run a filesystem check (fsck) on a container volume.
@@ -340,6 +352,7 @@ A volume on which to run the filesystem check
Force checking, even if the filesystem seems clean
[[cli_pct_fstrim]]
*pct fstrim* `<vmid>` `[OPTIONS]`
Run fstrim on a chosen CT and its mountpoints, except bind or read-only
@@ -353,6 +366,7 @@ The (unique) ID of the VM.
Skip all mountpoints, only do fstrim on the container root.
[[cli_pct_help]]
*pct help* `[OPTIONS]`
Get help about specified command.
@@ -365,10 +379,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pct_list]]
*pct list*
LXC container index (per node).
[[cli_pct_listsnapshot]]
*pct listsnapshot* `<vmid>`
List all snapshots.
@@ -377,6 +393,7 @@ List all snapshots.
The (unique) ID of the VM.
[[cli_pct_migrate]]
*pct migrate* `<vmid> <target>` `[OPTIONS]`
Migrate the container to another node. Creates a new migration task.
@@ -409,6 +426,7 @@ Mapping from source to target storages. Providing only a single storage ID maps
Timeout in seconds for shutdown for restart migration
[[cli_pct_mount]]
*pct mount* `<vmid>`
Mount the container's filesystem on the host. This will hold a lock on the
@@ -419,6 +437,7 @@ further operations on the container other than start and stop.
The (unique) ID of the VM.
[[cli_pct_move-volume]]
*pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
Move a rootfs-/mp-volume to a different storage or to a different
@@ -463,10 +482,12 @@ Prevent changes if current configuration file of the target " .
"container has a different SHA1 digest. This can be used to prevent " .
"concurrent modifications.
[[cli_pct_move_volume]]
*pct move_volume*
An alias for 'pct move-volume'.
[[cli_pct_pending]]
*pct pending* `<vmid>`
Get container configuration, including pending changes.
@@ -475,6 +496,7 @@ Get container configuration, including pending changes.
The (unique) ID of the VM.
[[cli_pct_pull]]
*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
Copy a file from the container to the local system.
@@ -503,6 +525,7 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
Owner user name or id.
[[cli_pct_push]]
*pct push* `<vmid> <file> <destination>` `[OPTIONS]`
Copy a local file to the container.
@@ -531,6 +554,7 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
Owner user name or id. When using a name it must exist inside the container.
[[cli_pct_reboot]]
*pct reboot* `<vmid>` `[OPTIONS]`
Reboot the container by shutting it down, and starting it again. Applies
@@ -544,6 +568,7 @@ The (unique) ID of the VM.
Wait maximal timeout seconds for the shutdown.
[[cli_pct_remote-migrate]]
*pct remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
Migrate container to a remote cluster. Creates a new migration task.
@@ -589,6 +614,7 @@ Mapping from source to target storages. Providing only a single storage ID maps
Timeout in seconds for shutdown for restart migration
[[cli_pct_rescan]]
*pct rescan* `[OPTIONS]`
Rescan all storages and update disk sizes and unused disk images.
@@ -601,6 +627,7 @@ Do not actually write changes to the configuration.
The (unique) ID of the VM.
[[cli_pct_resize]]
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
Resize a container mount point.
@@ -621,6 +648,7 @@ The new size. With the '+' sign the value is added to the actual size of the vol
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
[[cli_pct_restore]]
*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
@@ -793,6 +821,7 @@ Makes the container run as unprivileged user. (Should not be modified manually.)
Reference to unused volumes. This is used internally, and should not be modified manually.
[[cli_pct_resume]]
*pct resume* `<vmid>`
Resume the container.
@@ -801,6 +830,7 @@ Resume the container.
The (unique) ID of the VM.
[[cli_pct_rollback]]
*pct rollback* `<vmid> <snapname>` `[OPTIONS]`
Rollback LXC state to specified snapshot.
@@ -817,6 +847,7 @@ The name of the snapshot.
Whether the container should get started after rolling back successfully
[[cli_pct_set]]
*pct set* `<vmid>` `[OPTIONS]`
Set container options.
@@ -959,6 +990,7 @@ Makes the container run as unprivileged user. (Should not be modified manually.)
Reference to unused volumes. This is used internally, and should not be modified manually.
[[cli_pct_shutdown]]
*pct shutdown* `<vmid>` `[OPTIONS]`
Shutdown the container. This will trigger a clean shutdown of the
@@ -976,6 +1008,7 @@ Make sure the Container stops.
Wait maximal timeout seconds.
[[cli_pct_snapshot]]
*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
Snapshot a container.
@@ -992,6 +1025,7 @@ The name of the snapshot.
A textual description or comment.
[[cli_pct_start]]
*pct start* `<vmid>` `[OPTIONS]`
Start the container.
@@ -1008,6 +1042,7 @@ If set, enables very verbose debug log-level on start.
Ignore locks - only root is allowed to use this option.
[[cli_pct_status]]
*pct status* `<vmid>` `[OPTIONS]`
Show CT status.
@@ -1020,6 +1055,7 @@ The (unique) ID of the VM.
Verbose output format
[[cli_pct_stop]]
*pct stop* `<vmid>` `[OPTIONS]`
Stop the container. This will abruptly stop all processes running in the
@@ -1037,6 +1073,7 @@ Try to abort active 'vzshutdown' tasks before stopping.
Ignore locks - only root is allowed to use this option.
[[cli_pct_suspend]]
*pct suspend* `<vmid>`
Suspend the container. This is experimental.
@@ -1045,6 +1082,7 @@ Suspend the container. This is experimental.
The (unique) ID of the VM.
[[cli_pct_template]]
*pct template* `<vmid>`
Create a Template.
@@ -1053,6 +1091,7 @@ Create a Template.
The (unique) ID of the VM.
[[cli_pct_unlock]]
*pct unlock* `<vmid>`
Unlock the VM.
@@ -1061,6 +1100,7 @@ Unlock the VM.
The (unique) ID of the VM.
[[cli_pct_unmount]]
*pct unmount* `<vmid>`
Unmount the container's filesystem.

9
pve-firewall.8-synopsis.adoc
View File

@@ -1,9 +1,12 @@
[[cli_pve-firewall]]
*pve-firewall* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pve-firewall_compile]]
*pve-firewall compile*
Compile and print firewall rules. This is useful for testing.
[[cli_pve-firewall_help]]
*pve-firewall help* `[OPTIONS]`
Get help about specified command.
@@ -16,14 +19,17 @@ Shows help for a specific command
Verbose output format.
[[cli_pve-firewall_localnet]]
*pve-firewall localnet*
Print information about local network.
[[cli_pve-firewall_restart]]
*pve-firewall restart*
Restart the Proxmox VE firewall service.
[[cli_pve-firewall_simulate]]
*pve-firewall simulate* `[OPTIONS]`
Simulate firewall rules. This does not simulates the kernel 'routing'
@@ -62,6 +68,7 @@ Destination zone.
Verbose output.
[[cli_pve-firewall_start]]
*pve-firewall start* `[OPTIONS]`
Start the Proxmox VE firewall service.
@@ -70,10 +77,12 @@ Start the Proxmox VE firewall service.
Debug mode - stay in foreground
[[cli_pve-firewall_status]]
*pve-firewall status*
Get firewall status.
[[cli_pve-firewall_stop]]
*pve-firewall stop*
Stop the Proxmox VE firewall service. Note, stopping actively removes all

5
pve-ha-crm.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pve-ha-crm]]
*pve-ha-crm* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pve-ha-crm_help]]
*pve-ha-crm help* `[OPTIONS]`
Get help about specified command.
@@ -12,6 +14,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pve-ha-crm_start]]
*pve-ha-crm start* `[OPTIONS]`
Start the daemon.
@@ -20,10 +23,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pve-ha-crm_status]]
*pve-ha-crm status*
Get daemon status.
[[cli_pve-ha-crm_stop]]
*pve-ha-crm stop*
Stop the daemon.

5
pve-ha-lrm.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pve-ha-lrm]]
*pve-ha-lrm* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pve-ha-lrm_help]]
*pve-ha-lrm help* `[OPTIONS]`
Get help about specified command.
@@ -12,6 +14,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pve-ha-lrm_start]]
*pve-ha-lrm start* `[OPTIONS]`
Start the daemon.
@@ -20,10 +23,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pve-ha-lrm_status]]
*pve-ha-lrm status*
Get daemon status.
[[cli_pve-ha-lrm_stop]]
*pve-ha-lrm stop*
Stop the daemon.

7
pveam.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pveam]]
*pveam* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pveam_available]]
*pveam available* `[OPTIONS]`
List available templates.
@@ -8,6 +10,7 @@ List available templates.
Restrict list to specified section.
[[cli_pveam_download]]
*pveam download* `<storage> <template>`
Download appliance templates.
@@ -20,6 +23,7 @@ The storage where the template will be stored
The template which will downloaded
[[cli_pveam_help]]
*pveam help* `[OPTIONS]`
Get help about specified command.
@@ -32,6 +36,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pveam_list]]
*pveam list* `<storage>`
Get list of all templates on storage
@@ -40,6 +45,7 @@ Get list of all templates on storage
Only list templates on specified storage
[[cli_pveam_remove]]
*pveam remove* `<template_path>`
Remove a template.
@@ -48,6 +54,7 @@ Remove a template.
The template to remove.
[[cli_pveam_update]]
*pveam update*
Update Container Template Database.

33
pveceph.1-synopsis.adoc
View File

@@ -1,37 +1,47 @@
[[cli_pveceph]]
*pveceph* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pveceph_createmgr]]
*pveceph createmgr*
An alias for 'pveceph mgr create'.
[[cli_pveceph_createmon]]
*pveceph createmon*
An alias for 'pveceph mon create'.
[[cli_pveceph_createosd]]
*pveceph createosd*
An alias for 'pveceph osd create'.
[[cli_pveceph_createpool]]
*pveceph createpool*
An alias for 'pveceph pool create'.
[[cli_pveceph_destroymgr]]
*pveceph destroymgr*
An alias for 'pveceph mgr destroy'.
[[cli_pveceph_destroymon]]
*pveceph destroymon*
An alias for 'pveceph mon destroy'.
[[cli_pveceph_destroyosd]]
*pveceph destroyosd*
An alias for 'pveceph osd destroy'.
[[cli_pveceph_destroypool]]
*pveceph destroypool*
An alias for 'pveceph pool destroy'.
[[cli_pveceph_fs_create]]
*pveceph fs create* `[OPTIONS]`
Create a Ceph filesystem
@@ -48,6 +58,7 @@ The ceph filesystem name.
Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
[[cli_pveceph_fs_destroy]]
*pveceph fs destroy* `<name>` `[OPTIONS]`
Destroy a Ceph filesystem
@@ -64,6 +75,7 @@ Remove data and metadata pools configured for this fs.
Remove all pveceph-managed storages configured for this fs.
[[cli_pveceph_help]]
*pveceph help* `[OPTIONS]`
Get help about specified command.
@@ -76,6 +88,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pveceph_init]]
*pveceph init* `[OPTIONS]`
Create initial ceph default configuration and setup symlinks.
@@ -110,6 +123,7 @@ Depreacted. This setting was deprecated in recent Ceph versions.
Targeted number of replicas per object
[[cli_pveceph_install]]
*pveceph install* `[OPTIONS]`
Install ceph related packages.
@@ -126,10 +140,12 @@ Ceph repository to use.
Ceph version to install.
[[cli_pveceph_lspools]]
*pveceph lspools*
An alias for 'pveceph pool ls'.
[[cli_pveceph_mds_create]]
*pveceph mds create* `[OPTIONS]`
Create Ceph Metadata Server (MDS)
@@ -142,6 +158,7 @@ Determines whether a ceph-mds daemon should poll and replay the log of an active
The ID for the mds, when omitted the same as the nodename
[[cli_pveceph_mds_destroy]]
*pveceph mds destroy* `<name>`
Destroy Ceph Metadata Server
@@ -150,6 +167,7 @@ Destroy Ceph Metadata Server
The name (ID) of the mds
[[cli_pveceph_mgr_create]]
*pveceph mgr create* `[OPTIONS]`
Create Ceph Manager
@@ -158,6 +176,7 @@ Create Ceph Manager
The ID for the manager, when omitted the same as the nodename
[[cli_pveceph_mgr_destroy]]
*pveceph mgr destroy* `<id>`
Destroy Ceph Manager.
@@ -166,6 +185,7 @@ Destroy Ceph Manager.
The ID of the manager
[[cli_pveceph_mon_create]]
*pveceph mon create* `[OPTIONS]`
Create Ceph Monitor and Manager
@@ -178,6 +198,7 @@ Overwrites autodetected monitor IP address(es). Must be in the public network(s)
The ID for the monitor, when omitted the same as the nodename
[[cli_pveceph_mon_destroy]]
*pveceph mon destroy* `<monid>`
Destroy Ceph Monitor and Manager.
@@ -186,6 +207,7 @@ Destroy Ceph Monitor and Manager.
Monitor ID
[[cli_pveceph_osd_create]]
*pveceph osd create* `<dev>` `[OPTIONS]`
Create OSD
@@ -227,6 +249,7 @@ Size in GiB for block.wal.
+
NOTE: Requires option(s): `wal_dev`
[[cli_pveceph_osd_destroy]]
*pveceph osd destroy* `<osdid>` `[OPTIONS]`
Destroy OSD
@@ -239,6 +262,7 @@ OSD ID
If set, we remove partition table entries.
[[cli_pveceph_osd_details]]
*pveceph osd details* `<osdid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Get OSD details.
@@ -251,6 +275,7 @@ ID of the OSD
Print verbose information, same as json-pretty output format.
[[cli_pveceph_pool_create]]
*pveceph pool create* `<name>` `[OPTIONS]`
Create Ceph pool
@@ -303,6 +328,7 @@ The estimated target size of the pool for the PG autoscaler.
The estimated target ratio of the pool for the PG autoscaler.
[[cli_pveceph_pool_destroy]]
*pveceph pool destroy* `<name>` `[OPTIONS]`
Destroy pool
@@ -323,6 +349,7 @@ Remove the erasure code profile. Defaults to true, if applicable.
Remove all pveceph-managed storages configured for this pool
[[cli_pveceph_pool_get]]
*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Show the current pool status.
@@ -335,11 +362,13 @@ The name of the pool. It must be unique.
If enabled, will display additional data(eg. statistics).
[[cli_pveceph_pool_ls]]
*pveceph pool ls* `[FORMAT_OPTIONS]`
List all pools and their settings (which are settable by the POST/PUT
endpoints).
[[cli_pveceph_pool_set]]
*pveceph pool set* `<name>` `[OPTIONS]`
Change POOL settings
@@ -384,6 +413,7 @@ The estimated target size of the pool for the PG autoscaler.
The estimated target ratio of the pool for the PG autoscaler.
[[cli_pveceph_purge]]
*pveceph purge* `[OPTIONS]`
Destroy ceph related data and configuration files.
@@ -396,6 +426,7 @@ Additionally purge Ceph crash logs, /var/lib/ceph/crash.
Additionally purge Ceph logs, /var/log/ceph.
[[cli_pveceph_start]]
*pveceph start* `[OPTIONS]`
Start ceph services.
@@ -404,10 +435,12 @@ Start ceph services.
Ceph service name.
[[cli_pveceph_status]]
*pveceph status*
Get Ceph Status.
[[cli_pveceph_stop]]
*pveceph stop* `[OPTIONS]`
Stop ceph services.

15
pvecm.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvecm]]
*pvecm* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvecm_add]]
*pvecm add* `<hostname>` `[OPTIONS]`
Adds the current node to an existing cluster.
@@ -32,6 +34,7 @@ Always use SSH to join, even if peer may do it over API.
Number of votes for this node
[[cli_pvecm_addnode]]
*pvecm addnode* `<node>` `[OPTIONS]`
Adds a node to the cluster configuration. This call is for internal use.
@@ -64,10 +67,12 @@ Node id for this node.
Number of votes for this node
[[cli_pvecm_apiver]]
*pvecm apiver*
Return the version of the cluster join API available on this node.
[[cli_pvecm_create]]
*pvecm create* `<clustername>` `[OPTIONS]`
Generate new cluster configuration. If no links given, default to local IP
@@ -89,6 +94,7 @@ Node id for this node.
Number of votes for this node.
[[cli_pvecm_delnode]]
*pvecm delnode* `<node>`
Removes a node from the cluster configuration.
@@ -97,6 +103,7 @@ Removes a node from the cluster configuration.
The cluster node name.
[[cli_pvecm_expected]]
*pvecm expected* `<expected>`
Tells corosync a new value of expected votes.
@@ -105,6 +112,7 @@ Tells corosync a new value of expected votes.
Expected votes
[[cli_pvecm_help]]
*pvecm help* `[OPTIONS]`
Get help about specified command.
@@ -117,6 +125,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pvecm_keygen]]
*pvecm keygen* `<filename>`
Generate new cryptographic key for corosync.
@@ -125,6 +134,7 @@ Generate new cryptographic key for corosync.
Output file name
[[cli_pvecm_mtunnel]]
*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
Used by VM/CT migration - do not use manually.
@@ -145,14 +155,17 @@ the migration network used to detect the local migration IP
Run a command with a tcp socket as standard input. The IP address and port are printed via this command's stdandard output first, each on a separate line.
[[cli_pvecm_nodes]]
*pvecm nodes*
Displays the local view of the cluster nodes.
[[cli_pvecm_qdevice_remove]]
*pvecm qdevice remove*
Remove a configured QDevice
[[cli_pvecm_qdevice_setup]]
*pvecm qdevice setup* `<address>` `[OPTIONS]`
Setup the use of a QDevice
@@ -169,10 +182,12 @@ Do not throw error on possible dangerous operations.
The network which should be used to connect to the external qdevice
[[cli_pvecm_status]]
*pvecm status*
Displays the local view of the cluster status.
[[cli_pvecm_updatecerts]]
*pvecm updatecerts* `[OPTIONS]`
Update node certificates (and generate all needed files/directories).

6
pvedaemon.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvedaemon]]
*pvedaemon* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvedaemon_help]]
*pvedaemon help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pvedaemon_restart]]
*pvedaemon restart*
Restart the daemon (or start if not running).
[[cli_pvedaemon_start]]
*pvedaemon start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pvedaemon_status]]
*pvedaemon status*
Get daemon status.
[[cli_pvedaemon_stop]]
*pvedaemon stop*
Stop the daemon.

27
pvenode.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvenode]]
*pvenode* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvenode_acme_account_deactivate]]
*pvenode acme account deactivate* `[<name>]`
Deactivate existing ACME account at CA.
@@ -8,6 +10,7 @@ Deactivate existing ACME account at CA.
ACME account config file name.
[[cli_pvenode_acme_account_info]]
*pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`
Return existing ACME account information.
@@ -16,10 +19,12 @@ Return existing ACME account information.
ACME account config file name.
[[cli_pvenode_acme_account_list]]
*pvenode acme account list*
ACMEAccount index.
[[cli_pvenode_acme_account_register]]
*pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]`
Register a new ACME account with a compatible CA.
@@ -36,6 +41,7 @@ Contact email addresses.
URL of ACME CA directory endpoint.
[[cli_pvenode_acme_account_update]]
*pvenode acme account update* `[<name>]` `[OPTIONS]`
Update existing ACME account information with CA. Note: not specifying any
@@ -49,6 +55,7 @@ ACME account config file name.
Contact email addresses.
[[cli_pvenode_acme_cert_order]]
*pvenode acme cert order* `[OPTIONS]`
Order a new certificate from ACME-compatible CA.
@@ -57,6 +64,7 @@ Order a new certificate from ACME-compatible CA.
Overwrite existing custom certificate.
[[cli_pvenode_acme_cert_renew]]
*pvenode acme cert renew* `[OPTIONS]`
Renew existing certificate from CA.
@@ -65,10 +73,12 @@ Renew existing certificate from CA.
Force renewal even if expiry is more than 30 days away.
[[cli_pvenode_acme_cert_revoke]]
*pvenode acme cert revoke*
Revoke existing certificate from CA.
[[cli_pvenode_acme_plugin_add]]
*pvenode acme plugin add* `<type> <id>` `[OPTIONS]`
Add ACME plugin configuration.
@@ -101,6 +111,7 @@ List of cluster node names.
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
[[cli_pvenode_acme_plugin_config]]
*pvenode acme plugin config* `<id>` `[FORMAT_OPTIONS]`
Get ACME plugin configuration.
@@ -109,6 +120,7 @@ Get ACME plugin configuration.
Unique identifier for ACME plugin instance.
[[cli_pvenode_acme_plugin_list]]
*pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
ACME plugin index.
@@ -117,6 +129,7 @@ ACME plugin index.
Only list ACME plugins of a specific type
[[cli_pvenode_acme_plugin_remove]]
*pvenode acme plugin remove* `<id>`
Delete ACME plugin configuration.
@@ -125,6 +138,7 @@ Delete ACME plugin configuration.
Unique identifier for ACME plugin instance.
[[cli_pvenode_acme_plugin_set]]
*pvenode acme plugin set* `<id>` `[OPTIONS]`
Update ACME plugin configuration.
@@ -161,6 +175,7 @@ List of cluster node names.
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
[[cli_pvenode_cert_delete]]
*pvenode cert delete* `[<restart>]`
DELETE custom certificate chain and key.
@@ -169,10 +184,12 @@ DELETE custom certificate chain and key.
Restart pveproxy.
[[cli_pvenode_cert_info]]
*pvenode cert info* `[FORMAT_OPTIONS]`
Get information about node's certificates.
[[cli_pvenode_cert_set]]
*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
Upload or update custom certificate chain and key.
@@ -193,6 +210,7 @@ Overwrite existing custom or ACME certificate files.
Restart pveproxy.
[[cli_pvenode_config_get]]
*pvenode config get* `[OPTIONS]`
Get node configuration options.
@@ -201,6 +219,7 @@ Get node configuration options.
Return only a specific property from the node configuration.
[[cli_pvenode_config_set]]
*pvenode config set* `[OPTIONS]`
Set node configuration options.
@@ -237,6 +256,7 @@ Initial delay in seconds, before starting all the Virtual Guests with on-boot en
Node specific wake on LAN settings.
[[cli_pvenode_help]]
*pvenode help* `[OPTIONS]`
Get help about specified command.
@@ -249,6 +269,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pvenode_migrateall]]
*pvenode migrateall* `<target>` `[OPTIONS]`
Migrate all VMs and Containers.
@@ -269,6 +290,7 @@ Only consider Guests with these IDs.
Enable live storage migration for local disk
[[cli_pvenode_startall]]
*pvenode startall* `[OPTIONS]`
Start all VMs and containers located on this node (by default only those
@@ -282,6 +304,7 @@ Issue start command even if virtual guest have 'onboot' not set or set to off.
Only consider guests from this comma separated list of VMIDs.
[[cli_pvenode_stopall]]
*pvenode stopall* `[OPTIONS]`
Stop all VMs and Containers.
@@ -298,6 +321,7 @@ Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown ge
Only consider Guests with these IDs.
[[cli_pvenode_task_list]]
*pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
Read task list for one node (finished tasks).
@@ -342,6 +366,7 @@ Only list tasks from this user.
Only list tasks for this VM.
[[cli_pvenode_task_log]]
*pvenode task log* `<upid>` `[OPTIONS]`
Read task log.
@@ -358,6 +383,7 @@ Whether the tasklog file should be downloaded. This parameter can't be used in c
Start at this line when reading the tasklog
[[cli_pvenode_task_status]]
*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
Read task status.
@@ -366,6 +392,7 @@ Read task status.
The task's unique ID.
[[cli_pvenode_wakeonlan]]
*pvenode wakeonlan* `<node>`
Try to wake a node via 'wake on LAN' network packet.

6
pveproxy.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pveproxy]]
*pveproxy* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pveproxy_help]]
*pveproxy help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pveproxy_restart]]
*pveproxy restart*
Restart the daemon (or start if not running).
[[cli_pveproxy_start]]
*pveproxy start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pveproxy_status]]
*pveproxy status*
Get daemon status.
[[cli_pveproxy_stop]]
*pveproxy stop*
Stop the daemon.

6
pvescheduler.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvescheduler]]
*pvescheduler* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvescheduler_help]]
*pvescheduler help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pvescheduler_restart]]
*pvescheduler restart*
Restart the daemon (or start if not running).
[[cli_pvescheduler_start]]
*pvescheduler start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pvescheduler_status]]
*pvescheduler status*
Get daemon status.
[[cli_pvescheduler_stop]]
*pvescheduler stop*
Stop the daemon.

8
pvesh.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvesh]]
*pvesh* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvesh_create]]
*pvesh create* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API POST on <api_path>.
@@ -12,6 +14,7 @@ API path.
Disable automatic proxying.
[[cli_pvesh_delete]]
*pvesh delete* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API DELETE on <api_path>.
@@ -24,6 +27,7 @@ API path.
Disable automatic proxying.
[[cli_pvesh_get]]
*pvesh get* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API GET on <api_path>.
@@ -36,6 +40,7 @@ API path.
Disable automatic proxying.
[[cli_pvesh_help]]
*pvesh help* `[OPTIONS]`
Get help about specified command.
@@ -48,6 +53,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pvesh_ls]]
*pvesh ls* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
List child objects on <api_path>.
@@ -60,6 +66,7 @@ API path.
Disable automatic proxying.
[[cli_pvesh_set]]
*pvesh set* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API PUT on <api_path>.
@@ -72,6 +79,7 @@ API path.
Disable automatic proxying.
[[cli_pvesh_usage]]
*pvesh usage* `<api_path>` `[OPTIONS]`
print API usage information for <api_path>.

28
pvesm.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvesm]]
*pvesm* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvesm_add]]
*pvesm add* `<type> <storage>` `[OPTIONS]`
Create a new storage.
@@ -246,6 +248,7 @@ Volume group name.
Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'.
[[cli_pvesm_alloc]]
*pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
Allocate disk images.
@@ -272,14 +275,17 @@ Format of the image.
+
NOTE: Requires option(s): `size`
[[cli_pvesm_apiinfo]]
*pvesm apiinfo*
Returns APIVER and APIAGE.
[[cli_pvesm_cifsscan]]
*pvesm cifsscan*
An alias for 'pvesm scan cifs'.
[[cli_pvesm_export]]
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
Used internally to export a volume.
@@ -312,6 +318,7 @@ Ordered list of snapshots to transfer
Whether to include intermediate snapshots in the stream
[[cli_pvesm_extractconfig]]
*pvesm extractconfig* `<volume>`
Extract configuration from vzdump backup archive.
@@ -320,6 +327,7 @@ Extract configuration from vzdump backup archive.
Volume identifier
[[cli_pvesm_free]]
*pvesm free* `<volume>` `[OPTIONS]`
Delete volume
@@ -336,6 +344,7 @@ Time to wait for the task to finish. We return 'null' if the task finish within
The storage identifier.
[[cli_pvesm_help]]
*pvesm help* `[OPTIONS]`
Get help about specified command.
@@ -348,6 +357,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pvesm_import]]
*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
Used internally to import a volume.
@@ -384,10 +394,12 @@ The current-state snapshot if the stream contains snapshots
Whether the stream includes intermediate snapshots
[[cli_pvesm_iscsiscan]]
*pvesm iscsiscan*
An alias for 'pvesm scan iscsi'.
[[cli_pvesm_list]]
*pvesm list* `<storage>` `[OPTIONS]`
List storage content.
@@ -404,18 +416,22 @@ Only list content of this type.
Only list images for this VM
[[cli_pvesm_lvmscan]]
*pvesm lvmscan*
An alias for 'pvesm scan lvm'.
[[cli_pvesm_lvmthinscan]]
*pvesm lvmthinscan*
An alias for 'pvesm scan lvmthin'.
[[cli_pvesm_nfsscan]]
*pvesm nfsscan*
An alias for 'pvesm scan nfs'.
[[cli_pvesm_path]]
*pvesm path* `<volume>`
Get filesystem path for specified volume
@@ -424,6 +440,7 @@ Get filesystem path for specified volume
Volume identifier
[[cli_pvesm_prune-backups]]
*pvesm prune-backups* `<storage>` `[OPTIONS]`
Prune backups. Only those using the standard naming scheme are considered.
@@ -474,6 +491,7 @@ Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
Only consider backups for this guest.
[[cli_pvesm_remove]]
*pvesm remove* `<storage>`
Delete storage configuration.
@@ -482,6 +500,7 @@ Delete storage configuration.
The storage identifier.
[[cli_pvesm_scan_cifs]]
*pvesm scan cifs* `<server>` `[OPTIONS]`
Scan remote CIFS server.
@@ -502,6 +521,7 @@ User password.
User name.
[[cli_pvesm_scan_iscsi]]
*pvesm scan iscsi* `<portal>`
Scan remote iSCSI server.
@@ -510,10 +530,12 @@ Scan remote iSCSI server.
The iSCSI portal (IP or DNS name with optional port).
[[cli_pvesm_scan_lvm]]
*pvesm scan lvm*
List local LVM volume groups.
[[cli_pvesm_scan_lvmthin]]
*pvesm scan lvmthin* `<vg>`
List local LVM Thin Pools.
@@ -522,6 +544,7 @@ List local LVM Thin Pools.
no description available
[[cli_pvesm_scan_nfs]]
*pvesm scan nfs* `<server>`
Scan remote NFS server.
@@ -530,6 +553,7 @@ Scan remote NFS server.
The server address (name or IP).
[[cli_pvesm_scan_pbs]]
*pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Scan remote Proxmox Backup Server.
@@ -554,10 +578,12 @@ User password or API token secret.
Optional port.
[[cli_pvesm_scan_zfs]]
*pvesm scan zfs*
Scan zfs pool list on local node.
[[cli_pvesm_set]]
*pvesm set* `<storage>` `[OPTIONS]`
Update storage configuration.
@@ -764,6 +790,7 @@ RBD Id.
Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'.
[[cli_pvesm_status]]
*pvesm status* `[OPTIONS]`
Get status for all datastores.
@@ -788,6 +815,7 @@ Only list status for specified storage
If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
[[cli_pvesm_zfsscan]]
*pvesm zfsscan*
An alias for 'pvesm scan zfs'.

15
pvesr.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvesr]]
*pvesr* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvesr_create-local-job]]
*pvesr create-local-job* `<id> <target>` `[OPTIONS]`
Create a new replication job
@@ -36,6 +38,7 @@ Storage replication schedule. The format is a subset of `systemd` calendar event
For internal use, to detect if the guest was stolen.
[[cli_pvesr_delete]]
*pvesr delete* `<id>` `[OPTIONS]`
Mark replication job for removal.
@@ -52,6 +55,7 @@ Will remove the jobconfig entry, but will not cleanup.
Keep replicated data at target (do not remove).
[[cli_pvesr_disable]]
*pvesr disable* `<id>`
Disable a replication job.
@@ -60,6 +64,7 @@ Disable a replication job.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
[[cli_pvesr_enable]]
*pvesr enable* `<id>`
Enable a replication job.
@@ -68,6 +73,7 @@ Enable a replication job.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
[[cli_pvesr_finalize-local-job]]
*pvesr finalize-local-job* `<id> [<extra-args>]` `[OPTIONS]`
Finalize a replication job. This removes all replications snapshots with
@@ -85,6 +91,7 @@ The list of volume IDs to consider.
Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
[[cli_pvesr_help]]
*pvesr help* `[OPTIONS]`
Get help about specified command.
@@ -97,10 +104,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pvesr_list]]
*pvesr list*
List replication jobs.
[[cli_pvesr_prepare-local-job]]
*pvesr prepare-local-job* `<id> [<extra-args>]` `[OPTIONS]`
Prepare for starting a replication job. This is called on the target node
@@ -136,6 +145,7 @@ The name of the snapshot.
List of storage IDs to scan for stale volumes.
[[cli_pvesr_read]]
*pvesr read* `<id>`
Read replication job configuration.
@@ -144,6 +154,7 @@ Read replication job configuration.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
[[cli_pvesr_run]]
*pvesr run* `[OPTIONS]`
This method is called by the systemd-timer and executes all (or a specific)
@@ -161,6 +172,7 @@ Send an email notification in case of a failure.
Print more verbose logs to stdout.
[[cli_pvesr_schedule-now]]
*pvesr schedule-now* `<id>`
Schedule replication job to start as soon as possible.
@@ -169,6 +181,7 @@ Schedule replication job to start as soon as possible.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
[[cli_pvesr_set-state]]
*pvesr set-state* `<vmid> <state>`
Set the job replication state on migration. This call is for internal use.
@@ -182,6 +195,7 @@ The (unique) ID of the VM.
Job state as JSON decoded string.
[[cli_pvesr_status]]
*pvesr status* `[OPTIONS]`
List status of all replication jobs on this node.
@@ -190,6 +204,7 @@ List status of all replication jobs on this node.
Only list replication jobs for this guest.
[[cli_pvesr_update]]
*pvesr update* `<id>` `[OPTIONS]`
Update replication job configuration.

6
pvestatd.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pvestatd]]
*pvestatd* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvestatd_help]]
*pvestatd help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
[[cli_pvestatd_restart]]
*pvestatd restart*
Restart the daemon (or start if not running).
[[cli_pvestatd_start]]
*pvestatd start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_pvestatd_status]]
*pvestatd status*
Get daemon status.
[[cli_pvestatd_stop]]
*pvestatd stop*
Stop the daemon.

7
pvesubscription.1-synopsis.adoc
View File

@@ -1,13 +1,17 @@
[[cli_pvesubscription]]
*pvesubscription* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pvesubscription_delete]]
*pvesubscription delete*
Delete subscription key of this node.
[[cli_pvesubscription_get]]
*pvesubscription get*
Read subscription info.
[[cli_pvesubscription_help]]
*pvesubscription help* `[OPTIONS]`
Get help about specified command.
@@ -20,6 +24,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pvesubscription_set]]
*pvesubscription set* `<key>`
Set subscription key.
@@ -28,6 +33,7 @@ Set subscription key.
Proxmox VE subscription key
[[cli_pvesubscription_set-offline-key]]
*pvesubscription set-offline-key* `<data>`
Internal use only! To set an offline key, use the package
@@ -37,6 +43,7 @@ proxmox-offline-mirror-helper instead.
A signed subscription info blob
[[cli_pvesubscription_update]]
*pvesubscription update* `[OPTIONS]`
Update subscription info.

49
pveum.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_pveum]]
*pveum* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_pveum_acl_delete]]
*pveum acl delete* `<path> --roles <string>` `[OPTIONS]`
Update Access Control List (add or remove permissions).
@@ -28,10 +30,12 @@ List of API tokens.
List of users.
[[cli_pveum_acl_list]]
*pveum acl list* `[FORMAT_OPTIONS]`
Get Access Control List (ACLs).
[[cli_pveum_acl_modify]]
*pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
Update Access Control List (add or remove permissions).
@@ -60,14 +64,17 @@ List of API tokens.
List of users.
[[cli_pveum_acldel]]
*pveum acldel*
An alias for 'pveum acl delete'.
[[cli_pveum_aclmod]]
*pveum aclmod*
An alias for 'pveum acl modify'.
[[cli_pveum_group_add]]
*pveum group add* `<groupid>` `[OPTIONS]`
Create new group.
@@ -80,6 +87,7 @@ no description available
no description available
[[cli_pveum_group_delete]]
*pveum group delete* `<groupid>`
Delete group.
@@ -88,10 +96,12 @@ Delete group.
no description available
[[cli_pveum_group_list]]
*pveum group list* `[FORMAT_OPTIONS]`
Group index.
[[cli_pveum_group_modify]]
*pveum group modify* `<groupid>` `[OPTIONS]`
Update group data.
@@ -104,18 +114,22 @@ no description available
no description available
[[cli_pveum_groupadd]]
*pveum groupadd*
An alias for 'pveum group add'.
[[cli_pveum_groupdel]]
*pveum groupdel*
An alias for 'pveum group delete'.
[[cli_pveum_groupmod]]
*pveum groupmod*
An alias for 'pveum group modify'.
[[cli_pveum_help]]
*pveum help* `[OPTIONS]`
Get help about specified command.
@@ -128,6 +142,7 @@ Shows help for a specific command
Verbose output format.
[[cli_pveum_passwd]]
*pveum passwd* `<userid>` `[OPTIONS]`
Change user password.
@@ -140,6 +155,7 @@ Full User ID, in the `name@realm` format.
The current password of the user performing the change.
[[cli_pveum_pool_add]]
*pveum pool add* `<poolid>` `[OPTIONS]`
Create new pool.
@@ -152,6 +168,7 @@ no description available
no description available
[[cli_pveum_pool_delete]]
*pveum pool delete* `<poolid>`
Delete pool.
@@ -160,6 +177,7 @@ Delete pool.
no description available
[[cli_pveum_pool_list]]
*pveum pool list* `[OPTIONS]` `[FORMAT_OPTIONS]`
List pools or get pool configuration.
@@ -174,6 +192,7 @@ no description available
+
NOTE: Requires option(s): `poolid`
[[cli_pveum_pool_modify]]
*pveum pool modify* `<poolid>` `[OPTIONS]`
Update pool.
@@ -202,6 +221,7 @@ List of storage IDs to add or remove from this pool.
List of guest VMIDs to add or remove from this pool.
[[cli_pveum_realm_add]]
*pveum realm add* `<realm> --type <string>` `[OPTIONS]`
Add an authentication server.
@@ -374,6 +394,7 @@ OpenID claim used to generate the unique username.
Verify the server's SSL certificate
[[cli_pveum_realm_delete]]
*pveum realm delete* `<realm>`
Delete an authentication server.
@@ -382,10 +403,12 @@ Delete an authentication server.
Authentication domain ID
[[cli_pveum_realm_list]]
*pveum realm list* `[FORMAT_OPTIONS]`
Authentication domain index.
[[cli_pveum_realm_modify]]
*pveum realm modify* `<realm>` `[OPTIONS]`
Update authentication server settings.
@@ -558,6 +581,7 @@ The objectclasses for users.
Verify the server's SSL certificate
[[cli_pveum_realm_sync]]
*pveum realm sync* `<realm>` `[OPTIONS]`
Syncs users and/or groups from the configured LDAP to user.cfg. NOTE:
@@ -592,6 +616,7 @@ A semicolon-separated list of things to remove when they or the user vanishes du
Select what to sync.
[[cli_pveum_role_add]]
*pveum role add* `<roleid>` `[OPTIONS]`
Create new role.
@@ -604,6 +629,7 @@ no description available
no description available
[[cli_pveum_role_delete]]
*pveum role delete* `<roleid>`
Delete role.
@@ -612,10 +638,12 @@ Delete role.
no description available
[[cli_pveum_role_list]]
*pveum role list* `[FORMAT_OPTIONS]`
Role index.
[[cli_pveum_role_modify]]
*pveum role modify* `<roleid>` `[OPTIONS]`
Update an existing role.
@@ -634,18 +662,22 @@ NOTE: Requires option(s): `privs`
no description available
[[cli_pveum_roleadd]]
*pveum roleadd*
An alias for 'pveum role add'.
[[cli_pveum_roledel]]
*pveum roledel*
An alias for 'pveum role delete'.
[[cli_pveum_rolemod]]
*pveum rolemod*
An alias for 'pveum role modify'.
[[cli_pveum_ticket]]
*pveum ticket* `<username>` `[OPTIONS]`
Create or verify authentication ticket.
@@ -682,6 +714,7 @@ You can optionally pass the realm using this parameter. Normally the realm is si
The signed TFA challenge string the user wants to respond to.
[[cli_pveum_user_add]]
*pveum user add* `<userid>` `[OPTIONS]`
Create new user.
@@ -726,6 +759,7 @@ no description available
Initial password.
[[cli_pveum_user_delete]]
*pveum user delete* `<userid>`
Delete user.
@@ -734,6 +768,7 @@ Delete user.
Full User ID, in the `name@realm` format.
[[cli_pveum_user_list]]
*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
User index.
@@ -746,6 +781,7 @@ Optional filter for enable property.
Include group and token information.
[[cli_pveum_user_modify]]
*pveum user modify* `<userid>` `[OPTIONS]`
Update user configuration.
@@ -792,6 +828,7 @@ Keys for two factor auth (yubico).
no description available
[[cli_pveum_user_permissions]]
*pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
Retrieve effective permissions of given user/token.
@@ -804,6 +841,7 @@ User ID or full API token ID
Only dump this specific path, not the whole tree.
[[cli_pveum_user_tfa_delete]]
*pveum user tfa delete* `<userid>` `[OPTIONS]`
Delete TFA entries from a user.
@@ -816,6 +854,7 @@ Full User ID, in the `name@realm` format.
The TFA ID, if none provided, all TFA entries will be deleted.
[[cli_pveum_user_tfa_list]]
*pveum user tfa list* `[<userid>]`
List TFA entries.
@@ -824,6 +863,7 @@ List TFA entries.
Full User ID, in the `name@realm` format.
[[cli_pveum_user_tfa_unlock]]
*pveum user tfa unlock* `<userid>`
Unlock a user's TFA authentication.
@@ -832,6 +872,7 @@ Unlock a user's TFA authentication.
Full User ID, in the `name@realm` format.
[[cli_pveum_user_token_add]]
*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Generate a new API token for a specific user. NOTE: returns API token
@@ -857,6 +898,7 @@ API token expiration date (seconds since epoch). '0' means no expiration date.
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
[[cli_pveum_user_token_delete]]
*pveum user token delete* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
Remove API token for a specific user.
@@ -869,6 +911,7 @@ Full User ID, in the `name@realm` format.
User-specific token identifier.
[[cli_pveum_user_token_list]]
*pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
Get user API tokens.
@@ -877,6 +920,7 @@ Get user API tokens.
Full User ID, in the `name@realm` format.
[[cli_pveum_user_token_modify]]
*pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Update API token for a specific user.
@@ -901,6 +945,7 @@ API token expiration date (seconds since epoch). '0' means no expiration date.
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
[[cli_pveum_user_token_permissions]]
*pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Retrieve effective permissions of given token.
@@ -917,18 +962,22 @@ User-specific token identifier.
Only dump this specific path, not the whole tree.
[[cli_pveum_user_token_remove]]
*pveum user token remove*
An alias for 'pveum user token delete'.
[[cli_pveum_useradd]]
*pveum useradd*
An alias for 'pveum user add'.
[[cli_pveum_userdel]]
*pveum userdel*
An alias for 'pveum user delete'.
[[cli_pveum_usermod]]
*pveum usermod*
An alias for 'pveum user modify'.

55
qm.1-synopsis.adoc
View File

@@ -1,9 +1,12 @@
[[cli_qm]]
*qm* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_qm_agent]]
*qm agent*
An alias for 'qm guest cmd'.
[[cli_qm_cleanup]]
*qm cleanup* `<vmid> <clean-shutdown> <guest-requested>`
Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
@@ -21,6 +24,7 @@ Indicates if qemu shutdown cleanly.
Indicates if the shutdown was requested by the guest or via qmp.
[[cli_qm_clone]]
*qm clone* `<vmid> <newid>` `[OPTIONS]`
Create a copy of virtual machine/template.
@@ -69,6 +73,7 @@ Target storage for full clone.
Target node. Only allowed if the original VM is on shared storage.
[[cli_qm_cloudinit_dump]]
*qm cloudinit dump* `<vmid> <type>`
Get automatically generated cloudinit config.
@@ -81,6 +86,7 @@ The (unique) ID of the VM.
Config type.
[[cli_qm_cloudinit_pending]]
*qm cloudinit pending* `<vmid>`
Get the cloudinit configuration with both current and pending values.
@@ -89,6 +95,7 @@ Get the cloudinit configuration with both current and pending values.
The (unique) ID of the VM.
[[cli_qm_cloudinit_update]]
*qm cloudinit update* `<vmid>`
Regenerate and change cloudinit config drive.
@@ -97,6 +104,7 @@ Regenerate and change cloudinit config drive.
The (unique) ID of the VM.
[[cli_qm_config]]
*qm config* `<vmid>` `[OPTIONS]`
Get the virtual machine configuration with pending configuration changes
@@ -115,6 +123,7 @@ Get current values (instead of pending values).
Fetch config values from given snapshot.
[[cli_qm_create]]
*qm create* `<vmid>` `[OPTIONS]`
Create or restore a virtual machine.
@@ -489,6 +498,7 @@ Default storage for VM state volumes/files.
Create a virtual hardware watchdog device.
[[cli_qm_delsnapshot]]
*qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
Delete a VM snapshot.
@@ -505,6 +515,7 @@ The name of the snapshot.
For removal from config file, even if removing disk snapshots fails.
[[cli_qm_destroy]]
*qm destroy* `<vmid>` `[OPTIONS]`
Destroy the VM and all used/owned volumes. Removes any VM specific
@@ -526,6 +537,7 @@ Remove VMID from configurations, like backup & replication jobs and HA.
Ignore locks - only root is allowed to use this option.
[[cli_qm_disk_import]]
*qm disk import* `<vmid> <source> <storage>` `[OPTIONS]`
Import an external disk image as an unused disk in a VM. The
@@ -551,6 +563,7 @@ Target format
The disk name where the volume will be imported to (e.g. scsi1).
[[cli_qm_disk_move]]
*qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]`
Move volume to different storage or to a different VM.
@@ -597,6 +610,7 @@ The config key the disk will be moved to on the target VM (for example, ide0 or
The (unique) ID of the VM.
[[cli_qm_disk_rescan]]
*qm disk rescan* `[OPTIONS]`
Rescan all storages and update disk sizes and unused disk images.
@@ -609,6 +623,7 @@ Do not actually write changes out to VM config(s).
The (unique) ID of the VM.
[[cli_qm_disk_resize]]
*qm disk resize* `<vmid> <disk> <size>` `[OPTIONS]`
Extend volume size.
@@ -633,6 +648,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
Ignore locks - only root is allowed to use this option.
[[cli_qm_disk_unlink]]
*qm disk unlink* `<vmid> --idlist <string>` `[OPTIONS]`
Unlink/delete disk images.
@@ -649,6 +665,7 @@ Force physical removal. Without this, we simple remove the disk from the config
A list of disk IDs you want to delete.
[[cli_qm_guest_cmd]]
*qm guest cmd* `<vmid> <command>`
Execute QEMU Guest Agent commands.
@@ -661,6 +678,7 @@ The (unique) ID of the VM.
The QGA command.
[[cli_qm_guest_exec]]
*qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
Executes the given command via the guest agent
@@ -685,6 +703,7 @@ If set to off, returns the pid immediately instead of waiting for the command to
The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
[[cli_qm_guest_exec-status]]
*qm guest exec-status* `<vmid> <pid>`
Gets the status of the given pid started by the guest-agent
@@ -697,6 +716,7 @@ The (unique) ID of the VM.
The PID to query
[[cli_qm_guest_passwd]]
*qm guest passwd* `<vmid> <username>` `[OPTIONS]`
Sets the password for the given user to the given password
@@ -713,6 +733,7 @@ The user to set the password for.
set to 1 if the password has already been passed through crypt()
[[cli_qm_help]]
*qm help* `[OPTIONS]`
Get help about specified command.
@@ -725,6 +746,7 @@ Shows help for a specific command
Verbose output format.
[[cli_qm_import]]
*qm import* `<vmid> <source> --storage <string>` `[OPTIONS]`
Import a foreign virtual guest from a supported import source, such as an
@@ -1084,10 +1106,12 @@ Default storage for VM state volumes/files.
Create a virtual hardware watchdog device.
[[cli_qm_importdisk]]
*qm importdisk*
An alias for 'qm disk import'.
[[cli_qm_importovf]]
*qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
Create a new VM using parameters read from an OVF manifest
@@ -1112,6 +1136,7 @@ Print a parsed representation of the extracted OVF parameters, but do not create
Target format
[[cli_qm_list]]
*qm list* `[OPTIONS]`
Virtual machine index (per node).
@@ -1120,6 +1145,7 @@ Virtual machine index (per node).
Determine the full status of active VMs.
[[cli_qm_listsnapshot]]
*qm listsnapshot* `<vmid>`
List all snapshots.
@@ -1128,6 +1154,7 @@ List all snapshots.
The (unique) ID of the VM.
[[cli_qm_migrate]]
*qm migrate* `<vmid> <target>` `[OPTIONS]`
Migrate virtual machine. Creates a new migration task.
@@ -1172,6 +1199,7 @@ Whether to migrate conntrack entries for running VMs.
Enable live storage migration for local disk
[[cli_qm_monitor]]
*qm monitor* `<vmid>`
Enter QEMU Monitor interface.
@@ -1180,18 +1208,22 @@ Enter QEMU Monitor interface.
The (unique) ID of the VM.
[[cli_qm_move-disk]]
*qm move-disk*
An alias for 'qm disk move'.
[[cli_qm_move_disk]]
*qm move_disk*
An alias for 'qm disk move'.
[[cli_qm_mtunnel]]
*qm mtunnel*
Used by qmigrate - do not use manually.
[[cli_qm_nbdstop]]
*qm nbdstop* `<vmid>`
Stop embedded nbd server.
@@ -1200,6 +1232,7 @@ Stop embedded nbd server.
The (unique) ID of the VM.
[[cli_qm_pending]]
*qm pending* `<vmid>`
Get the virtual machine configuration with both current and pending values.
@@ -1208,6 +1241,7 @@ Get the virtual machine configuration with both current and pending values.
The (unique) ID of the VM.
[[cli_qm_reboot]]
*qm reboot* `<vmid>` `[OPTIONS]`
Reboot the VM by shutting it down, and starting it again. Applies pending
@@ -1221,6 +1255,7 @@ The (unique) ID of the VM.
Wait maximal timeout seconds for the shutdown.
[[cli_qm_remote-migrate]]
*qm remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
Migrate virtual machine to a remote cluster. Creates a new migration task.
@@ -1258,10 +1293,12 @@ Mapping from source to target bridges. Providing only a single bridge ID maps al
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.
[[cli_qm_rescan]]
*qm rescan*
An alias for 'qm disk rescan'.
[[cli_qm_reset]]
*qm reset* `<vmid>` `[OPTIONS]`
Reset virtual machine.
@@ -1274,10 +1311,12 @@ The (unique) ID of the VM.
Ignore locks - only root is allowed to use this option.
[[cli_qm_resize]]
*qm resize*
An alias for 'qm disk resize'.
[[cli_qm_resume]]
*qm resume* `<vmid>` `[OPTIONS]`
Resume virtual machine.
@@ -1294,6 +1333,7 @@ no description available
Ignore locks - only root is allowed to use this option.
[[cli_qm_rollback]]
*qm rollback* `<vmid> <snapname>` `[OPTIONS]`
Rollback VM state to specified snapshot.
@@ -1310,6 +1350,7 @@ The name of the snapshot.
Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)
[[cli_qm_sendkey]]
*qm sendkey* `<vmid> <key>` `[OPTIONS]`
Send key event to virtual machine.
@@ -1326,6 +1367,7 @@ The key (qemu monitor encoding).
Ignore locks - only root is allowed to use this option.
[[cli_qm_set]]
*qm set* `<vmid>` `[OPTIONS]`
Set virtual machine options (synchronous API) - You should consider using
@@ -1684,6 +1726,7 @@ Default storage for VM state volumes/files.
Create a virtual hardware watchdog device.
[[cli_qm_showcmd]]
*qm showcmd* `<vmid>` `[OPTIONS]`
Show command line which is used to start the VM (debug info).
@@ -1700,6 +1743,7 @@ Puts each option on a new line to enhance human readability
Fetch config values from given snapshot.
[[cli_qm_shutdown]]
*qm shutdown* `<vmid>` `[OPTIONS]`
Shutdown virtual machine. This is similar to pressing the power button on a
@@ -1726,6 +1770,7 @@ Ignore locks - only root is allowed to use this option.
Wait maximal timeout seconds.
[[cli_qm_snapshot]]
*qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
Snapshot a VM.
@@ -1746,6 +1791,7 @@ A textual description or comment.
Save the vmstate
[[cli_qm_start]]
*qm start* `<vmid>` `[OPTIONS]`
Start virtual machine.
@@ -1794,6 +1840,7 @@ Wait maximal timeout seconds.
Whether to migrate conntrack entries for running VMs.
[[cli_qm_status]]
*qm status* `<vmid>` `[OPTIONS]`
Show VM status.
@@ -1806,6 +1853,7 @@ The (unique) ID of the VM.
Verbose output format
[[cli_qm_stop]]
*qm stop* `<vmid>` `[OPTIONS]`
Stop virtual machine. The qemu process will exit immediately. This is akin
@@ -1835,6 +1883,7 @@ Ignore locks - only root is allowed to use this option.
Wait maximal timeout seconds.
[[cli_qm_suspend]]
*qm suspend* `<vmid>` `[OPTIONS]`
Suspend virtual machine.
@@ -1857,6 +1906,7 @@ NOTE: Requires option(s): `todisk`
If set, suspends the VM to disk. Will be resumed on next VM start.
[[cli_qm_template]]
*qm template* `<vmid>` `[OPTIONS]`
Create a Template.
@@ -1869,6 +1919,7 @@ The (unique) ID of the VM.
If you want to convert only 1 disk to base image.
[[cli_qm_terminal]]
*qm terminal* `<vmid>` `[OPTIONS]`
Open a terminal using a serial device (The VM need to have a serial device
@@ -1886,10 +1937,12 @@ Escape character.
Select the serial device. By default we simply use the first suitable device.
[[cli_qm_unlink]]
*qm unlink*
An alias for 'qm disk unlink'.
[[cli_qm_unlock]]
*qm unlock* `<vmid>`
Unlock the VM.
@@ -1898,6 +1951,7 @@ Unlock the VM.
The (unique) ID of the VM.
[[cli_qm_vncproxy]]
*qm vncproxy* `<vmid>`
Proxy VM VNC traffic to stdin/stdout
@@ -1906,6 +1960,7 @@ Proxy VM VNC traffic to stdin/stdout
The (unique) ID of the VM.
[[cli_qm_wait]]
*qm wait* `<vmid>` `[OPTIONS]`
Wait until the VM is stopped.

2
qmrestore.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_qmrestore_help]]
*qmrestore* `help`
[[cli_qmrestore]]
*qmrestore* `<archive> <vmid>` `[OPTIONS]`
Restore QemuServer vzdump backups.

6
spiceproxy.8-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_spiceproxy]]
*spiceproxy* `<COMMAND> [ARGS] [OPTIONS]`
[[cli_spiceproxy_help]]
*spiceproxy help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
[[cli_spiceproxy_restart]]
*spiceproxy restart*
Restart the daemon (or start if not running).
[[cli_spiceproxy_start]]
*spiceproxy start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
[[cli_spiceproxy_status]]
*spiceproxy status*
Get daemon status.
[[cli_spiceproxy_stop]]
*spiceproxy stop*
Stop the daemon.

2
vzdump.1-synopsis.adoc
View File

@@ -1,5 +1,7 @@
[[cli_vzdump_help]]
*vzdump* `help`
[[cli_vzdump]]
*vzdump* `{<vmid>}` `[OPTIONS]`
Create backup.