pmgbackup.1-synopsis.adoc

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