pveceph: add pg_num for easier search

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

diff --git a/pvesr.1-synopsis.adoc b/pvesr.1-synopsis.adoc
index 5ad776e7d74c571c3c762502972fbebef415b1dc..95b4966d29ab85218ac0eee8019258359d23db4b 100644 (file)
--- a/pvesr.1-synopsis.adoc
+++ b/pvesr.1-synopsis.adoc
@@ -32,7 +32,9 @@ Mark the replication job for removal. The job will remove all local replication
 
 Storage replication schedule. The format is a subset of `systemd` calender events.
 
 
 Storage replication schedule. The format is a subset of `systemd` calender events.
 

+`--source` `<string>` ::

 
 

+Source of the replication.

 
 *pvesr delete* `<id>` `[OPTIONS]`
 
 
 *pvesr delete* `<id>` `[OPTIONS]`
 


@@ -50,9 +52,6 @@ Will remove the jobconfig entry, but will not cleanup.
 
 Keep replicated data at target (do not remove).
 
 
 Keep replicated data at target (do not remove).
 

-
-
-

 *pvesr disable* `<id>`
 
 Disable a replication job.
 *pvesr disable* `<id>`
 
 Disable a replication job.


@@ -61,8 +60,6 @@ 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>'.
 
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 

-
-

 *pvesr enable* `<id>`
 
 Enable a replication job.
 *pvesr enable* `<id>`
 
 Enable a replication job.


@@ -71,8 +68,6 @@ 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>'.
 
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 

-
-

 *pvesr finalize-local-job* `<id> [<extra-args>]` `[OPTIONS]`
 
 Finalize a replication job. This removes all replications snapshots with
 *pvesr finalize-local-job* `<id> [<extra-args>]` `[OPTIONS]`
 
 Finalize a replication job. This removes all replications snapshots with


@@ -90,31 +85,22 @@ The list of volume IDs to consider.
 
 Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
 
 
 Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
 

-
-
-
-*pvesr help* `[<cmd>]` `[OPTIONS]`
+*pvesr help* `[OPTIONS]`

 
 Get help about specified command.
 
 
 Get help about specified command.
 

-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::

 
 

-Command name
+Shows help for a specific command

 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 
 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 

-
-
-

 *pvesr list*
 
 List replication jobs.
 
 *pvesr list*
 
 List replication jobs.
 

-
-
-

 *pvesr prepare-local-job* `<id> [<extra-args>]` `[OPTIONS]`
 
 Prepare for starting a replication job. This is called on the target node
 *pvesr prepare-local-job* `<id> [<extra-args>]` `[OPTIONS]`
 
 Prepare for starting a replication job. This is called on the target node


@@ -150,9 +136,6 @@ The name of the snapshot.
 
 List of storage IDs to scan for stale volumes.
 
 
 List of storage IDs to scan for stale volumes.
 

-
-
-

 *pvesr read* `<id>`
 
 Read replication job configuration.
 *pvesr read* `<id>`
 
 Read replication job configuration.


@@ -161,9 +144,6 @@ 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>'.
 
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 

-
-
-

 *pvesr run* `[OPTIONS]`
 
 This method is called by the systemd-timer and executes all (or a specific)
 *pvesr run* `[OPTIONS]`
 
 This method is called by the systemd-timer and executes all (or a specific)


@@ -173,12 +153,13 @@ sync jobs.
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 

-`--verbose` `<boolean>` ('default =' `0`)::
-
-Print more verbose logs to stdout.
+`--mail` `<boolean>` ('default =' `0`)::

 
 

+Send an email notification in case of a failure.

 
 

+`--verbose` `<boolean>` ('default =' `0`)::

 
 

+Print more verbose logs to stdout.

 
 *pvesr schedule-now* `<id>`
 
 
 *pvesr schedule-now* `<id>`
 


@@ -188,9 +169,6 @@ 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>'.
 
 
 Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
 

-
-
-

 *pvesr set-state* `<vmid> <state>`
 
 Set the job replication state on migration. This call is for internal use.
 *pvesr set-state* `<vmid> <state>`
 
 Set the job replication state on migration. This call is for internal use.


@@ -204,9 +182,6 @@ The (unique) ID of the VM.
 
 Job state as JSON decoded string.
 
 
 Job state as JSON decoded string.
 

-
-
-

 *pvesr status* `[OPTIONS]`
 
 List status of all replication jobs on this node.
 *pvesr status* `[OPTIONS]`
 
 List status of all replication jobs on this node.


@@ -215,9 +190,6 @@ List status of all replication jobs on this node.
 
 Only list replication jobs for this guest.
 
 
 Only list replication jobs for this guest.
 

-
-
-

 *pvesr update* `<id>` `[OPTIONS]`
 
 Update replication job configuration.
 *pvesr update* `<id>` `[OPTIONS]`
 
 Update replication job configuration.


@@ -254,6 +226,8 @@ Mark the replication job for removal. The job will remove all local replication
 
 Storage replication schedule. The format is a subset of `systemd` calender events.
 
 
 Storage replication schedule. The format is a subset of `systemd` calender events.
 

+`--source` `<string>` ::

 
 

+Source of the replication.