Command Syntax

proxmox-offline-mirror

For supported environment variables please refer to Environment Variables .

Options available for command group proxmox-offline-mirror:

--config <string>

Path to mirroring config file.

proxmox-offline-mirror config media add --id <string> --mirrors <string> --mountpoint <string> --sync <boolean> --verify-mode <string> [OPTIONS]

Create new medium config entry.

--id <string>

Medium name.

--mirrors <string>

IDs of the mirrors to sync to the medium. Can be specified more than once.

--mountpoint <string>

Mountpoint where medium is available on mirroring system.

--sync <boolean>

Whether to write new files using FSYNC.

--verify-mode <string>

How to check files already in the pool: none, size, or full (checksum). Also accepts true (full) and false (none) for compatibility.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config media list [OPTIONS]

List configured media.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config media remove --id <string> --remove-data <boolean> [OPTIONS]

Remove medium config entry.

--id <string>

Medium name.

--remove-data <boolean>

Remove ALL DATA on medium as well.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config media show --id <string> [OPTIONS]

Show full medium config entry.

--id <string>

Medium name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config media update --id <string> [OPTIONS]

Update medium config entry.

--id <string>

Medium name.

Optional parameters:

--mirrors <string>

IDs of the mirrors to sync to the medium. Can be specified more than once.

--mountpoint <string>

Mountpoint where medium is available on mirroring system.

--sync <boolean>

Whether to write new files using FSYNC.

--verify-mode <string>

How to check files already in the pool: none, size, or full (checksum). Also accepts true (full) and false (none) for compatibility.

Inherited group parameters:

--config

proxmox-offline-mirror config mirror add --architectures <string> --base-dir <string> --id <string> --key-path <string> --repository <string> --sync <boolean> --verify-mode <string> [OPTIONS]

Create new mirror config entry.

--architectures <string>

List of architectures that should be mirrored. Can be specified more than once.

--base-dir <string>

Path to directory containing mirrored repository pool. Can be shared by multiple mirrors.

--id <string>

Mirror name.

--key-path <string>

Path to public key file for verifying repository integrity.

--repository <string>

Single repository definition in sources.list format.

--sync <boolean>

Whether to write new files using FSYNC.

--verify-mode <string>

How to check files already in the pool: none, size, or full (checksum). Also accepts true (full) and false (none) for compatibility.

Optional parameters:

--ignore-errors <boolean>   (default=false)

Whether to downgrade download errors to warnings.

--latest-symlink <boolean>   (default=true)

Whether to maintain a symlink pointing to the last successful snapshot.

--latest-symlink-name <string>   (default=last)

Name of the latest-snapshot symlink.

--output-format text|json|json-pretty

Output format.

--request-timeout <integer> (0 - 604800)

Maximum duration of a repository request in seconds, or 0 for no limit. By default, allow 15 minutes plus the transfer time at 64 KiB/s when the expected file size is known.

--skip-packages <string>

Package names to skip. Supports glob patterns. Can be specified more than once.

--skip-sections <string>

Sections which should be skipped. Can be specified more than once.

--use-subscription pve|pbs|pmg|pom

Access the repository with the active subscription key of this product (required for Proxmox enterprise repositories).

--weak-crypto [[allow-sha1=<1|0>] [,min-dsa-key-size=<integer>] [,min-rsa-key-size=<integer>]]

Whether to allow using weak cryptography algorithms or parameters, deviating from the default policy.

Inherited group parameters:

--config

proxmox-offline-mirror config mirror list [OPTIONS]

List configured mirrors

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config mirror remove --id <string> --remove-data <boolean> [OPTIONS]

Remove mirror config entry.

--id <string>

Mirror name.

--remove-data <boolean>

Remove mirror data as well.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config mirror show --id <string> [OPTIONS]

Show full mirror config

--id <string>

Mirror name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror config mirror update --id <string> [OPTIONS]

Update mirror config entry.

--id <string>

Mirror name.

Optional parameters:

--architectures <string>

List of architectures that should be mirrored. Can be specified more than once.

--base-dir <string>

Path to directory containing mirrored repository pool. Can be shared by multiple mirrors.

--delete use-subscription|ignore-errors|skip-packages|skip-sections|weak-crypto|latest-symlink|latest-symlink-name|request-timeout

Properties to reset to their default. Can be specified more than once.

--ignore-errors <boolean>   (default=false)

Whether to downgrade download errors to warnings.

--key-path <string>

Path to public key file for verifying repository integrity.

--latest-symlink <boolean>   (default=true)

Whether to maintain a symlink pointing to the last successful snapshot.

--latest-symlink-name <string>   (default=last)

Name of the latest-snapshot symlink.

--repository <string>

Single repository definition in sources.list format.

--request-timeout <integer> (0 - 604800)

Maximum duration of a repository request in seconds, or 0 for no limit. By default, allow 15 minutes plus the transfer time at 64 KiB/s when the expected file size is known.

--skip-packages <string>

Package names to skip. Supports glob patterns. Can be specified more than once.

--skip-sections <string>

Sections which should be skipped. Can be specified more than once.

--sync <boolean>

Whether to write new files using FSYNC.

--use-subscription pve|pbs|pmg|pom

Access the repository with the active subscription key of this product (required for Proxmox enterprise repositories).

--verify-mode <string>

How to check files already in the pool: none, size, or full (checksum). Also accepts true (full) and false (none) for compatibility.

--weak-crypto [[allow-sha1=<1|0>] [,min-dsa-key-size=<integer>] [,min-rsa-key-size=<integer>]]

Whether to allow using weak cryptography algorithms or parameters, deviating from the default policy.

Inherited group parameters:

--config

proxmox-offline-mirror help [{<command>}] [OPTIONS]

Get help about specified command (or sub-command).

<command><string>

Command. This may be a list in order to specify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>

Verbose help.

Inherited group parameters:

--config

proxmox-offline-mirror key add <key> <server-id> [OPTIONS]

List subscription keys and their status

<key><string>

Subscription key.

<server-id><string>

Server ID.

Optional parameters:

--description <string>

Description, e.g. which system this key is deployed on

--info <string>

base64 encoded subscription info - update with 'refresh' command.

--refresh <boolean>   (default=true)

Whether to refresh the subscription info upon adding.

Inherited group parameters:

--config

proxmox-offline-mirror key add-mirror-key <key>

Add offline mirror key

<key><string>

Subscription key.

Inherited group parameters:

--config

proxmox-offline-mirror key list [OPTIONS]

List subscription keys and their status

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror key refresh [OPTIONS]

Refresh subscription key status.

Optional parameters:

--key <string>

Subscription key.

Inherited group parameters:

--config

proxmox-offline-mirror key remove <key> [OPTIONS]

Remove subscription key config entry.

<key><string>

Subscription key.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror key show <key> [OPTIONS]

Show (decoded) subscription config entry.

<key><string>

Subscription key.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror key update <key> [OPTIONS]

Update subscription config entry.

<key><string>

Subscription key.

Optional parameters:

--description <string>

Description, e.g. which system this key is deployed on

--server-id <string>

Server ID.

Inherited group parameters:

--config

proxmox-offline-mirror medium diff <id> [OPTIONS]

Diff a medium

<id><string>

Medium name.

Optional parameters:

--verbose <boolean>   (default=false)

Verbose output (print paths in addition to summary).

Inherited group parameters:

--config

proxmox-offline-mirror medium gc <id> [OPTIONS]

Garbage collect all mirrors on a medium.

<id><string>

Medium name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror medium status <id> [OPTIONS]

Print status of a medium

<id><string>

Medium name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror medium sync <id> [OPTIONS]

Sync a medium

<id><string>

Medium name.

Optional parameters:

--keys-only <boolean>   (default=false)

Only sync offline subscription keys, skip repository contents

Inherited group parameters:

--config

proxmox-offline-mirror mirror gc [<id>] [OPTIONS]

Run garbage collection on a mirror's pool, or on the pools of all mirrors if no ID is given.

<id><string>

Mirror name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot create <id> [OPTIONS]

Create a repository snapshot, downloading any required files missing from the pool.

<id><string>

Mirror name.

Optional parameters:

--dry-run <boolean>   (default=false)

Only fetch the indices and print a summary of the missing package files, without downloading them or creating a snapshot.

--latest-symlink <boolean>

Set to false to leave the latest-snapshot symlink unchanged in this run. It can only be enabled in the mirror configuration.

--max-downloads <integer> (1 - 4)   (default=1)

Maximum number of concurrent binary package downloads, kept low to spare the source repository.

--name <string>

Snapshot name.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot create-all [OPTIONS]

Create a snapshot of each configured mirror, downloading required files missing from the pool.

Optional parameters:

--dry-run <boolean>   (default=false)

Only fetch the indices and print a summary of the missing package files, without downloading them or creating a snapshot.

--latest-symlink <boolean>

Set to false to leave the latest-snapshot symlink unchanged in this run. It can only be enabled in the mirror configuration.

--max-downloads <integer> (1 - 4)   (default=1)

Maximum number of concurrent binary package downloads, kept low to spare the source repository.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot diff <id> <snapshot> <other_snapshot> [OPTIONS]

Print differences between two snapshots.

<id><string>

Mirror name.

<snapshot><string>

Mirror snapshot timestamp in UTC, like 2025-03-05T14:30:45Z.

<other_snapshot><string>

Mirror snapshot timestamp in UTC, like 2025-03-05T14:30:45Z.

Optional parameters:

--output-format text|json|json-pretty

Output format.

--packages <boolean>   (default=false)

List differences per binary and source package instead of per stored file.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot list [<id>] [OPTIONS]

List existing repository snapshots.

<id><string>

Mirror name.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot name <id> <snapshot> <name>

Assign a name to a snapshot.

<id><string>

Mirror name.

<snapshot><string>

Mirror snapshot timestamp in UTC, like 2025-03-05T14:30:45Z.

<name><string>

Snapshot name.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot prune <id> [OPTIONS]

Prune snapshots according to retention options.

<id><string>

Mirror name.

Optional parameters:

--dry-run <boolean>   (default=false)

Only show what would be removed.

--gc <boolean>   (default=false)

Run garbage collection after pruning.

--ignore-names <boolean>   (default=false)

Don't protect named snapshots from pruning.

--keep-daily <integer> (1 - N)

Keep snapshots for the last <N> different days.

--keep-hourly <integer> (1 - N)

Keep snapshots for the last <N> different hours.

--keep-last <integer> (1 - N)

Keep the last <N> snapshots.

--keep-monthly <integer> (1 - N)

Keep snapshots for the last <N> different months.

--keep-weekly <integer> (1 - N)

Keep snapshots for the last <N> different weeks.

--keep-yearly <integer> (1 - N)

Keep snapshots for the last <N> different years.

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot prune-all [OPTIONS]

Prune snapshots for all configured mirrors.

Optional parameters:

--dry-run <boolean>   (default=false)

Only show what would be removed.

--gc <boolean>   (default=false)

Run garbage collection after pruning.

--ignore-names <boolean>   (default=false)

Don't protect named snapshots from pruning.

--keep-daily <integer> (1 - N)

Keep snapshots for the last <N> different days.

--keep-hourly <integer> (1 - N)

Keep snapshots for the last <N> different hours.

--keep-last <integer> (1 - N)

Keep the last <N> snapshots.

--keep-monthly <integer> (1 - N)

Keep snapshots for the last <N> different months.

--keep-weekly <integer> (1 - N)

Keep snapshots for the last <N> different weeks.

--keep-yearly <integer> (1 - N)

Keep snapshots for the last <N> different years.

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot remove <id> <snapshot> [OPTIONS]

Remove a snapshot from a mirror. Its data is only freed by a garbage collection.

<id><string>

Mirror name.

<snapshot><string>

Mirror snapshot timestamp in UTC, like 2025-03-05T14:30:45Z.

Optional parameters:

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror mirror snapshot unname <id> <name>

Remove a snapshot name (does not remove the snapshot data).

<id><string>

Mirror name.

<name><string>

Snapshot name.

Inherited group parameters:

--config

proxmox-offline-mirror mirror verify [<id>] [OPTIONS]

Check pool integrity without repairing files.

<id><string>

Mirror name.

Optional parameters:

--mode full|size   (default=full)

Use 'full' for checksum verification or 'size' to detect unexpectedly empty files.

--output-format text|json|json-pretty

Output format.

Inherited group parameters:

--config

proxmox-offline-mirror setup

Interactive setup wizard.

Inherited group parameters:

--config

proxmox-offline-mirror-helper

proxmox-offline-mirror-helper help [{<command>}] [OPTIONS]

Get help about specified command (or sub-command).

<command><string>

Command. This may be a list in order to specify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>

Verbose help.

proxmox-offline-mirror-helper offline-key --source <string> [OPTIONS]

Configures an offline subscription key

--source <string>

Path to medium mountpoint or URL for key activation

Optional parameters:

--product pve|pbs|pmg|pom

Only activate the subscription key of this product, instead of those of all products.

proxmox-offline-mirror-helper setup

Interactive setup wizard.

proxmox-offline-mirror-helper status --mountpoint <string> [OPTIONS]

Prints status of medium

--mountpoint <string>

Path to medium mountpoint

Optional parameters:

--output-format text|json|json-pretty

Output format.