Les commandes en un coup d’œil – cloneworx Aide

Les destinations, les plans de sauvegarde, les sauvegardes, la restauration et les réglages de cloneworx Backup se pilotent aussi depuis la ligne de commande, sans navigateur. Voici toutes les commandes de l’extension avec leurs actions et les règles qui s’appliquent à chaque commande.

WP-CLI n’est pas encore installé sur ton serveur ? Alors commence par Installer WP-CLI.

Structure d’une commande

Chaque commande commence par « wp cloneworx-backup ». Suivent la commande, l’action, au besoin un nom et les paramètres. Un paramètre commence par deux tirets.

# Commande target, action test, destination local-1
wp cloneworx-backup target test local-1

# Commande plan, action run, plan plan-1, paramètre --background
wp cloneworx-backup plan run plan-1 --background

Tu exécutes les commandes dans le dossier de ton site, c’est-à-dire là où se trouve WordPress.
Si tu omets l’action, c’est l’action par défaut de la commande qui s’applique. wp cloneworx-backup target équivaut à wp cloneworx-backup target list.
Les sorties sont en anglais et ne sont pas traduites.
L’aide de WP-CLI indique pour chaque commande les actions et les paramètres, par exemple wp help cloneworx-backup target.

Toutes les commandes

L’action en gras est celle par défaut ; elle s’applique si tu n’indiques aucune action.

Commande	Actions	Pour quoi	Pour en savoir plus
`target`	list, add, edit, remove, test, check, cleanup, moved, copy, sites, adopt, rebuild	Afficher, créer, modifier, retirer et tester les destinations. Vérifier les sauvegardes d’une destination, nettoyer les restes, répondre à un conflit d’empreinte, retrouver des sauvegardes après une perte totale.	Gérer les destinations avec WP-CLI
`plan`	list, add, edit, pause, resume, remove, run	Afficher, créer, modifier, mettre en pause, activer, supprimer et exécuter immédiatement les plans de sauvegarde.	Gérer les plans de sauvegarde avec WP-CLI
`backup`	run, list, lock, unlock, check, download, delete	Créer une sauvegarde sans plan. Afficher, verrouiller, vérifier, écrire dans un fichier et supprimer les sauvegardes.	Créer et gérer les sauvegardes avec WP-CLI
`retention`	list, run	Afficher quelles anciennes sauvegardes seraient retirées selon Sauvegardes max., ou les supprimer maintenant.	Créer et gérer les sauvegardes avec WP-CLI
`restore`	precheck, run, status, keep, undo	Exécuter la vérification préalable, lancer une restauration, afficher son état, la conserver ou l’annuler.	Restaurer et importer avec WP-CLI
`import`	aucune ; la commande prend le chemin d’un fichier et le paramètre `--target`	Stocker un fichier de sauvegarde sur une destination de ce site et l’ajouter à la liste des sauvegardes.	Restaurer et importer avec WP-CLI
`scheduler`	status, tick	Afficher la planification. Avec tick, vérifier si un plan est dû et le lancer : c’est la ligne pour le cron système.	Planification et cron système avec WP-CLI
`settings`	list, get, set, reset	Afficher, lire, définir et rétablir aux valeurs par défaut les réglages du site.	Réglages et périmètre avec WP-CLI
`scope`	roots, tables, exclusions, all	Afficher ce qui fait partie du site. Définir les règles d’exclusion et les tables dont seule la structure est sauvegardée.	Réglages et périmètre avec WP-CLI
`status`	aucune	Afficher l’état du site : le même résultat que la tuile d’état de la page Vue d'ensemble.	État, journaux et support avec WP-CLI
`logs`	aucune	Lister les fichiers journaux ou les écrire tous dans un fichier tar.	État, journaux et support avec WP-CLI
`support`	aucune	Afficher le rapport de support ou l’écrire dans un fichier.	État, journaux et support avec WP-CLI
`debug`	on, off, status	Activer et désactiver le débogage dans le journal. Après 24 heures, il se désactive de lui-même.	État, journaux et support avec WP-CLI
`notify`	status, check, test	Afficher l’état des notifications, vérifier maintenant les sauvegardes en retard, envoyer un e-mail de test.	État, journaux et support avec WP-CLI
`news`	status, subscribe, unsubscribe	Afficher, commencer ou terminer l’abonnement aux nouveautés de cloneworx Backup.	État, journaux et support avec WP-CLI
`job`	run, status, abort, probe, filelist, dbexport, files	Mener à terme la tâche en cours, afficher son état ou l’interrompre. Lancer l’exécution d’essai et les tâches de diagnostic.	État, journaux et support avec WP-CLI

Nommer une destination, un plan et une sauvegarde

Quoi	Comment tu le nommes	Où tu le trouves
Destination	Après l’action, avec son identifiant (`local-1`, `sftp-1`) ou son nom. Dans les paramètres `--targets` et `--target`, c’est l’identifiant qui figure.	`wp cloneworx-backup target list`
Plan	Après l’action, avec son identifiant (`plan-1`) ou son nom. Dans le paramètre `--plan`, c’est l’identifiant qui figure.	`wp cloneworx-backup plan list`
Sauvegarde	Avec le nom de sa tâche : date, heure et un identifiant de 32 caractères.	`wp cloneworx-backup backup list`

Pour le nom d’une destination, la casse ne joue aucun rôle. Pour le nom d’un plan, cela vaut pour les lettres a à z ; les lettres accentuées, tu les écris telles qu’elles figurent dans le nom. Un nom contenant des espaces se met entre guillemets : wp cloneworx-backup plan run "Sauvegarde quotidienne".

En tant que quel utilisateur tu travailles

WP-CLI s’exécute souvent en tant qu’un autre utilisateur que le site. Le site ne pourrait plus modifier ni supprimer par la suite les fichiers et dossiers qu’une commande crée alors. Presque chaque commande qui modifie quelque chose ou lance une tâche vérifie donc d’abord que tu travailles en tant que l’utilisateur à qui appartiennent les dossiers de l’extension. Sinon, elle s’interrompt et nomme les deux utilisateurs. Dans l’exemple ci-dessous, web et vuser sont l’utilisateur et le groupe du site ; indique ceux de ton site.

# Exécuter en tant qu’utilisateur du site (exemple : web et vuser)
sudo -u web -g vuser -H wp cloneworx-backup backup run

Les actions list et status ne vérifient pas l’utilisateur : tu affiches les listes et les états sous n’importe quel utilisateur. settings ne le vérifie pas non plus lors de la définition, car la commande n’écrit que dans la base de données.
S’exécutent aussi sans vérification : backup lock, backup unlock, backup download, job run, job abort, logs et support.
Avec --force, une commande s’exécute malgré tout et se contente d’avertir. Le risque demeure : ce qu’elle crée appartient au mauvais utilisateur.
restore run, restore keep et restore undo ne connaissent pas --force. Une restauration écrit dans le site lui-même.

Dans ce processus ou en arrière-plan

La sauvegarde, la vérification, le nettoyage, la restauration et l’import s’exécutent comme une tâche en de nombreuses étapes courtes. Sans paramètre supplémentaire, la commande mène elle-même la tâche jusqu’au bout. Elle affiche une ligne de progression par étape et, à la fin, le résultat. Elle ignore la pause entre les étapes définie dans les réglages.

La restauration fait exception : la commande confie le basculement vers l’état restauré au serveur web et attend qu’il soit terminé. Pour en savoir plus : Restaurer et importer avec WP-CLI.

Avec --background, la commande ne fait que lancer la tâche. Le site la poursuit alors lui-même : via l’auto-requête du serveur, avec WP-Cron comme filet en dessous. wp cloneworx-backup job status affiche l’état.

Commande	Actions avec `--background`
`target`	check, cleanup, adopt, rebuild
`plan`	run
`backup`	run, check
`restore`	run, keep, undo
`import`	la commande elle-même
`scheduler`	tick
`job`	probe, filelist, dbexport, files

Une tâche par site

Une seule tâche s’exécute à la fois. Si une tâche est déjà en cours, la commande refuse le démarrage et nomme la tâche en cours : Another job is active: …. One job per site.

Mots de passe et clés

La ligne de commande n’accepte jamais de mots de passe ni de clés. Chaque valeur y figurerait dans la liste des processus et dans l’historique du shell. Les destinations avec identifiants se configurent donc sur la page Destinations. Tu peux ensuite les tester, les vérifier et les utiliser dans un plan aussi depuis la ligne de commande.

Le paramètre --path

--path est un paramètre de WP-CLI, pas de l’extension : il indique le chemin vers WordPress si tu n’es pas dans le dossier du site. Le dossier d’une destination locale se définit avec --set-path.

# Le chemin vers WordPress : une option de WP-CLI
wp cloneworx-backup status --path=/pfad/zur/website

# Le dossier d’une destination locale : un réglage de la destination
wp cloneworx-backup target add local --set-path=/var/backups

Le même chemin que le serveur web

Appelle WP-CLI par le chemin par lequel le serveur web atteint lui aussi le site. L’empreinte de l’installation contient le chemin sur le serveur. Par un autre chemin, par exemple un lien symbolique, la même installation ressemble à une copie : l’extension note un conflit d’empreinte et n’écrit ni ne supprime rien sur cette destination.

Voir aussi