[pmg-docs.git] / pmgbackup.1-synopsis.adoc

*pmgbackup* `<COMMAND> [ARGS] [OPTIONS]`

*pmgbackup backup* `[OPTIONS]`

Backup the system configuration.

`--notify` `<always | error | never>` ('default =' `never`)::

Specify when to notify via e-mail

`--statistic` `<boolean>` ('default =' `1`)::

Backup statistic databases.

*pmgbackup help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pmgbackup list*

List all stored backups (files named proxmox-backup_{DATE}.tgz).

*pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`

Create a new backup and prune the backup group afterwards, if configured.

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`--notify` `<always | error | never>` ('default =' `never`)::

Specify when to notify via e-mail

`--statistic` `<boolean>` ('default =' `1`)::

Backup statistic databases.

*pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`

Forget a snapshot

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`<backup-id>`: `<string>` ::

ID (hostname) of backup snapshot

`<backup-time>`: `<string>` ::

Backup time in RFC 3339 format

*pmgbackup proxmox-backup job create* `<remote>` `[OPTIONS]`

Create backup schedule

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`--delay` `[0-9a-zA-Z. ]+` ('default =' `5min`)::

Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)

`--schedule` `[0-9a-zA-Z*.:,\-/ ]+` ('default =' `daily`)::

Schedule for the backup (OnCalendar setting of the systemd.timer)

*pmgbackup proxmox-backup job delete* `<remote>`

Delete backup schedule

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

*pmgbackup proxmox-backup job show* `<remote>` `[FORMAT_OPTIONS]`

Get timer specification

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

*pmgbackup proxmox-backup list* `<remote>` `[FORMAT_OPTIONS]`

Get snapshots stored on remote.

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

*pmgbackup proxmox-backup remote add* `<remote> --datastore <string> --server <string>` `[OPTIONS]`

Add Proxmox Backup Server remote instance.

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::

Proxmox Backup Server datastore name.

`--disable` `<boolean>` ::

Flag to disable (deactivate) the entry.

`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::

Certificate SHA 256 fingerprint.

`--include-statistics` `<boolean>` ::

Include statistics in scheduled backups

`--keep-daily` `<N>` ::

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.

`--keep-hourly` `<N>` ::

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.

`--keep-last` `<N>` ::

Keep the last <N> backups.

`--keep-monthly` `<N>` ::

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.

`--keep-weekly` `<N>` ::

Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.

`--keep-yearly` `<N>` ::

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.

`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::

Proxmox Backup Server namespace in the datastore, defaults to the root NS.

`--notify` `<always | error | never>` ::

Specify when to notify via e-mail

`--password` `<password>` ::

Password or API token secret for the user on the Proxmox Backup Server.

`--port` `<integer> (1 - 65535)` ('default =' `8007`)::

Non-default port for Proxmox Backup Server.

`--server` `<string>` ::

Proxmox Backup Server address.

`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::

Username or API token ID on the Proxmox Backup Server

*pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]`

List all configured Proxmox Backup Server instances.

*pmgbackup proxmox-backup remote remove* `<remote>`

Delete an PBS remote

`<remote>`: `<string>` ::

Profile ID.

*pmgbackup proxmox-backup remote set* `<remote>` `[OPTIONS]`

Update PBS remote settings.

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::

Proxmox Backup Server datastore name.

`--delete` `<string>` ::

A list of settings you want to delete.

`--digest` `<string>` ::

Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.

`--disable` `<boolean>` ::

Flag to disable (deactivate) the entry.

`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::

Certificate SHA 256 fingerprint.

`--include-statistics` `<boolean>` ::

Include statistics in scheduled backups

`--keep-daily` `<N>` ::

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.

`--keep-hourly` `<N>` ::

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.

`--keep-last` `<N>` ::

Keep the last <N> backups.

`--keep-monthly` `<N>` ::

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.

`--keep-weekly` `<N>` ::

Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.

`--keep-yearly` `<N>` ::

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.

`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::

Proxmox Backup Server namespace in the datastore, defaults to the root NS.

`--notify` `<always | error | never>` ::

Specify when to notify via e-mail

`--password` `<password>` ::

Password or API token secret for the user on the Proxmox Backup Server.

`--port` `<integer> (1 - 65535)` ('default =' `8007`)::

Non-default port for Proxmox Backup Server.

`--server` `<string>` ::

Proxmox Backup Server address.

`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::

Username or API token ID on the Proxmox Backup Server

*pmgbackup proxmox-backup restore* `<remote> <backup-id> <backup-time>` `[OPTIONS]`

Restore the system configuration.

`<remote>`: `<string>` ::

Proxmox Backup Server ID.

`<backup-id>`: `<string>` ::

backup-id (hostname) of backup snapshot

`<backup-time>`: `<string>` ::

backup-time to restore

`--config` `<boolean>` ('default =' `0`)::

Restore system configuration.

`--database` `<boolean>` ('default =' `1`)::

Restore the rule database. This is the default.

`--statistic` `<boolean>` ('default =' `0`)::

Restore statistic databases. Only considered when you restore the 'database'.

*pmgbackup restore* `--filename <string>` `[OPTIONS]`

Restore the system configuration.

`--config` `<boolean>` ('default =' `0`)::

Restore system configuration.

`--database` `<boolean>` ('default =' `1`)::

Restore the rule database. This is the default.

`--filename` `pmg-backup_[0-9A-Za-z_-]+\.tgz` ::

The backup file name.

`--statistic` `<boolean>` ('default =' `0`)::

Restore statistic databases. Only considered when you restore the 'database'.
Commit	Line	Data
274b47fc DM	1	pmgbackup `<COMMAND> [ARGS] [OPTIONS]`
	2
	3	pmgbackup backup `[OPTIONS]`
	4
	5	Backup the system configuration.
	6
c5ccf1ab TL	7	`--notify` `<always \| error \| never>` ('default =' `never`)::
	8
	9	Specify when to notify via e-mail
	10
274b47fc DM	11	`--statistic` `<boolean>` ('default =' `1`)::
	12
	13	Backup statistic databases.
	14
b81b1f95	15	pmgbackup help `[OPTIONS]`
274b47fc DM	16
	17	Get help about specified command.
	18
b81b1f95	19	`--extra-args` `<array>` ::
274b47fc	20
b81b1f95	21	Shows help for a specific command
274b47fc DM	22
	23	`--verbose` `<boolean>` ::
	24
	25	Verbose output format.
	26
274b47fc DM	27	pmgbackup list
	28
	29	List all stored backups (files named proxmox-backup_{DATE}.tgz).
	30
c5ccf1ab	31	pmgbackup proxmox-backup backup `<remote>` `[OPTIONS]`
ab2b846b TL	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
c5ccf1ab TL	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
ab2b846b TL	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
0b9926d3	111	`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
ab2b846b TL	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
c5ccf1ab TL	123	`--include-statistics` `<boolean>` ::
	124
	125	Include statistics in scheduled backups
	126
ab2b846b TL	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
0b9926d3 TL	151	`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-])/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]))?` ::
	152
	153	Proxmox Backup Server namespace in the datastore, defaults to the root NS.
	154
c5ccf1ab TL	155	`--notify` `<always \| error \| never>` ::
	156
	157	Specify when to notify via e-mail
	158
ab2b846b TL	159	`--password` `<password>` ::
	160
	161	Password or API token secret for the user on the Proxmox Backup Server.
	162
cbd73e8f TL	163	`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
	164
	165	Non-default port for Proxmox Backup Server.
	166
ab2b846b TL	167	`--server` `<string>` ::
	168
	169	Proxmox Backup Server address.
	170
c5ccf1ab	171	`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
ab2b846b TL	172
	173	Username or API token ID on the Proxmox Backup Server
	174
	175	pmgbackup proxmox-backup remote list `[FORMAT_OPTIONS]`
	176
	177	List all configured Proxmox Backup Server instances.
	178
	179	pmgbackup proxmox-backup remote remove `<remote>`
	180
	181	Delete an PBS remote
	182
	183	`<remote>`: `<string>` ::
	184
	185	Profile ID.
	186
	187	pmgbackup proxmox-backup remote set `<remote>` `[OPTIONS]`
	188
	189	Update PBS remote settings.
	190
	191	`<remote>`: `<string>` ::
	192
	193	Proxmox Backup Server ID.
	194
0b9926d3	195	`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
ab2b846b TL	196
	197	Proxmox Backup Server datastore name.
	198
	199	`--delete` `<string>` ::
	200
	201	A list of settings you want to delete.
	202
	203	`--digest` `<string>` ::
	204
cbd73e8f	205	Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
ab2b846b TL	206
	207	`--disable` `<boolean>` ::
	208
	209	Flag to disable (deactivate) the entry.
	210
	211	`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
	212
	213	Certificate SHA 256 fingerprint.
	214
c5ccf1ab TL	215	`--include-statistics` `<boolean>` ::
	216
	217	Include statistics in scheduled backups
	218
ab2b846b TL	219	`--keep-daily` `<N>` ::
	220
	221	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.
	222
	223	`--keep-hourly` `<N>` ::
	224
	225	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.
	226
	227	`--keep-last` `<N>` ::
	228
	229	Keep the last <N> backups.
	230
	231	`--keep-monthly` `<N>` ::
	232
	233	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.
	234
	235	`--keep-weekly` `<N>` ::
	236
	237	Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.
	238
	239	`--keep-yearly` `<N>` ::
	240
	241	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.
	242
0b9926d3 TL	243	`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-])/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]))?` ::
	244
	245	Proxmox Backup Server namespace in the datastore, defaults to the root NS.
	246
c5ccf1ab TL	247	`--notify` `<always \| error \| never>` ::
	248
	249	Specify when to notify via e-mail
	250
ab2b846b TL	251	`--password` `<password>` ::
	252
	253	Password or API token secret for the user on the Proxmox Backup Server.
	254
cbd73e8f TL	255	`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
	256
	257	Non-default port for Proxmox Backup Server.
	258
ab2b846b TL	259	`--server` `<string>` ::
	260
	261	Proxmox Backup Server address.
	262
c5ccf1ab	263	`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
ab2b846b TL	264
	265	Username or API token ID on the Proxmox Backup Server
	266
	267	pmgbackup proxmox-backup restore `<remote> <backup-id> <backup-time>` `[OPTIONS]`
	268
	269	Restore the system configuration.
	270
	271	`<remote>`: `<string>` ::
	272
	273	Proxmox Backup Server ID.
	274
	275	`<backup-id>`: `<string>` ::
	276
	277	backup-id (hostname) of backup snapshot
	278
	279	`<backup-time>`: `<string>` ::
	280
	281	backup-time to restore
	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	`--statistic` `<boolean>` ('default =' `0`)::
	292
	293	Restore statistic databases. Only considered when you restore the 'database'.
	294
274b47fc DM	295	pmgbackup restore `--filename <string>` `[OPTIONS]`
	296
	297	Restore the system configuration.
	298
	299	`--config` `<boolean>` ('default =' `0`)::
	300
	301	Restore system configuration.
	302
	303	`--database` `<boolean>` ('default =' `1`)::
	304
	305	Restore the rule database. This is the default.
	306
	307	`--filename` `pmg-backup_[0-9A-Za-z_-]+\.tgz` ::
	308
	309	The backup file name.
	310
	311	`--statistic` `<boolean>` ('default =' `0`)::
	312
	313	Restore statistic databases. Only considered when you restore the 'database'.
	314
	315