Die Befehle im Überblick – cloneworx

Ziele, Backup-Pläne, Backups, Restore und Einstellungen von cloneworx Backup steuerst Du auch auf der Kommandozeile, ohne Browser. Hier stehen alle Befehle des Plugins mit ihren Aktionen und die Regeln, die für jeden Befehl gelten.

WP-CLI ist auf Deinem Server noch nicht eingerichtet? Dann beginne mit WP-CLI installieren.

So ist ein Befehl aufgebaut

Jeder Befehl beginnt mit „wp cloneworx-backup“. Danach folgen der Befehl, die Aktion, bei Bedarf ein Name und die Schalter. Ein Schalter beginnt mit zwei Bindestrichen.

# Befehl target, Aktion test, Ziel local-1
wp cloneworx-backup target test local-1

# Befehl plan, Aktion run, Plan plan-1, Schalter --background
wp cloneworx-backup plan run plan-1 --background

Du führst die Befehle im Ordner Deiner Website aus, also dort, wo WordPress liegt.
Lässt Du die Aktion weg, gilt die Vorgabe des Befehls. wp cloneworx-backup target ist dasselbe wie wp cloneworx-backup target list.
Die Ausgaben sind englisch und werden nicht übersetzt.
Die Hilfe von WP-CLI nennt zu jedem Befehl die Aktionen und Schalter, zum Beispiel wp help cloneworx-backup target.

Alle Befehle

Die fett gesetzte Aktion ist die Vorgabe und gilt, wenn Du keine Aktion nennst.

Befehl	Aktionen	Wofür	Mehr dazu
`target`	list, add, edit, remove, test, check, cleanup, moved, copy, sites, adopt, rebuild	Ziele zeigen, anlegen, ändern, entfernen und testen. Die Backups an einem Ziel prüfen, Reste aufräumen, einen Fingerabdruck-Konflikt beantworten, Backups nach einem Totalverlust wiederfinden.	Ziele verwalten mit WP-CLI
`plan`	list, add, edit, pause, resume, remove, run	Backup-Pläne zeigen, anlegen, ändern, pausieren, einschalten, löschen und sofort ausführen.	Backup-Pläne verwalten mit WP-CLI
`backup`	run, list, lock, unlock, check, download, delete	Ein Backup ohne Plan erstellen. Backups zeigen, sperren, prüfen, als Datei schreiben und löschen.	Backups erstellen und verwalten mit WP-CLI
`retention`	list, run	Zeigen, welche alten Backups nach Max. Sicherungen wegfallen würden, oder sie jetzt löschen.	Backups erstellen und verwalten mit WP-CLI
`restore`	precheck, run, status, keep, undo	Die Vorprüfung ausführen, einen Restore starten, seinen Zustand zeigen, ihn behalten oder rückgängig machen.	Wiederherstellen und importieren mit WP-CLI
`import`	keine; der Befehl nimmt den Pfad einer Datei und den Schalter `--target`	Eine Backup-Datei an einem Ziel dieser Website speichern und in die Liste der Backups aufnehmen.	Wiederherstellen und importieren mit WP-CLI
`scheduler`	status, tick	Den Zeitplan zeigen. Mit tick prüfen, ob ein Plan fällig ist, und ihn starten: Das ist die Zeile für den System-Cron.	Zeitplan und System-Cron mit WP-CLI
`settings`	list, get, set, reset	Die Einstellungen der Website zeigen, lesen, setzen und auf die Vorgaben zurücksetzen.	Einstellungen und Umfang mit WP-CLI
`scope`	roots, tables, exclusions, all	Zeigen, was zur Website gehört. Die Ausschlussregeln setzen und die Tabellen, von denen nur die Struktur gesichert wird.	Einstellungen und Umfang mit WP-CLI
`status`	keine	Den Zustand der Website zeigen: dasselbe Urteil wie die Statuskachel der Seite Übersicht.	Zustand, Protokolle und Support mit WP-CLI
`logs`	keine	Die Protokolldateien auflisten oder alle in eine tar-Datei schreiben.	Zustand, Protokolle und Support mit WP-CLI
`support`	keine	Den Support-Bericht ausgeben oder in eine Datei schreiben.	Zustand, Protokolle und Support mit WP-CLI
`debug`	on, off, status	Die Fehlersuche im Protokoll ein- und ausschalten. Nach 24 Stunden schaltet sie sich selbst aus.	Zustand, Protokolle und Support mit WP-CLI
`notify`	status, check, test	Den Zustand der Benachrichtigungen zeigen, jetzt auf überfällige Backups prüfen, eine Testmail senden.	Zustand, Protokolle und Support mit WP-CLI
`news`	status, subscribe, unsubscribe	Die Anmeldung für News zu cloneworx Backup zeigen, beginnen oder beenden.	Zustand, Protokolle und Support mit WP-CLI
`job`	run, status, abort, probe, filelist, dbexport, files	Den laufenden Job zu Ende führen, seinen Zustand zeigen oder ihn abbrechen. Den Probelauf und die Diagnose-Jobs starten.	Zustand, Protokolle und Support mit WP-CLI

Ziel, Plan und Backup nennen

Was	So nennst Du es	Wo Du es findest
Ziel	Hinter der Aktion mit seiner Kennung (`local-1`, `sftp-1`) oder seinem Namen. In den Schaltern `--targets` und `--target` steht die Kennung.	`wp cloneworx-backup target list`
Plan	Hinter der Aktion mit seiner Kennung (`plan-1`) oder seinem Namen. Im Schalter `--plan` steht die Kennung.	`wp cloneworx-backup plan list`
Backup	Mit seinem Job-Namen: Datum, Uhrzeit und eine Kennung aus 32 Zeichen.	`wp cloneworx-backup backup list`

Beim Namen eines Ziels spielt Groß- und Kleinschreibung keine Rolle. Beim Namen eines Plans gilt das für die Buchstaben a bis z; Umlaute schreibst Du so, wie sie im Namen stehen. Einen Namen mit Leerzeichen setzt Du in Anführungszeichen: wp cloneworx-backup plan run "Tägliches Backup".

Als welcher Benutzer Du arbeitest

WP-CLI läuft oft als ein anderer Benutzer als die Website. Dateien und Ordner, die ein Befehl dann anlegt, könnte die Website später nicht mehr ändern oder löschen. Fast jeder Befehl, der etwas ändert oder einen Job startet, prüft deshalb zuerst, ob Du als der Benutzer arbeitest, dem die Ordner des Plugins gehören. Wenn nicht, bricht er ab und nennt beide Benutzer. Im Beispiel unten sind web und vuser der Benutzer und die Gruppe der Website; setze die Deiner Website ein.

# Als Benutzer der Website ausführen (Beispiel: web und vuser)
sudo -u web -g vuser -H wp cloneworx-backup backup run

Die Aktionen list und status prüfen den Benutzer nicht: Listen und Zustände zeigst Du unter jedem Benutzer an. settings prüft ihn auch beim Setzen nicht, denn der Befehl schreibt nur in die Datenbank.
Ohne Prüfung laufen auch backup lock, backup unlock, backup download, job run, job abort, logs und support.
Mit --force läuft ein Befehl trotzdem und warnt nur. Das Risiko bleibt: Was er anlegt, gehört dem falschen Benutzer.
restore run, restore keep und restore undo kennen kein --force. Ein Restore schreibt in die Website selbst.

In diesem Prozess oder im Hintergrund

Backup, Prüfung, Aufräumen, Restore und Import laufen als Job in vielen kurzen Schritten. Ohne weiteren Schalter führt der Befehl den Job selbst bis zum Ende. Er zeigt je Schritt eine Zeile mit dem Fortschritt und am Ende das Ergebnis. Die Pause zwischen den Schritten aus den Einstellungen lässt er aus.

Eine Ausnahme macht der Restore: Das Umschalten auf den wiederhergestellten Stand gibt der Befehl an den Webserver ab und wartet, bis es erledigt ist. Mehr dazu: Wiederherstellen und importieren mit WP-CLI.

Mit --background startet der Befehl den Job nur. Die Website führt ihn dann selbst weiter: über den Selbstaufruf des Servers, mit WP-Cron als Netz darunter. Den Stand zeigt wp cloneworx-backup job status.

Befehl	Aktionen mit `--background`
`target`	check, cleanup, adopt, rebuild
`plan`	run
`backup`	run, check
`restore`	run, keep, undo
`import`	der Befehl selbst
`scheduler`	tick
`job`	probe, filelist, dbexport, files

Ein Job je Website

Es läuft immer nur ein Job zur selben Zeit. Läuft schon einer, lehnt der Befehl den Start ab und nennt den laufenden Job: Another job is active: …. One job per site.

Passwörter und Schlüssel

Passwörter und Schlüssel nimmt die Kommandozeile nie an. Jeder Wert stünde dort in der Liste der Prozesse und im Verlauf der Shell. Ziele mit Zugangsdaten richtest Du deshalb auf der Seite Ziele ein. Testen, prüfen und in einem Plan verwenden kannst Du sie danach auch auf der Kommandozeile.

Der Schalter --path

--path ist ein Schalter von WP-CLI, nicht des Plugins: Er nennt den Pfad zu WordPress, wenn Du nicht im Ordner der Website bist. Den Ordner eines lokalen Ziels setzt Du mit --set-path.

# Der Pfad zu WordPress: ein Schalter von WP-CLI
wp cloneworx-backup status --path=/pfad/zur/website

# Der Ordner eines lokalen Ziels: eine Einstellung des Ziels
wp cloneworx-backup target add local --set-path=/var/backups

Derselbe Pfad wie der Webserver

Rufe WP-CLI über den Pfad auf, über den auch der Webserver die Website erreicht. Der Fingerabdruck der Installation enthält den Pfad auf dem Server. Über einen anderen Pfad, zum Beispiel einen Symlink, sieht dieselbe Installation wie eine Kopie aus: Das Plugin vermerkt einen Fingerabdruck-Konflikt und schreibt und löscht an diesem Ziel nichts.

Siehe auch