proxmox-tape backup <store> <pool> [OPTIONS]
Backup datastore to tape media pool
<store>:<string>- Datastore name.
<pool>:<string>- Media pool name.
Optional parameters:
--drive<string>- Drive Identifier.
--eject-media<boolean>- Eject media upon job completion.
--export-media-set<boolean>- Export media set upon job completion.
--latest-only<boolean>- Backup latest snapshots only.
--output-formattext|json|json-pretty- Output format.
proxmox-tape backup-job create <id> --drive <string> --pool <string> --store <string> [OPTIONS]
Create a new tape backup job.
<id>:<string>- Job ID.
--drive<string>- Drive Identifier.
--pool<string>- Media pool name.
--store<string>- Datastore name.
Optional parameters:
--comment<string>- Comment (single line).
--schedule<calendar-event>- Run sync job at specified schedule.
--eject-media<boolean>- Eject media upon job completion.
--export-media-set<boolean>- Export media set upon job completion.
--latest-only<boolean>- Backup latest snapshots only.
--notify-user<string>- User ID
proxmox-tape backup-job list [OPTIONS]
Tape backup job list.
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape backup-job remove <id> [OPTIONS]
Remove a tape backup job configuration
<id>:<string>- Job ID.
Optional parameters:
--digest<string>- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
proxmox-tape backup-job run <id>
Run THape Backup Job
<id>:<string>- Job ID.
proxmox-tape backup-job show <id> [OPTIONS]
Show tape backup job configuration
<id>:<string>- Job ID.
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape backup-job update <id> [OPTIONS]
Update the tape backup job
<id>:<string>- Job ID.
Optional parameters:
--comment<string>- Comment (single line).
--delete<array>- List of properties to delete.
--digest<string>- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--drive<string>- Drive Identifier.
--eject-media<boolean>- Eject media upon job completion.
--export-media-set<boolean>- Export media set upon job completion.
--latest-only<boolean>- Backup latest snapshots only.
--notify-user<string>- User ID
--pool<string>- Media pool name.
--schedule<calendar-event>- Run sync job at specified schedule.
--store<string>- Datastore name.
proxmox-tape barcode-label [OPTIONS]
Label media with barcodes from changer device
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
--pool<string>- Media pool name.
proxmox-tape cartridge-memory [OPTIONS]
Read Cartridge Memory (Medium auxiliary memory attributes)
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape catalog [OPTIONS]
Scan media and record content
Optional parameters:
--drive<string>- Drive Identifier.
--force<boolean>- Force overriding existing index.
--output-formattext|json|json-pretty- Output format.
--scan<boolean>- Re-read the whole tape to reconstruct the catalog instead of restoring saved versions.
--verbose<boolean>- Verbose mode - log all found chunks.
proxmox-tape changer config <name> [OPTIONS]
Get tape changer configuration
<name>:<string>- Tape Changer Identifier.
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape changer create <name> --path <string> [OPTIONS]
Create a new changer device
<name>:<string>- Tape Changer Identifier.
--path<string>- Path to Linux generic SCSI device (e.g. '/dev/sg4')
Optional parameters:
--export-slots[<integer>, ...]- A list of slot numbers, comma separated. Those slots are reserved for Import/Export, i.e. any media in those slots are considered to be 'offline'.
proxmox-tape changer list [OPTIONS]
List changers
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape changer remove <name>
Delete a tape changer configuration
<name>:<string>- Tape Changer Identifier.
proxmox-tape changer scan [OPTIONS]
Scan for SCSI tape changers
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape changer status [<name>] [OPTIONS]
Get tape changer status
<name>:<string>- Tape Changer Identifier.
Optional parameters:
--cache<boolean> (default=true)- Use cached value.
--output-formattext|json|json-pretty- Output format.
proxmox-tape changer transfer [<name>] --from <integer> (1 - N) --to <integer> (1 - N)
Transfers media from one slot to another
<name>:<string>- Tape Changer Identifier.
--from<integer> (1 - N)- Source slot number
--to<integer> (1 - N)- Destination slot number
proxmox-tape changer update <name> [OPTIONS]
Update a tape changer configuration
<name>:<string>- Tape Changer Identifier.
Optional parameters:
--delete<array>- List of properties to delete.
--digest<string>- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--export-slots[<integer>, ...]- A list of slot numbers, comma separated. Those slots are reserved for Import/Export, i.e. any media in those slots are considered to be 'offline'.
--path<string>- Path to Linux generic SCSI device (e.g. '/dev/sg4')
proxmox-tape clean [OPTIONS]
Clean drive
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape drive config <name> [OPTIONS]
Get pool configuration
<name>:<string>- Drive Identifier.
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape drive create <name> --path <string> [OPTIONS]
Create a new drive
<name>:<string>- Drive Identifier.
--path<string>- The path to a LTO SCSI-generic tape device (i.e. '/dev/sg0')
Optional parameters:
--changer<string>- Tape Changer Identifier.
--changer-drivenum<integer> (0 - 8) (default=0)- Associated changer drive number (requires option changer)
proxmox-tape drive list [OPTIONS]
List drives
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape drive remove <name>
Delete a drive configuration
<name>:<string>- Drive Identifier.
proxmox-tape drive scan [OPTIONS]
Scan for drives
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape drive update <name> [OPTIONS]
Update a drive configuration
<name>:<string>- Drive Identifier.
Optional parameters:
--changer<string>- Tape Changer Identifier.
--changer-drivenum<integer> (0 - 8) (default=0)- Associated changer drive number (requires option changer)
--delete<array>- List of properties to delete.
--digest<string>- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
--path<string>- The path to a LTO SCSI-generic tape device (i.e. '/dev/sg0')
proxmox-tape eject [OPTIONS]
Eject/Unload drive media
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape eod [OPTIONS]
Move to end of media (MTEOM, used to debug)
Optional parameters:
--drive<string>- Drive Identifier.
proxmox-tape export-media <label-text> [OPTIONS]
Export media with specified label
<label-text>:<string>- Media Label/Barcode.
Optional parameters:
--drive<string>- Drive Identifier.
proxmox-tape format [OPTIONS]
Format media
Optional parameters:
--drive<string>- Drive Identifier.
--fast<boolean> (default=true)- Use fast erase.
--output-formattext|json|json-pretty- Output format.
proxmox-tape help [{<command>}] [OPTIONS]
Get help about specified command (or sub-command).
<command>:<array>- Command. This may be a list in order to spefify nested sub-commands.
Optional parameters:
--verbose<boolean>- Verbose help.
proxmox-tape inventory [OPTIONS]
List (and update) media labels (Changer Inventory)
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
--read-all-labels<boolean>- Load all tapes and try read labels (even if already inventoried)
--read-labels<boolean>- Load unknown tapes and try read labels
proxmox-tape key change-passphrase <fingerprint> [OPTIONS]
Change the encryption key's password.
<fingerprint>:<string>- Tape encryption key fingerprint (sha256).
Optional parameters:
--hint<string>- Password hint.
--kdfnone|scrypt|pbkdf2 (default=scrypt)- Key derivation function for password protected encryption keys.
proxmox-tape key create --hint <string> [OPTIONS]
Create key (read password from stdin)
--hint<string>- Password restore hint.
Optional parameters:
--kdfnone|scrypt|pbkdf2 (default=scrypt)- Key derivation function for password protected encryption keys.
proxmox-tape key list [OPTIONS]
List keys
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape key paperkey <fingerprint> [OPTIONS]
Generate a printable, human readable text file containing the encryption key.
This also includes a scanable QR code for fast key restore.
<fingerprint>:<string>- Tape encryption key fingerprint (sha256).
Optional parameters:
--output-formattext|html- Paperkey output format
--subject<string>- Include the specified subject as title text.
proxmox-tape key remove <fingerprint> [OPTIONS]
Remove a encryption key from the database
Please note that you can no longer access tapes using this key.
<fingerprint>:<string>- Tape encryption key fingerprint (sha256).
Optional parameters:
--digest<string>- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
proxmox-tape key restore [OPTIONS]
Restore encryption key from tape (read password from stdin)
Optional parameters:
--drive<string>- Drive Identifier.
proxmox-tape key show <fingerprint> [OPTIONS]
Print the encryption key's metadata.
<fingerprint>:<string>- Tape encryption key fingerprint (sha256).
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape label --label-text <string> [OPTIONS]
Label media
--label-text<string>- Media Label/Barcode.
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
--pool<string>- Media pool name.
proxmox-tape load-media <label-text> [OPTIONS]
Load media with specified label
<label-text>:<string>- Media Label/Barcode.
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape load-media-from-slot <source-slot> [OPTIONS]
Load media from the specified slot
<source-slot>:<integer> (1 - N)- Source slot number.
Optional parameters:
--drive<string>- Drive Identifier.
proxmox-tape media content [OPTIONS]
List media content
Optional parameters:
--output-formattext|json|json-pretty- Output format.
--backup-id<string>- Backup ID.
--backup-typevm|ct|host- Backup type.
--label-text<string>- Media Label/Barcode.
--media<string>- Media Uuid.
--media-set<string>- MediaSet Uuid (We use the all-zero Uuid to reseve an empty media for a specific pool).
--pool<string>- Media pool name.
proxmox-tape media destroy <label-text> [OPTIONS]
Destroy media (completely remove from database)
<label-text>:<string>- Media Label/Barcode.
Optional parameters:
--force<boolean>- Force removal (even if media is used in a media set).
proxmox-tape media list [OPTIONS]
List pool media
Optional parameters:
--output-formattext|json|json-pretty- Output format.
--pool<string>- Media pool name.
--update-status<boolean> (default=true)- Try to update tape library status (check what tapes are online).
--update-status-changer<string>- Tape Changer Identifier.
proxmox-tape pool config <name> [OPTIONS]
Get media pool configuration
<name>:<string>- Media pool name.
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape pool create <name> [OPTIONS]
Create a new media pool
<name>:<string>- Media pool name.
Optional parameters:
--allocation<string>- Media set allocation policy ('continue', 'always', or a calendar event).
--comment<string>- Comment (single line).
--encrypt<string>- Tape encryption key fingerprint (sha256).
--retention<string>- Media retention policy ('overwrite', 'keep', or time span).
--template<string>- Media set naming template (may contain strftime() time format specifications).
proxmox-tape pool list [OPTIONS]
List media pool
Optional parameters:
--output-formattext|json|json-pretty- Output format.
proxmox-tape pool remove <name>
Delete a media pool configuration
<name>:<string>- Media pool name.
proxmox-tape pool update <name> [OPTIONS]
Update media pool settings
<name>:<string>- Media pool name.
Optional parameters:
--allocation<string>- Media set allocation policy ('continue', 'always', or a calendar event).
--comment<string>- Comment (single line).
--delete<array>- List of properties to delete.
--encrypt<string>- Tape encryption key fingerprint (sha256).
--retention<string>- Media retention policy ('overwrite', 'keep', or time span).
--template<string>- Media set naming template (may contain strftime() time format specifications).
proxmox-tape read-label [OPTIONS]
Read media label
Optional parameters:
--drive<string>- Drive Identifier.
--inventorize<boolean>- Inventorize media
--output-formattext|json|json-pretty- Output format.
proxmox-tape restore <media-set> <store> [OPTIONS]
Restore data from media-set
<media-set>:<string>- Media set UUID.
<store>:[(<source>=)?<target>, ...]- A list of Datastore mappings (or single datastore), comma separated. For example 'a=b,e' maps the source datastore 'a' to target 'b and all other sources to the default 'e'. If no default is given, only the specified sources are mapped.
Optional parameters:
--drive<string>- Drive Identifier.
--notify-user<string>- User ID
--output-formattext|json|json-pretty- Output format.
--owner<string>- Authentication ID
proxmox-tape rewind [OPTIONS]
Rewind tape
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape scan [OPTIONS]
Rewind, then read media contents and print debug info
Note: This reads unless the driver returns an IO Error, so this method is expected to fails when we reach EOT.
Optional parameters:
--drive<string>- Drive Identifier.
proxmox-tape status [OPTIONS]
Get drive/media status
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
proxmox-tape unload [OPTIONS]
Unload media via changer
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.
--target-slot<integer> (1 - N)- Target slot number. If omitted, defaults to the slot that the drive was loaded from.
proxmox-tape volume-statistics [OPTIONS]
Read Volume Statistics (SCSI log page 17h)
Optional parameters:
--drive<string>- Drive Identifier.
--output-formattext|json|json-pretty- Output format.