basic network reload documentation

[pve-docs.git] / pvenode.1-synopsis.adoc

diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc
index 46ad2b695c714a2f998214a929dccb926f618589..ae7d4b24f630b1ab20d91578fcbedb50c1a9be2c 100644 (file)
--- a/pvenode.1-synopsis.adoc
+++ b/pvenode.1-synopsis.adoc
@@ -8,7 +8,7 @@ Deactivate existing ACME account at CA.
 
 ACME account config file name.
 
 
 ACME account config file name.
 

-*pvenode acme account info* `[<name>]`
+*pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`

 
 Return existing ACME account information.
 
 
 Return existing ACME account information.
 


@@ -77,11 +77,11 @@ DELETE custom certificate chain and key.
 
 Restart pveproxy.
 
 
 Restart pveproxy.
 

-*pvenode cert info*
+*pvenode cert info* `[FORMAT_OPTIONS]`

 
 Get information about node's certificates.
 
 
 Get information about node's certificates.
 

-*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]`
+*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`

 
 Upload or update custom certificate chain and key.
 
 
 Upload or update custom certificate chain and key.
 


@@ -101,10 +101,14 @@ Overwrite existing custom or ACME certificate files.
 
 Restart pveproxy.
 
 
 Restart pveproxy.
 

-*pvenode config get*
+*pvenode config get* `[OPTIONS]`

 
 Get node configuration options.
 
 
 Get node configuration options.
 

+`--property` `<acme | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
+
+Return only a specific property from the node configuration.
+

 *pvenode config set* `[OPTIONS]`
 
 Set node configuration options.
 *pvenode config set* `[OPTIONS]`
 
 Set node configuration options.


@@ -125,6 +129,14 @@ Node description/comment.
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 

+`--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
+
+Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
+
+`--wakeonlan` `<string>` ::
+
+MAC address for wake on LAN
+

 *pvenode help* `[OPTIONS]`
 
 Get help about specified command.
 *pvenode help* `[OPTIONS]`
 
 Get help about specified command.


@@ -137,4 +149,101 @@ Shows help for a specific command
 
 Verbose output format.
 
 
 Verbose output format.
 

+*pvenode migrateall* `<target>` `[OPTIONS]`
+
+Migrate all VMs and Containers.
+
+`<target>`: `<string>` ::
+
+Target node.
+
+`--maxworkers` `<integer> (1 - N)` ::
+
+Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
+
+`--vms` `<string>` ::
+
+Only consider Guests with these IDs.
+
+*pvenode startall* `[OPTIONS]`
+
+Start all VMs and containers located on this node (by default only those
+with onboot=1).
+
+`--force` `<boolean>` ('default =' `off`)::
+
+Issue start command even if virtual guest have 'onboot' not set or set to off.
+
+`--vms` `<string>` ::
+
+Only consider guests from this comma separated list of VMIDs.
+
+*pvenode stopall* `[OPTIONS]`
+
+Stop all VMs and Containers.
+
+`--vms` `<string>` ::
+
+Only consider Guests with these IDs.
+
+*pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Read task list for one node (finished tasks).
+
+`--errors` `<boolean>` ('default =' `0`)::
+
+no description available
+
+`--limit` `<integer> (0 - N)` ('default =' `50`)::
+
+Only list this amount of tasks.
+
+`--source` `<active | all | archive>` ('default =' `archive`)::
+
+List archived, active or all tasks.
+
+`--start` `<integer> (0 - N)` ('default =' `0`)::
+
+List tasks beginning from this offset.
+
+`--typefilter` `<string>` ::
+
+Only list tasks of this type (e.g., vzstart, vzdump).
+
+`--userfilter` `<string>` ::
+
+Only list tasks from this user.
+
+`--vmid` `<integer> (1 - N)` ::
+
+Only list tasks for this VM.
+
+*pvenode task log* `<upid>` `[OPTIONS]`
+
+Read task log.
+
+`<upid>`: `<string>` ::
+
+no description available
+
+`--start` `<integer> (0 - N)` ('default =' `0`)::
+
+no description available
+
+*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
+
+Read task status.
+
+`<upid>`: `<string>` ::
+
+no description available
+
+*pvenode wakeonlan* `<node>`
+
+Try to wake a node via 'wake on LAN' network packet.
+
+`<node>`: `<string>` ::
+
+target node for wake on LAN packet
+