From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id B45A51FF16B for ; Tue, 12 Aug 2025 11:55:27 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 071BF910D; Tue, 12 Aug 2025 11:56:56 +0200 (CEST) From: Christoph Heiss To: pve-devel@lists.proxmox.com Date: Tue, 12 Aug 2025 11:56:29 +0200 Message-ID: <20250812095637.444463-6-c.heiss@proxmox.com> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20250812095637.444463-1-c.heiss@proxmox.com> References: <20250812095637.444463-1-c.heiss@proxmox.com> MIME-Version: 1.0 X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1754992573097 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.032 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH docs 5/5] update generated cli synopsis files X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Signed-off-by: Christoph Heiss --- ha-manager.1-synopsis.adoc | 23 ++++++++++++++ pct.1-synopsis.adoc | 40 ++++++++++++++++++++++++ pve-firewall.8-synopsis.adoc | 9 ++++++ pve-ha-crm.8-synopsis.adoc | 5 +++ pve-ha-lrm.8-synopsis.adoc | 5 +++ pveam.1-synopsis.adoc | 7 +++++ pveceph.1-synopsis.adoc | 33 ++++++++++++++++++++ pvecm.1-synopsis.adoc | 15 +++++++++ pvedaemon.8-synopsis.adoc | 6 ++++ pvenode.1-synopsis.adoc | 27 ++++++++++++++++ pveproxy.8-synopsis.adoc | 6 ++++ pvescheduler.8-synopsis.adoc | 6 ++++ pvesh.1-synopsis.adoc | 8 +++++ pvesm.1-synopsis.adoc | 28 +++++++++++++++++ pvesr.1-synopsis.adoc | 15 +++++++++ pvestatd.8-synopsis.adoc | 6 ++++ pvesubscription.1-synopsis.adoc | 7 +++++ pveum.1-synopsis.adoc | 49 +++++++++++++++++++++++++++++ qm.1-synopsis.adoc | 55 +++++++++++++++++++++++++++++++++ qmrestore.1-synopsis.adoc | 2 ++ spiceproxy.8-synopsis.adoc | 6 ++++ vzdump.1-synopsis.adoc | 2 ++ 22 files changed, 360 insertions(+) diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index 78a9556..054d094 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -1,5 +1,7 @@ +[[cli_ha-manager]] *ha-manager* ` [ARGS] [OPTIONS]` +[[cli_ha-manager_add]] *ha-manager add* `` `[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* ` ` 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* `` 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* `` 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* ` ` 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* ` ` 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* ` --nodes ` `[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* `` 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* `` `[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* `` 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* ` --resources ` `[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* `` Delete HA rule. @@ -274,6 +294,7 @@ Delete HA rule. HA rule identifier. +[[cli_ha-manager_rules_set]] *ha-manager rules set* ` ` `[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* `` `[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. diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 158d489..e38d447 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -1,5 +1,7 @@ +[[cli_pct]] *pct* ` [ARGS] [OPTIONS]` +[[cli_pct_clone]] *pct clone* ` ` `[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* `` `[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* `` `[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 as the escape sequence pass '^b'. +[[cli_pct_cpusets]] *pct cpusets* Print the list of assigned CPU sets. +[[cli_pct_create]] *pct create* ` ` `[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* ` ` `[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* `` `[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* `` 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* `` `[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* ` []` `[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* `` `[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* `` `[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* `` List all snapshots. @@ -377,6 +393,7 @@ List all snapshots. The (unique) ID of the VM. +[[cli_pct_migrate]] *pct migrate* ` ` `[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* `` 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* ` [] [] []` `[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* `` 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* ` ` `[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* ` ` `[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* `` `[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* ` [] --target-bridge --target-storage ` `[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* ` ` `[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* ` ` `[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* `` Resume the container. @@ -801,6 +830,7 @@ Resume the container. The (unique) ID of the VM. +[[cli_pct_rollback]] *pct rollback* ` ` `[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* `` `[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* `` `[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* ` ` `[OPTIONS]` Snapshot a container. @@ -992,6 +1025,7 @@ The name of the snapshot. A textual description or comment. +[[cli_pct_start]] *pct start* `` `[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* `` `[OPTIONS]` Show CT status. @@ -1020,6 +1055,7 @@ The (unique) ID of the VM. Verbose output format +[[cli_pct_stop]] *pct stop* `` `[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* `` 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* `` Create a Template. @@ -1053,6 +1091,7 @@ Create a Template. The (unique) ID of the VM. +[[cli_pct_unlock]] *pct unlock* `` Unlock the VM. @@ -1061,6 +1100,7 @@ Unlock the VM. The (unique) ID of the VM. +[[cli_pct_unmount]] *pct unmount* `` Unmount the container's filesystem. diff --git a/pve-firewall.8-synopsis.adoc b/pve-firewall.8-synopsis.adoc index 93675e5..84639d8 100644 --- a/pve-firewall.8-synopsis.adoc +++ b/pve-firewall.8-synopsis.adoc @@ -1,9 +1,12 @@ +[[cli_pve-firewall]] *pve-firewall* ` [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 diff --git a/pve-ha-crm.8-synopsis.adoc b/pve-ha-crm.8-synopsis.adoc index 5e1a4f9..66b5a04 100644 --- a/pve-ha-crm.8-synopsis.adoc +++ b/pve-ha-crm.8-synopsis.adoc @@ -1,5 +1,7 @@ +[[cli_pve-ha-crm]] *pve-ha-crm* ` [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. diff --git a/pve-ha-lrm.8-synopsis.adoc b/pve-ha-lrm.8-synopsis.adoc index bda0678..030e60f 100644 --- a/pve-ha-lrm.8-synopsis.adoc +++ b/pve-ha-lrm.8-synopsis.adoc @@ -1,5 +1,7 @@ +[[cli_pve-ha-lrm]] *pve-ha-lrm* ` [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. diff --git a/pveam.1-synopsis.adoc b/pveam.1-synopsis.adoc index 36e559f..fb510a5 100644 --- a/pveam.1-synopsis.adoc +++ b/pveam.1-synopsis.adoc @@ -1,5 +1,7 @@ +[[cli_pveam]] *pveam* ` [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* `