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

*pvesr* `<COMMAND> [ARGS] [OPTIONS]`

*pvesr create-local-job* `<id> <target>` `[OPTIONS]`

Create a new replication job

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

`<target>`: `<string>` ::

Target node.

`--comment` `<string>` ::

Description.

`--disable` `<boolean>` ::

Flag to disable/deactivate the entry.

`--rate` `<number> (1 - N)` ::

Rate limit in mbps (megabytes per second) as floating point number.

`--remove_job` `<full | local>` ::

Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.

`--schedule` `<string>` ('default =' `*/15`)::

Storage replication schedule. The format is a subset of `systemd` calendar events.

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

For internal use, to detect if the guest was stolen.

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

Mark replication job for removal.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

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

Will remove the jobconfig entry, but will not cleanup.

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

Keep replicated data at target (do not remove).

*pvesr disable* `<id>`

Disable a replication job.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

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.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

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
timestamps different than <last_sync>.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

`<extra-args>`: `<array>` ::

The list of volume IDs to consider.

`--last_sync` `<integer> (0 - N)` ::

Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.

*pvesr help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*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
before replication starts. This call is for internal use, and return a JSON
object on stdout. The method first test if VM <vmid> reside on the local
node. If so, stop immediately. After that the method scans all volume IDs
for snapshots, and removes all replications snapshots with timestamps
different than <last_sync>. It also removes any unused volumes. Returns a
hash with boolean markers for all volumes with existing replication
snapshots.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

`<extra-args>`: `<array>` ::

The list of volume IDs to consider.

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

Allow to remove all existion volumes (empty volume list).

`--last_sync` `<integer> (0 - N)` ::

Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots get removed.

`--parent_snapname` `<string>` ::

The name of the snapshot.

`--scan` `<string>` ::

List of storage IDs to scan for stale volumes.

*pvesr read* `<id>`

Read replication job configuration.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

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)
sync jobs.

`--id` `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

`--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>`

Schedule replication job to start as soon as possible.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

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.
It will accept the job state as ja JSON obj.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<state>`: `<string>` ::

Job state as JSON decoded string.

*pvesr status* `[OPTIONS]`

List status of all replication jobs on this node.

`--guest` `<integer> (1 - N)` ::

Only list replication jobs for this guest.

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

Update replication job configuration.

`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::

Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.

`--comment` `<string>` ::

Description.

`--delete` `<string>` ::

A list of settings you want to delete.

`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`--disable` `<boolean>` ::

Flag to disable/deactivate the entry.

`--rate` `<number> (1 - N)` ::

Rate limit in mbps (megabytes per second) as floating point number.

`--remove_job` `<full | local>` ::

Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.

`--schedule` `<string>` ('default =' `*/15`)::

Storage replication schedule. The format is a subset of `systemd` calendar events.

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

For internal use, to detect if the guest was stolen.
Commit	Line	Data
	1	pvesr `<COMMAND> [ARGS] [OPTIONS]`
	2
	3	pvesr create-local-job `<id> <target>` `[OPTIONS]`
	4
	5	Create a new replication job
	6
	7	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	8
	9	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	10
	11	`<target>`: `<string>` ::
	12
	13	Target node.
	14
	15	`--comment` `<string>` ::
	16
	17	Description.
	18
	19	`--disable` `<boolean>` ::
	20
	21	Flag to disable/deactivate the entry.
	22
	23	`--rate` `<number> (1 - N)` ::
	24
	25	Rate limit in mbps (megabytes per second) as floating point number.
	26
	27	`--remove_job` `<full \| local>` ::
	28
	29	Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.
	30
	31	`--schedule` `<string>` ('default =' `*/15`)::
	32
	33	Storage replication schedule. The format is a subset of `systemd` calendar events.
	34
	35	`--source` `<string>` ::
	36
	37	For internal use, to detect if the guest was stolen.
	38
	39	pvesr delete `<id>` `[OPTIONS]`
	40
	41	Mark replication job for removal.
	42
	43	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	44
	45	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	46
	47	`--force` `<boolean>` ('default =' `0`)::
	48
	49	Will remove the jobconfig entry, but will not cleanup.
	50
	51	`--keep` `<boolean>` ('default =' `0`)::
	52
	53	Keep replicated data at target (do not remove).
	54
	55	pvesr disable `<id>`
	56
	57	Disable a replication job.
	58
	59	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	60
	61	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	62
	63	pvesr enable `<id>`
	64
	65	Enable a replication job.
	66
	67	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	68
	69	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	70
	71	pvesr finalize-local-job `<id> [<extra-args>]` `[OPTIONS]`
	72
	73	Finalize a replication job. This removes all replications snapshots with
	74	timestamps different than <last_sync>.
	75
	76	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	77
	78	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	79
	80	`<extra-args>`: `<array>` ::
	81
	82	The list of volume IDs to consider.
	83
	84	`--last_sync` `<integer> (0 - N)` ::
	85
	86	Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
	87
	88	pvesr help `[OPTIONS]`
	89
	90	Get help about specified command.
	91
	92	`--extra-args` `<array>` ::
	93
	94	Shows help for a specific command
	95
	96	`--verbose` `<boolean>` ::
	97
	98	Verbose output format.
	99
	100	pvesr list
	101
	102	List replication jobs.
	103
	104	pvesr prepare-local-job `<id> [<extra-args>]` `[OPTIONS]`
	105
	106	Prepare for starting a replication job. This is called on the target node
	107	before replication starts. This call is for internal use, and return a JSON
	108	object on stdout. The method first test if VM <vmid> reside on the local
	109	node. If so, stop immediately. After that the method scans all volume IDs
	110	for snapshots, and removes all replications snapshots with timestamps
	111	different than <last_sync>. It also removes any unused volumes. Returns a
	112	hash with boolean markers for all volumes with existing replication
	113	snapshots.
	114
	115	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	116
	117	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	118
	119	`<extra-args>`: `<array>` ::
	120
	121	The list of volume IDs to consider.
	122
	123	`--force` `<boolean>` ('default =' `0`)::
	124
	125	Allow to remove all existion volumes (empty volume list).
	126
	127	`--last_sync` `<integer> (0 - N)` ::
	128
	129	Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots get removed.
	130
	131	`--parent_snapname` `<string>` ::
	132
	133	The name of the snapshot.
	134
	135	`--scan` `<string>` ::
	136
	137	List of storage IDs to scan for stale volumes.
	138
	139	pvesr read `<id>`
	140
	141	Read replication job configuration.
	142
	143	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	144
	145	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	146
	147	pvesr run `[OPTIONS]`
	148
	149	This method is called by the systemd-timer and executes all (or a specific)
	150	sync jobs.
	151
	152	`--id` `[1-9][0-9]{2,8}-\d{1,9}` ::
	153
	154	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	155
	156	`--mail` `<boolean>` ('default =' `0`)::
	157
	158	Send an email notification in case of a failure.
	159
	160	`--verbose` `<boolean>` ('default =' `0`)::
	161
	162	Print more verbose logs to stdout.
	163
	164	pvesr schedule-now `<id>`
	165
	166	Schedule replication job to start as soon as possible.
	167
	168	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	169
	170	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	171
	172	pvesr set-state `<vmid> <state>`
	173
	174	Set the job replication state on migration. This call is for internal use.
	175	It will accept the job state as ja JSON obj.
	176
	177	`<vmid>`: `<integer> (1 - N)` ::
	178
	179	The (unique) ID of the VM.
	180
	181	`<state>`: `<string>` ::
	182
	183	Job state as JSON decoded string.
	184
	185	pvesr status `[OPTIONS]`
	186
	187	List status of all replication jobs on this node.
	188
	189	`--guest` `<integer> (1 - N)` ::
	190
	191	Only list replication jobs for this guest.
	192
	193	pvesr update `<id>` `[OPTIONS]`
	194
	195	Update replication job configuration.
	196
	197	`<id>`: `[1-9][0-9]{2,8}-\d{1,9}` ::
	198
	199	Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
	200
	201	`--comment` `<string>` ::
	202
	203	Description.
	204
	205	`--delete` `<string>` ::
	206
	207	A list of settings you want to delete.
	208
	209	`--digest` `<string>` ::
	210
	211	Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	212
	213	`--disable` `<boolean>` ::
	214
	215	Flag to disable/deactivate the entry.
	216
	217	`--rate` `<number> (1 - N)` ::
	218
	219	Rate limit in mbps (megabytes per second) as floating point number.
	220
	221	`--remove_job` `<full \| local>` ::
	222
	223	Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file.
	224
	225	`--schedule` `<string>` ('default =' `*/15`)::
	226
	227	Storage replication schedule. The format is a subset of `systemd` calendar events.
	228
	229	`--source` `<string>` ::
	230
	231	For internal use, to detect if the guest was stolen.
	232
	233