]>
Commit | Line | Data |
---|---|---|
efcfc6d8 DM |
1 | *pvesr* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
5d9c884c DM |
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 | ||
2489d6df | 15 | `--comment` `<string>` :: |
5d9c884c DM |
16 | |
17 | Description. | |
18 | ||
2489d6df | 19 | `--disable` `<boolean>` :: |
5d9c884c DM |
20 | |
21 | Flag to disable/deactivate the entry. | |
22 | ||
2489d6df | 23 | `--rate` `<number> (1 - N)` :: |
5d9c884c DM |
24 | |
25 | Rate limit in mbps (megabytes per second) as floating point number. | |
26 | ||
2489d6df | 27 | `--remove_job` `<full | local>` :: |
5d9c884c DM |
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 | ||
2489d6df | 31 | `--schedule` `<string>` ('default =' `*/15`):: |
5d9c884c | 32 | |
c5aa7e14 | 33 | Storage replication schedule. The format is a subset of `systemd` calendar events. |
5d9c884c | 34 | |
a9a8e3d1 DM |
35 | `--source` `<string>` :: |
36 | ||
37 | Source of the replication. | |
38 | ||
5d9c884c DM |
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 | ||
2489d6df | 47 | `--force` `<boolean>` ('default =' `0`):: |
5d9c884c DM |
48 | |
49 | Will remove the jobconfig entry, but will not cleanup. | |
50 | ||
2489d6df | 51 | `--keep` `<boolean>` ('default =' `0`):: |
5d9c884c DM |
52 | |
53 | Keep replicated data at target (do not remove). | |
54 | ||
5d9c884c DM |
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 | ||
5d9c884c DM |
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 | ||
5d9c884c DM |
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 | ||
2489d6df | 84 | `--last_sync` `<integer> (0 - N)` :: |
5d9c884c DM |
85 | |
86 | Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed. | |
87 | ||
35a75dd3 | 88 | *pvesr help* `[OPTIONS]` |
efcfc6d8 DM |
89 | |
90 | Get help about specified command. | |
91 | ||
35a75dd3 | 92 | `--extra-args` `<array>` :: |
efcfc6d8 | 93 | |
35a75dd3 | 94 | Shows help for a specific command |
efcfc6d8 | 95 | |
2489d6df | 96 | `--verbose` `<boolean>` :: |
efcfc6d8 DM |
97 | |
98 | Verbose output format. | |
99 | ||
5d9c884c | 100 | *pvesr list* |
efcfc6d8 DM |
101 | |
102 | List replication jobs. | |
103 | ||
5d9c884c DM |
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 | ||
2489d6df | 123 | `--force` `<boolean>` ('default =' `0`):: |
5d9c884c DM |
124 | |
125 | Allow to remove all existion volumes (empty volume list). | |
126 | ||
2489d6df | 127 | `--last_sync` `<integer> (0 - N)` :: |
5d9c884c DM |
128 | |
129 | Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots get removed. | |
130 | ||
2489d6df | 131 | `--parent_snapname` `<string>` :: |
5d9c884c DM |
132 | |
133 | The name of the snapshot. | |
134 | ||
2489d6df | 135 | `--scan` `<string>` :: |
5d9c884c DM |
136 | |
137 | List of storage IDs to scan for stale volumes. | |
138 | ||
5d9c884c DM |
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 | ||
5d9c884c DM |
147 | *pvesr run* `[OPTIONS]` |
148 | ||
149 | This method is called by the systemd-timer and executes all (or a specific) | |
150 | sync jobs. | |
151 | ||
2489d6df | 152 | `--id` `[1-9][0-9]{2,8}-\d{1,9}` :: |
5d9c884c DM |
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 | ||
35a75dd3 | 156 | `--mail` `<boolean>` ('default =' `0`):: |
5d9c884c | 157 | |
35a75dd3 | 158 | Send an email notification in case of a failure. |
5d9c884c | 159 | |
35a75dd3 | 160 | `--verbose` `<boolean>` ('default =' `0`):: |
5d9c884c | 161 | |
35a75dd3 | 162 | Print more verbose logs to stdout. |
5d9c884c DM |
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 | ||
5d9c884c DM |
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 | ||
5d9c884c DM |
185 | *pvesr status* `[OPTIONS]` |
186 | ||
187 | List status of all replication jobs on this node. | |
188 | ||
2489d6df | 189 | `--guest` `<integer> (1 - N)` :: |
5d9c884c DM |
190 | |
191 | Only list replication jobs for this guest. | |
192 | ||
5d9c884c DM |
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 | ||
2489d6df | 201 | `--comment` `<string>` :: |
5d9c884c DM |
202 | |
203 | Description. | |
204 | ||
2489d6df | 205 | `--delete` `<string>` :: |
5d9c884c DM |
206 | |
207 | A list of settings you want to delete. | |
208 | ||
2489d6df | 209 | `--digest` `<string>` :: |
5d9c884c DM |
210 | |
211 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
212 | ||
2489d6df | 213 | `--disable` `<boolean>` :: |
5d9c884c DM |
214 | |
215 | Flag to disable/deactivate the entry. | |
216 | ||
2489d6df | 217 | `--rate` `<number> (1 - N)` :: |
5d9c884c DM |
218 | |
219 | Rate limit in mbps (megabytes per second) as floating point number. | |
220 | ||
2489d6df | 221 | `--remove_job` `<full | local>` :: |
5d9c884c DM |
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 | ||
2489d6df | 225 | `--schedule` `<string>` ('default =' `*/15`):: |
efcfc6d8 | 226 | |
c5aa7e14 | 227 | Storage replication schedule. The format is a subset of `systemd` calendar events. |
efcfc6d8 | 228 | |
a9a8e3d1 DM |
229 | `--source` `<string>` :: |
230 | ||
231 | Source of the replication. | |
232 | ||
efcfc6d8 | 233 |