pmgbackup.1-synopsis.adoc

   1 *pmgbackup* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pmgbackup backup* `[OPTIONS]`
   4
   5 Backup the system configuration.
   6
   7 `--notify` `<always | error | never>` ('default =' `never`)::
   8
   9 Specify when to notify via e-mail
  10
  11 `--statistic` `<boolean>` ('default =' `1`)::
  12
  13 Backup statistic databases.
  14
  15 *pmgbackup help* `[OPTIONS]`
  16
  17 Get help about specified command.
  18
  19 `--extra-args` `<array>` ::
  20
  21 Shows help for a specific command
  22
  23 `--verbose` `<boolean>` ::
  24
  25 Verbose output format.
  26
  27 *pmgbackup list*
  28
  29 List all stored backups (files named proxmox-backup_{DATE}.tgz).
  30
  31 *pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`
  32
  33 Create a new backup and prune the backup group afterwards, if configured.
  34
  35 `<remote>`: `<string>` ::
  36
  37 Proxmox Backup Server ID.
  38
  39 `--notify` `<always | error | never>` ('default =' `never`)::
  40
  41 Specify when to notify via e-mail
  42
  43 `--statistic` `<boolean>` ('default =' `1`)::
  44
  45 Backup statistic databases.
  46
  47 *pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`
  48
  49 Forget a snapshot
  50
  51 `<remote>`: `<string>` ::
  52
  53 Proxmox Backup Server ID.
  54
  55 `<backup-id>`: `<string>` ::
  56
  57 ID (hostname) of backup snapshot
  58
  59 `<backup-time>`: `<string>` ::
  60
  61 Backup time in RFC 3339 format
  62
  63 *pmgbackup proxmox-backup job create* `<remote>` `[OPTIONS]`
  64
  65 Create backup schedule
  66
  67 `<remote>`: `<string>` ::
  68
  69 Proxmox Backup Server ID.
  70
  71 `--delay` `[0-9a-zA-Z. ]+` ('default =' `5min`)::
  72
  73 Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)
  74
  75 `--schedule` `[0-9a-zA-Z*.:,\-/ ]+` ('default =' `daily`)::
  76
  77 Schedule for the backup (OnCalendar setting of the systemd.timer)
  78
  79 *pmgbackup proxmox-backup job delete* `<remote>`
  80
  81 Delete backup schedule
  82
  83 `<remote>`: `<string>` ::
  84
  85 Proxmox Backup Server ID.
  86
  87 *pmgbackup proxmox-backup job show* `<remote>` `[FORMAT_OPTIONS]`
  88
  89 Get timer specification
  90
  91 `<remote>`: `<string>` ::
  92
  93 Proxmox Backup Server ID.
  94
  95 *pmgbackup proxmox-backup list* `<remote>` `[FORMAT_OPTIONS]`
  96
  97 Get snapshots stored on remote.
  98
  99 `<remote>`: `<string>` ::
 100
 101 Proxmox Backup Server ID.
 102
 103 *pmgbackup proxmox-backup remote add* `<remote> --datastore <string> --server <string>` `[OPTIONS]`
 104
 105 Add Proxmox Backup Server remote instance.
 106
 107 `<remote>`: `<string>` ::
 108
 109 Proxmox Backup Server ID.
 110
 111 `--datastore` `<string>` ::
 112
 113 Proxmox Backup Server datastore name.
 114
 115 `--disable` `<boolean>` ::
 116
 117 Flag to disable (deactivate) the entry.
 118
 119 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
 120
 121 Certificate SHA 256 fingerprint.
 122
 123 `--include-statistics` `<boolean>` ::
 124
 125 Include statistics in scheduled backups
 126
 127 `--keep-daily` `<N>` ::
 128
 129 Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
 130
 131 `--keep-hourly` `<N>` ::
 132
 133 Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
 134
 135 `--keep-last` `<N>` ::
 136
 137 Keep the last <N> backups.
 138
 139 `--keep-monthly` `<N>` ::
 140
 141 Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
 142
 143 `--keep-weekly` `<N>` ::
 144
 145 Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.
 146
 147 `--keep-yearly` `<N>` ::
 148
 149 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 150
 151 `--notify` `<always | error | never>` ::
 152
 153 Specify when to notify via e-mail
 154
 155 `--password` `<password>` ::
 156
 157 Password or API token secret for the user on the Proxmox Backup Server.
 158
 159 `--server` `<string>` ::
 160
 161 Proxmox Backup Server address.
 162
 163 `--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 164
 165 Username or API token ID on the Proxmox Backup Server
 166
 167 *pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]`
 168
 169 List all configured Proxmox Backup Server instances.
 170
 171 *pmgbackup proxmox-backup remote remove* `<remote>`
 172
 173 Delete an PBS remote
 174
 175 `<remote>`: `<string>` ::
 176
 177 Profile ID.
 178
 179 *pmgbackup proxmox-backup remote set* `<remote>` `[OPTIONS]`
 180
 181 Update PBS remote settings.
 182
 183 `<remote>`: `<string>` ::
 184
 185 Proxmox Backup Server ID.
 186
 187 `--datastore` `<string>` ::
 188
 189 Proxmox Backup Server datastore name.
 190
 191 `--delete` `<string>` ::
 192
 193 A list of settings you want to delete.
 194
 195 `--digest` `<string>` ::
 196
 197 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 198
 199 `--disable` `<boolean>` ::
 200
 201 Flag to disable (deactivate) the entry.
 202
 203 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
 204
 205 Certificate SHA 256 fingerprint.
 206
 207 `--include-statistics` `<boolean>` ::
 208
 209 Include statistics in scheduled backups
 210
 211 `--keep-daily` `<N>` ::
 212
 213 Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
 214
 215 `--keep-hourly` `<N>` ::
 216
 217 Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
 218
 219 `--keep-last` `<N>` ::
 220
 221 Keep the last <N> backups.
 222
 223 `--keep-monthly` `<N>` ::
 224
 225 Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
 226
 227 `--keep-weekly` `<N>` ::
 228
 229 Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.
 230
 231 `--keep-yearly` `<N>` ::
 232
 233 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 234
 235 `--notify` `<always | error | never>` ::
 236
 237 Specify when to notify via e-mail
 238
 239 `--password` `<password>` ::
 240
 241 Password or API token secret for the user on the Proxmox Backup Server.
 242
 243 `--server` `<string>` ::
 244
 245 Proxmox Backup Server address.
 246
 247 `--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 248
 249 Username or API token ID on the Proxmox Backup Server
 250
 251 *pmgbackup proxmox-backup restore* `<remote> <backup-id> <backup-time>` `[OPTIONS]`
 252
 253 Restore the system configuration.
 254
 255 `<remote>`: `<string>` ::
 256
 257 Proxmox Backup Server ID.
 258
 259 `<backup-id>`: `<string>` ::
 260
 261 backup-id (hostname) of backup snapshot
 262
 263 `<backup-time>`: `<string>` ::
 264
 265 backup-time to restore
 266
 267 `--config` `<boolean>` ('default =' `0`)::
 268
 269 Restore system configuration.
 270
 271 `--database` `<boolean>` ('default =' `1`)::
 272
 273 Restore the rule database. This is the default.
 274
 275 `--statistic` `<boolean>` ('default =' `0`)::
 276
 277 Restore statistic databases. Only considered when you restore the 'database'.
 278
 279 *pmgbackup restore* `--filename <string>` `[OPTIONS]`
 280
 281 Restore the system configuration.
 282
 283 `--config` `<boolean>` ('default =' `0`)::
 284
 285 Restore system configuration.
 286
 287 `--database` `<boolean>` ('default =' `1`)::
 288
 289 Restore the rule database. This is the default.
 290
 291 `--filename` `pmg-backup_[0-9A-Za-z_-]+\.tgz` ::
 292
 293 The backup file name.
 294
 295 `--statistic` `<boolean>` ('default =' `0`)::
 296
 297 Restore statistic databases. Only considered when you restore the 'database'.
 298
 299