Gérer les plans de sauvegarde avec WP-CLI – cloneworx Aide

Avec la commande plan, tu gères tes plans de sauvegarde depuis la ligne de commande : afficher, créer, modifier, mettre en pause, activer, exécuter immédiatement et supprimer.

WP-CLI n’est pas encore installé ? Alors commence par Installer WP-CLI. Ce qui vaut pour chaque commande, par exemple l’utilisateur et le paramètre --force, se trouve dans Les commandes en un coup d’œil.

Un plan de sauvegarde regroupe quand une sauvegarde s’exécute, ce qu’elle contient, où elle va et combien de sauvegardes restent par destination. Tu nommes un plan par son identifiant, par exemple plan-1, ou par son nom. Pour les lettres a à z, la casse ne joue aucun rôle dans le nom ; les lettres accentuées, tu les écris telles qu’elles figurent dans le nom. Un nom contenant des espaces se met entre guillemets.

Chaque action sauf list vérifie que tu travailles en tant que l’utilisateur à qui appartiennent les dossiers de l’extension. --force passe outre cette vérification.

Afficher les plans : list

# Afficher tous les plans de sauvegarde avec état, rythme et prochaine exécution
wp cloneworx-backup plan list

La sortie affiche deux lignes par plan. La première porte l’identifiant, l’état, le nom, le rythme avec l’heure de démarrage et les identifiants des destinations. La seconde indique la prochaine exécution, la dernière exécution, le contenu, Sauvegardes max. et l’instantané. La dernière ligne compte les plans et indique combien il peut y en avoir au plus.

Dans la sortie	Signification
`active`	Le plan est actif et s’exécute de lui-même à sa prochaine exécution.
`paused`	Le plan est en pause. Aucune sauvegarde n’est planifiée.
`paused (no target)`	Le plan est en pause parce qu’il n’a plus de destination. Choisis une destination, il pourra ensuite être activé.
`next run`	La prochaine exécution dans le fuseau horaire du site. Pour un plan en pause, un tiret figure ici.
`last run`	La dernière exécution avec son déclencheur : `schedule` (planification), `manual` (sur les pages de l’extension) ou `cli` (ligne de commande). `missed` indique une échéance manquée ensuite. `could not start` signifie : la dernière exécution à l’échéance n’a pas pu démarrer.
`roots`	Ce que le plan sauvegarde, sous forme de liste des zones.
`retention`	Sauvegardes max.
`snapshot`	Sauvegarder la base de données comme instantané : `yes` ou `no`

Créer un plan : add

# Sauvegarder tous les jours à 03:15 vers la destination sftp-1
wp cloneworx-backup plan add --targets=sftp-1 --rhythm=daily --time=03:15 --name="Nachts"

# Le dimanche à 22 h, base de données et téléversements, conserver 3 sauvegardes
wp cloneworx-backup plan add --targets=local-1 --rhythm=weekly --weekday=7 --time=22:00 --roots=db,wp-uploads --retention=3

# Activer le nouveau plan de sauvegarde
wp cloneworx-backup plan resume "Nachts"

Seul --targets est obligatoire. Tout le reste a une valeur par défaut.

Paramètre	Signification	Valeurs autorisées
`--targets=<identifiant>`	La destination du plan, dans le formulaire Les sauvegardes vont vers. Obligatoire.	L’identifiant d’une destination utilisable, pas son nom. La version gratuite permet une destination par plan.
`--name=<nom>`	Le nom du plan. Sans ce paramètre, l’extension attribue sa proposition.	Au plus 100 caractères. Tout nom qu’aucun autre plan ne porte encore convient.
`--rhythm=<Rhythmus>`	Rythme	`1h`, `2h`, `4h`, `6h`, `12h`, `daily`, `weekly`, `monthly`. Par défaut : `daily`.
`--time=HH:MM`	Heure dans le fuseau horaire du site.	Heure de 0 à 23, minutes 00, 15, 30 ou 45. Par défaut : une heure aléatoire.
`--weekday=<Zahl>`	Jour de la semaine, pour le rythme `weekly`.	1 pour lundi à 7 pour dimanche. Par défaut : 1.
`--monthday=<Tag>`	Jour du mois, pour le rythme `monthly`.	1 à 28, ou `last` pour le dernier jour du mois. Par défaut : 1.
`--roots=<Liste>`	Ce qui est sauvegardé : les zones, séparées par des virgules.	Voir le tableau des zones. Par défaut : toutes.
`--retention=<Zahl>`	Sauvegardes max. : combien de bonnes sauvegardes restent par destination.	1 à 99. Par défaut : 7.
`--snapshot=<Wert>`	Sauvegarder la base de données comme instantané	`yes` ou `no`. Par défaut : `yes`.
`--force`	Passe outre la vérification de l’utilisateur.

Un nouveau plan est en pause. Il ne s’exécute que lorsque tu l’actives avec resume.
L’heure de démarrage peut différer de l’heure indiquée. À la création, l’extension ajoute au hasard 0 à 14 minutes et conserve ce supplément. 03:15 devient par exemple 03:22. Ainsi, tous les sites d’un serveur ne démarrent pas à la même minute.
Pour les rythmes de 1h à 12h, seule la minute de l’heure compte. Les exécutions se suivent à partir de 0 h à l’intervalle du rythme.
La version gratuite permet deux plans. Si la limite est atteinte, la commande n’en crée pas d’autre.

Les zones pour --roots

Valeur	Dans le formulaire	Contenu
`db`	Base de données	Les tables de la base de données qui appartiennent à ce site.
`wp-config`	wp-config.php	Le fichier `wp-config.php`. Une restauration ne le restaure jamais.
`wp-content`	wp-content	Tout ce qui, dans `wp-content`, n’appartient pas aux extensions, aux thèmes, aux mu-plugins ou aux téléversements.
`wp-core`	Cœur de WordPress	Les dossiers `wp-admin` et `wp-includes` et les fichiers que WordPress livre dans le dossier racine.
`wp-mu-plugins`	Extensions incontournables (mu-plugins)	Le dossier des mu-plugins.
`wp-plugins`	Plugins	Le dossier des extensions.
`wp-themes`	Thèmes	Le dossier des thèmes.
`wp-uploads`	Téléversements (uploads)	Le dossier des téléversements.
`wp-root`	Dossier racine	Tout le reste dans le dossier racine du site, par exemple `.htaccess` et `robots.txt`.

Les règles d’exclusion et les tables dont seule la structure est sauvegardée valent pour tout le site et donc pour chaque plan. Pour en savoir plus : Définir ce qui est sauvegardé.

Modifier un plan : edit

# Modifier l’heure et désactiver l’instantané
wp cloneworx-backup plan edit "Nachts" --time=04:30 --snapshot=no

# Choisir une autre destination
wp cloneworx-backup plan edit plan-1 --targets=local-1

edit prend les mêmes paramètres que add et en a besoin d’au moins un. Seul ce que tu nommes est modifié. Si tu modifies le rythme, le jour ou l’heure, l’extension recalcule la prochaine exécution. Le supplément aléatoire à l’heure reste le même.

Mettre en pause et activer : pause et resume

# Mettre le plan de sauvegarde en pause
wp cloneworx-backup plan pause plan-1

# Activer le plan de sauvegarde
wp cloneworx-backup plan resume plan-1

resume indique dans la sortie la prochaine exécution. L’extension la calcule à partir de maintenant : un plan en pause depuis des semaines ne démarre pas à l’instant où tu l’actives. Un plan ne peut être activé qu’avec une destination utilisable, c’est-à-dire une destination dont le dernier test de connexion a réussi.

Un plan actif démarre de lui-même à sa prochaine exécution dès qu’un planificateur sollicite le site. Si aucun planificateur n’arrive dans l’heure qui suit l’échéance, l’exécution est considérée comme manquée : rien ne démarre, et le plan passe à sa prochaine échéance régulière. Un site sans visiteurs a donc besoin d’un cron système : Planification et cron système avec WP-CLI.

Exécuter un plan immédiatement : run

# Exécuter le plan de sauvegarde maintenant et attendre le résultat
wp cloneworx-backup plan run "Sauvegarde quotidienne"

# Seulement lancer la sauvegarde ; le site la poursuit
wp cloneworx-backup plan run plan-1 --background

run lance immédiatement une sauvegarde avec le contenu et la destination du plan. Cela fonctionne aussi pour un plan en pause : seule la planification est en pause. La sauvegarde compte pour le plan et vaut comme sa dernière exécution. Elle ne décale pas la prochaine exécution planifiée.

Paramètre	Signification
`--background`	La commande lance la sauvegarde et se termine. Le site la poursuit lui-même ; `wp cloneworx-backup job status` affiche l’état.
`--force`	Passe outre la vérification de l’utilisateur.

Sans --background, la commande affiche une ligne de progression par étape : la phase, le nombre d’entrées, la quantité et, dès qu’il peut être estimé, le temps restant. À la fin figure le résultat avec le nombre d’étapes et d’avertissements, puis les détails sur la base de données, les fichiers et le transfert par destination. Après une bonne sauvegarde, la commande mène aussi le post-traitement à son terme : elle supprime les sauvegardes qui dépassent Sauvegardes max. et nettoie les restes sur les destinations.

Si la sauvegarde échoue, la sortie indique les derniers messages de la tâche, l’état par destination et la raison. Si le plan n’a pas de destination utilisable ou qu’une autre tâche est déjà en cours, la commande ne lance rien et le dit.

Supprimer un plan : remove

# Supprimer le plan de sauvegarde ; ses sauvegardes restent
wp cloneworx-backup plan remove "Nachts"

La commande ne demande pas de confirmation

Contrairement à la page Sauvegarde, il n’y a ici aucune demande de confirmation : le plan est supprimé immédiatement. Les sauvegardes qu’il a créées restent.

Si tu supprimes tous les plans, l’extension crée de nouveau un premier plan avec la prochaine destination que tu ajoutes.

Si la commande refuse une indication

Si une indication ne convient pas, la commande n’enregistre rien. Elle nomme le champ avec un code et se termine par Plan settings are not valid.

Champ	Code	Signification
`name`	`required`, `taken`, `too_long`	Le nom est vide, appartient déjà à un autre plan ou dépasse 100 caractères.
`rhythm`, `weekday`, `monthday`, `snapshot`	`invalid`	La valeur ne figure pas dans le tableau des valeurs autorisées.
`roots`	`required`, `invalid`	La liste est vide ou nomme une zone qui n’existe pas.
`targets`	`required`	La liste est vide.
`targets`	`too_many`	Le plan nomme plus de destinations que permis.
`targets`	`unknown`	La destination n’existe pas, ou elle est retirée.
`targets`	`not_usable`	La destination n’est pas utilisable. Teste d’abord sa connexion.
`retention`	`invalid`, `out_of_range`	La valeur n’est pas un nombre entier ou n’est pas comprise entre 1 et 99.
`state`	`no_usable_target`	Le plan ne peut pas être activé parce qu’il n’a pas de destination utilisable.

Une heure dans une forme incorrecte est refusée immédiatement par la commande, qui indique la forme autorisée. Si le nombre maximal de plans est atteint, elle signale la limite, par exemple At most 2 plans.

Voir aussi