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