Zusammenstellung der wichtigsten Optionen aus --help. Jede Agent-Option ist auch als key=value in der Konfigurationsdatei nutzbar.
A.1 bkp_agent#
| Option | Bedeutung |
|---|---|
--source <pfad> | Quelle: Datei oder Blockgerät (Windows: \\.\C:, \\.\PhysicalDrive<n>, eine Platte besser über ihre Kennung disk-id:…; Linux: /dev/disk/by-id/…) |
--out <verz> | lokaler Sink: der Store liegt unter <verz>/<store>.cbs (mehrfach erlaubt) |
--target <host:port>, --target-dir <name> | Sink auf einem bkp_target; Verzeichnis muss im ACL-Eintrag des Keys stehen |
--tls-ca <pfad> | gepinntes Zertifikat des Servers |
--api-key file:<pfad>|kms:<url> | API-Key; Klartext nur in der Konfigurationsdatei |
--sink <name> | in den Store des Abschnitts [sink:<name>] schreiben (mehrfach erlaubt; ersetzt die Sinks des Profils) |
--name <name> | Name des Backups, wird in jedem Run gespeichert; wählt auch das Profil der Konfiguration |
--store <name> | Name des Stores (Standard default) |
--type inc|full | inc (Standard): normaler Lauf; full: neue Store-Generation |
--store-generation none|<n>d|<n>m | automatisch eine neue Generation, wenn die aktuelle älter ist (Standard none) |
--chunk-size <avg> | mittlere Chunk-Größe eines neuen Stores bzw. einer neuen Generation (Zweierpotenz, Standard 256K) |
--hash sha256|blake3|xxh3-128 | ID-Hash eines neuen Stores (Standard blake3); bei einem bestehenden muss er passen |
--threads <n>, --chunk-threads <n> | Worker (Hash und Kompression) bzw. gleichzeitig gechunkte Segmente |
--chunk-probe yes|no | Chunk-Größen-Messung nebenbei (Standard yes) |
--compression zstd|lz4|none, --level <n>, --max-level <n> | Kompression je neuem Chunk; zstd-Level (Standard 3) und Obergrenze der adaptiven Erhöhung |
--verify | die Sicherung nach dem Abschluss aus dem Store zurücklesen (nur lokale Stores) |
--no-fs-bitmap | freie Bereiche bei ext2/3/4/NTFS mitsichern (bitgleiche Kopie) |
--retention <spec>, --retention-class <c> | Aufbewahrung dieser Sicherung (<n>d|w|m|y, forever, gfs:<regeln>) und Klasse |
--worm none|extend|generation | WORM-Sperren eines neuen Stores; dazu --worm-margin, --worm-max, --worm-retention-max |
--index-dir <dir> | Index des Stores außerhalb des Stores ablegen |
--background, --background-min/-max <pct> | Selbstdrosselung bei Fremdlast |
--no-progress | keinen Fortschritt für bkp_monitor bereitstellen |
--snapshot auto|on|off | Snapshot-Verhalten (Linux-LVM, Windows-VSS) |
--snapshot-size <n> | Platz für Änderungen bei thick-Snapshots (10%, 512M, 2G) |
--pre-snapshot <cmd>, --post-snapshot <cmd> | Hooks vor bzw. nach dem Snapshot |
--hook-timeout <s> | Zeitlimit für Hooks (Standard 60) |
--keep-snapshot | Snapshot nach der Sicherung stehen lassen (für bkp_verifier) |
--vss-mode copy|full | nur Windows: VSS_BT_COPY (Standard) oder VSS_BT_FULL |
--vss-persistent auto|off | nur Windows: persistente Schattenkopie für eine fortsetzbare Netzwerk-Sicherung versuchen (Standard auto) |
--net-retry <minuten> | nach Verbindungsverlust so lange erneut versuchen (Standard 30, 0 = sofort aufgeben) |
--sink-stall-seconds <s> | einen optionalen Sink abhängen, der das Backup so lange aufhält (Standard 300) |
--resume auto|off | Umgang mit einem abgebrochenen Lauf (Standard auto) |
--resume-max-age <stunden> | ein abgebrochener Lauf, dessen letzte Aktivität länger zurückliegt, wird nicht fortgesetzt (Standard 24) |
--resume-dir <verz> | wo abgebrochene Läufe gemerkt werden (Standard /var/lib/bkp_agent/resume bzw. %ProgramData%\AegisGrid\resume); ein anderes Verzeichnis bekommt dort einen Verweis |
--resume-pending | alle abgebrochenen Läufe erneut starten und beenden (für den Systemstart); zu lange untätige Läufe samt Snapshot entfernen |
--resume-cleanup | nur zu lange untätige Läufe samt Snapshot entfernen, nichts starten (ruft bkp_sched täglich auf) |
--discard-interrupted | keine Sicherung: einen abgebrochenen Lauf dieses Auftrags verwerfen (Snapshot, Zustandsdatei); nutzt bkp_sched stop |
--result-file <datei> | Ergebnis als JSON (Status, Run, Full/Incremental, Größen); nutzt bkp_sched |
--config-path <datei> | Konfigurationsdatei (Standard /etc/bkp/bkp_agent.cfg) |
--path <pfad> | Datei oder Ordner sichern statt eines Geräts (mehrfach, bis 64; <ordner>/* nur die Dateien darin) |
--exclude <muster> | auslassen, was passt (mehrfach); --default-excludes yes|no (Standard yes) |
--one-file-system yes|no | andere eingehängte Dateisysteme nicht betreten (Standard yes) |
--ads yes|no, --change-journal yes|no | nur Windows: alternative Datenströme mitsichern, NTFS-Änderungsjournal nutzen (Standard je yes) |
--ransom-check yes|no | Ransomware-Warnung (Standard yes); --ransom-ratio <pct> (30), --ransom-factor <n> (5), --ransom-hold-days <n> (30) |
A.2 bkp_restore#
| Option | Bedeutung |
|---|---|
--store <dir> | Store-Verzeichnis (lokal) bzw. mit --server der Store-Name |
--server <host:port>, --server-dir <name> | Restore direkt von bkp_target |
--tls-ca, --api-key, --net-retry | Zertifikat, Key und Wiederverbindung für die Serververbindung |
--sink <name>, --config-path <datei> | aus den Sinks eines Profils lesen (Auswahl und Reihenfolge) |
--archive <datei|-> | aus einem Archiv (.cba) statt aus einem Store; - liest von stdin |
--name <name> [--at <zeit>] | neuester Run dieses Namens [bis zu diesem Zeitpunkt] |
--run <run> | genau dieser Run (Name aus --list, UUID oder run_group) |
--disk <slot>, --allow-incomplete | eine Disk eines VM-Runs; auch ein unvollständiger VM-Run |
--list, --show-run | Runs anzeigen bzw. den gewählten Run als JSON zeigen, nichts zurückspielen |
--list (ohne --name, --sink, --store, --server) | alle Sicherungen aller Profile aus bkp_agent.cfg, jede einmal mit ihren Sinks; nicht erreichbare Sinks ruhig unter der Tabelle |
--sinks | alle Sinks aus bkp_agent.cfg und sinks.cfg: Art, Ort, erreichbar (mit Grund), welche Profile sie nutzen; --json <datei> für Programme |
--target <pfad> | Zieldatei oder Zielgerät (wird überschrieben) |
--target-format raw|vhdx | Zieldatei als Rohabbild (Vorgabe) oder als neue, mitwachsende VHDX (Windows; Vorgabe bei der Endung .vhdx, mindestens 3 MB); eine vorhandene Datei wird nie überschrieben |
--partition <n> | nur Partition n einer Plattensicherung zurückspielen, auf ein Volume oder in eine Datei |
--new-disk-id auto|yes|no | neue Kennung (GPT-GUID bzw. MBR-Signatur) für die wiederhergestellte Platte: auto nur, wenn das Original noch im Rechner steckt |
--target-expect size=<bytes>,id=<kennung> | das Ziel muss noch das gewählte sein (Größe und Kennung), sonst wird nichts geschrieben (Exit 6); setzt der Planer |
--decrypt-key file:<pfad> | Schlüssel eines verschlüsselten Stores |
--threads <n> | Anzahl Worker |
--assume-zeroed | Ziel enthält nur Nullen; Löcher nicht schreiben |
--strict | --damage-file <pfad> | beim ersten Schaden abbrechen | beschädigte Bereiche als JSON schreiben |
--index-dir <dir> | Index liegt außerhalb des Stores |
--background | Selbstdrosselung bei Fremdlast |
--no-progress | keinen Fortschritt bereitstellen |
--files ls|restore|find|versions|diff|zip|mount | Dateisicherungen: anzeigen, zurückholen, suchen, Versionen, Änderungen, ZIP, als Ordner zeigen |
--to <ordner>, --original | Ziel von --files restore (bzw. Archiv bei zip, Ordner bei mount) |
--overwrite never|older|always, --as-version | vorhandene Dateien; eine Fassung neben die aktuelle legen |
--run2 <run>, --since/--until <zeit>, --paths-from <datei> | Vergleichslauf für diff; Zeitraum für find; weitere Pfade |
--image-volumes, --image-mount, --volume <volume> | Dateien aus Platten- und VM-Läufen (Linux als root, Windows als Administrator) |
--idle <minuten> | Ansicht von --files mount/--image-mount nach so viel Leerlauf beenden |
--viewer <SID> | Windows: dieses Benutzerkonto darf die Ansicht von --files mount/--image-mount lesen (z. B. im Explorer) |
--clear-anomaly | Schutz nach einer Ransomware-Warnung aufheben |
A.3 bkp_sched#
| Kommando | Bedeutung |
|---|---|
list [<muster>] [--status <s>] [--full] [--json] [--watch [s]] | alle Jobs in einer Tabelle: Status, nächster und letzter Lauf, Dauer, after= |
show <job> [--json] | ein Job im Einzelnen: Befehl, Profil, Sinks, Zeitplan, nächster Start, letzter Lauf, Zustand und der Befehl zum Wiederherstellen |
preview <job> [--count <n>] | die nächsten Starttermine eines Jobs |
run <job>, start <job>, stop <job> | Job sofort ausführen (im Vordergrund bzw. im Hintergrund) bzw. abbrechen |
pause, resume, throttle, hold <job>… | --all | laufende Jobs pausieren, fortsetzen, drosseln bzw. anhalten |
A.4 bkp_target#
| Option | Bedeutung |
|---|---|
--storage <verz> | Wurzelverzeichnis der Stores |
--tls-cert <pfad>, --tls-key <pfad> | Zertifikat und privater Schlüssel des Servers |
--acl-file <pfad> | ACL: <api_key> <verz1>[,<verz2>,...] je Zeile |
--bind <adresse>, --port <n> | Lauschadresse und -port (Standard Port 9990) |
--drain-timeout <s> | Wartezeit für laufende Sitzungen beim Beenden (Standard 300) |
--index-dir <dir> | Indizes der Stores unter <dir>/<store-uuid>.lmdb (Pflicht bei NFS/SMB) |
--client-retention extend|no | Ob Clients die Aufbewahrung ihrer Sicherungen ändern dürfen: extend (Standard) nur verlängern, no gar nicht |
--sched-config <datei>, --no-sched | Konfiguration des Target-Schedulers bzw. ihn abschalten |
--sched-validate, --sched-list, --sched-preview <job>, --sched-run <job>, --sched-stop <job> | Scheduler prüfen, anzeigen, nächste Starts eines Jobs zeigen, Job sofort starten, Job abbrechen |
--sched-pause <job> [--for] [--reason], --sched-resume <job> | Laufenden Job pausieren bzw. fortsetzen |
A.5 bkp_maintenance#
| Kommando | Bedeutung |
|---|---|
store-info --store <d> [--exclusive] [--fragmentation] [--json] | Inhalt, Deduplizierung, letzte Wartung, Chunk-Empfehlung |
store-info --store <d> --names | wem jeder Backup-Name gehört und welche Rechner Läufe haben |
prune (--search-dir <d> | --store <d>) [--name <n>] [--dry-run] | abgelaufene Runs und nicht mehr gebrauchte Daten löschen |
delete --store <d> --run <run> [--dry-run] | einen Run löschen und die Daten, die kein anderer braucht |
scrub (--store <d> | --search-dir <d>) [--decrypt-key file:<f>] | alle Objekte lesen und prüfen |
repair --store <d> --from <kopie>|sink:<n>|server:<host:port> ... | Schäden des letzten Scrubs aus einer Kopie ersetzen |
mirror (--store <d> | --search-dir <d>) --to <d>|server:<host:port> ... | Store in einen zweiten kopieren (nur was fehlt) |
mirror --reencrypt --store <d>|sink:<n> --to <d>|sink:<n> [--to-key <k>] ... | Läufe mit anderem Schlüssel bzw. ID-Hash in einen Store kopieren |
move --store <d> [--name <n>] --to <d>|server:<host:port> [--dry-run] | Store oder Läufe einzelner Namen umziehen (umbenennen oder kopieren, dann löschen) |
export --store <d> (--run <r> | --name <n> [--at <t>]) --to <datei|verz|-> | einen Run als Archiv schreiben |
import --archive <datei|-> --to <d> [--dry-run] | Archiv zurück in einen Store holen bzw. prüfen |
reindex --store <d> | Index aus den Packs neu aufbauen |
acl-add --acl-file <f> --dir <a>[,<b>] [--key <k>] | ACL-Eintrag anlegen; ohne --key wird ein zufälliger Key erzeugt |
tls-init --cert <f> --key <f> [--cn <n>] [--days <n>] [--force] | selbstsigniertes ECDSA-Zertifikat (P-256) erzeugen |
encrypt-init --key-file <f> [--force] | Verschlüsselungs-Schlüssel erzeugen |
hwid [--json] | Hardware-Fingerprint dieses Rechners anzeigen |
A.6 bkp_monitor, bkp_dump, bkp_restore_legacy#
| Aufruf | Bedeutung |
|---|---|
bkp_monitor [--pid <pid>] | interaktive Anzeige |
bkp_monitor --dump --pid <pid> [--interval <ms>] [--wait <s>] | eine tab-getrennte Zeile je Intervall |
bkp_dump <store> [--run <run> [--extents] [--limit <n>]] | Store, Runs und Manifest eines Runs anzeigen (Standard 50 Zeilen, 0 = alle) |
bkp_restore_legacy list|restore|prune|delete ... | Sicherungen im Format von Version 1 (Kapitel 27) |
A.7 bkp_updater und bkp_license#
| Aufruf | Bedeutung |
|---|---|
bkp_updater --status | --check | --fetch <dir> | --update | --rollback | Zustand, prüfen, herunterladen, installieren, zurückschalten |
bkp_updater --adopt <dir> | vorhandene Installation übernehmen |
bkp_updater --install-task | --remove-task | Windows: Aufgabe anlegen oder entfernen |
--config, --url, --channel, --public-key, --ca-file, --proxy, --state-dir | Konfiguration überschreiben |
--dry-run, --force, --to <v>, --allow-downgrade, --restart-now | Steuerung von --update |
bkp_license status | Freischaltung, Gültigkeit des Installationszertifikats und Lizenz anzeigen, bei einer Testversion mit Restlaufzeit, Erneuerung und Punkten |
bkp_license activate [--code-file <datei>] [--server <url>] [--role <rolle>] | mit dem Freischaltcode beim Lizenzserver freischalten (ohne --code-file fragt es nach dem Code) |
bkp_license offline-request [--out <datei>] [--role <rolle>] | Anfrage für die Freischaltung schreiben |
bkp_license offline-apply <datei> | Antwort des Supports einspielen |
bkp_license renew [--if-due] [--quiet] [--server <url>] | Lizenz und Installationszertifikat beim Lizenzserver erneuern; --if-due nur, wenn fällig (das nutzen Planer und Updater); auf einem öffentlichen Target vorher den Speicher der Kunden messen |