pvesr.1-synopsis.adoc

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