Back-upplannen beheren met WP-CLI – cloneworx Hulp

Met het commando plan beheer je je back-upplannen op de opdrachtregel: tonen, aanmaken, wijzigen, pauzeren, inschakelen, meteen uitvoeren en verwijderen.

Is WP-CLI nog niet ingesteld? Begin dan met WP-CLI installeren. Wat voor elk commando geldt, bijvoorbeeld de gebruiker en de parameter --force, staat in De opdrachten in één oogopslag.

Een back-upplan bundelt wanneer een back-up loopt, wat die bevat, waar die naartoe gaat en hoeveel back-ups per doel blijven. Een plan noem je met zijn kenmerk, bijvoorbeeld plan-1, of met zijn naam. Bij de letters a tot z speelt hoofdlettergebruik in de naam geen rol; umlauten en accenten schrijf je zoals ze in de naam staan. Een naam met spaties staat tussen aanhalingstekens.

Elke actie behalve list controleert of je werkt als de gebruiker aan wie de mappen van de plugin toebehoren. --force slaat deze controle over.

Plannen tonen: list

# Alle plannen met status, ritme en volgende run tonen
wp cloneworx-backup plan list

De uitvoer noemt per plan twee regels. De eerste bevat het kenmerk, de toestand, de naam, het ritme met de starttijd en de kenmerken van de doelen. De tweede noemt de volgende run, de laatste run, de inhoud, Max. back-ups en de momentopname. De laatste regel telt de plannen en noemt hoeveel het er hoogstens mogen zijn.

In de uitvoer	Betekenis
`active`	Het plan is actief en loopt bij zijn volgende run vanzelf.
`paused`	Het plan is gepauzeerd. Er zijn geen back-ups gepland.
`paused (no target)`	Het plan is gepauzeerd omdat het geen doel meer heeft. Kies een doel, dan kan het worden ingeschakeld.
`next run`	De volgende run in de tijdzone van de website. Bij een gepauzeerd plan staat hier een streepje.
`last run`	De laatste run met zijn aanleiding: `schedule` (schema), `manual` (op de pagina’s van de plugin) of `cli` (opdrachtregel). `missed` noemt een run die daarna is gemist. `could not start` betekent: de laatste geplande run kon niet starten.
`roots`	Wat het plan back-upt, als lijst van de onderdelen.
`retention`	Max. back-ups
`snapshot`	Database als momentopname back-uppen: `yes` of `no`

Een plan aanmaken: add

# Dagelijks om 03:15 uur naar het doel sftp-1 back-uppen
wp cloneworx-backup plan add --targets=sftp-1 --rhythm=daily --time=03:15 --name="Nachts"

# Zondags om 22 uur database en uploads, 3 back-ups behouden
wp cloneworx-backup plan add --targets=local-1 --rhythm=weekly --weekday=7 --time=22:00 --roots=db,wp-uploads --retention=3

# Het nieuwe plan inschakelen
wp cloneworx-backup plan resume "Nachts"

Verplicht is alleen --targets. Al het andere heeft een standaard.

Parameter	Betekenis	Toegestane waarden
`--targets=<kenmerk>`	Het doel van het plan, in het formulier Back-ups gaan naar. Verplicht.	Het kenmerk van een bruikbaar doel, niet zijn naam. De gratis versie staat één doel per plan toe.
`--name=<naam>`	De naam van het plan. Zonder de parameter geeft de plugin zijn voorstel.	Hoogstens 100 tekens. Elke naam werkt die nog geen ander plan draagt.
`--rhythm=<Rhythmus>`	Ritme	`1h`, `2h`, `4h`, `6h`, `12h`, `daily`, `weekly`, `monthly`. Standaard: `daily`.
`--time=HH:MM`	Tijd in de tijdzone van de website.	Uur 0 tot 23, minuten 00, 15, 30 of 45. Standaard: een willekeurig tijdstip.
`--weekday=<Zahl>`	Weekdag, bij het ritme `weekly`.	1 voor maandag tot 7 voor zondag. Standaard: 1.
`--monthday=<Tag>`	Dag van de maand, bij het ritme `monthly`.	1 tot 28, of `last` voor de laatste dag van de maand. Standaard: 1.
`--roots=<Liste>`	Wat wordt geback-upt: de onderdelen, gescheiden door komma’s.	Zie de tabel met onderdelen. Standaard: alle.
`--retention=<Zahl>`	Max. back-ups: zoveel goede back-ups blijven per doel.	1 tot 99. Standaard: 7.
`--snapshot=<Wert>`	Database als momentopname back-uppen	`yes` of `no`. Standaard: `yes`.
`--force`	Slaat de controle van de gebruiker over.

Een nieuw plan is gepauzeerd. Het loopt pas als je het met resume inschakelt.
De starttijd kan van de tijd afwijken. Bij het aanmaken telt de plugin er willekeurig 0 tot 14 minuten bij en behoudt die toeslag. Van 03:15 wordt bijvoorbeeld 03:22. Zo starten niet alle websites van een server in dezelfde minuut.
Bij de ritmes van 1h tot 12h telt van de tijd alleen de minuut. De runs liggen vanaf 0 uur op de afstand van het ritme.
De gratis versie staat twee plannen toe. Is de grens bereikt, dan maakt het commando er geen verdere aan.

De onderdelen voor --roots

Waarde	In het formulier	Inhoud
`db`	Database	De tabellen van de database die bij deze website horen.
`wp-config`	wp-config.php	Het bestand `wp-config.php`. Een herstel zet het nooit terug.
`wp-content`	wp-content	Alles in `wp-content` dat niet bij plugins, thema’s, must-use-plugins of uploads hoort.
`wp-core`	WordPress-kern	De mappen `wp-admin` en `wp-includes` en de bestanden die WordPress in de hoofdmap levert.
`wp-mu-plugins`	Must-use-plugins	De map van de must-use-plugins.
`wp-plugins`	Plugins	De map van de plugins.
`wp-themes`	Thema’s	De map van de thema’s.
`wp-uploads`	Uploads	De map van de uploads.
`wp-root`	Hoofdmap	Al het andere in de hoofdmap van de website, bijvoorbeeld `.htaccess` en `robots.txt`.

Uitsluitingsregels en tabellen waarvan alleen de structuur wordt bewaard, gelden voor de hele website en daarmee voor elk plan. Meer daarover: Bepalen wat er wordt geback-upt.

Een plan wijzigen: edit

# De tijd wijzigen en de momentopname uitschakelen
wp cloneworx-backup plan edit "Nachts" --time=04:30 --snapshot=no

# Een ander doel kiezen
wp cloneworx-backup plan edit plan-1 --targets=local-1

edit neemt dezelfde parameters als add en heeft er minstens één nodig. Gewijzigd wordt alleen wat je noemt. Wijzig je ritme, dag of tijd, dan berekent de plugin de volgende run opnieuw. De willekeurige toeslag op de tijd blijft dezelfde.

Pauzeren en inschakelen: pause en resume

# Het plan pauzeren
wp cloneworx-backup plan pause plan-1

# Het plan inschakelen
wp cloneworx-backup plan resume plan-1

resume noemt in de uitvoer de volgende run. De plugin berekent die vanaf nu: een plan dat wekenlang gepauzeerd was, start niet op het moment dat je het inschakelt. Inschakelen kan een plan alleen met een bruikbaar doel, dus een doel waarvan de laatste verbindingstest is geslaagd.

Een actief plan start bij zijn volgende run vanzelf, zodra een taakbron de website aanstoot. Komt er binnen een uur na het tijdstip geen taakbron, dan geldt de run als gemist: er start niets, en het plan schuift door naar zijn volgende reguliere tijdstip. Een website zonder bezoekers heeft daarom een systeemcron nodig: Planning en systeem-cron met WP-CLI.

Een plan meteen uitvoeren: run

# Het plan nu uitvoeren en op het resultaat wachten
wp cloneworx-backup plan run "Dagelijkse back-up"

# De back-up alleen starten; de website zet hem voort
wp cloneworx-backup plan run plan-1 --background

run start meteen een back-up met de inhoud en het doel van het plan. Dat kan ook bij een gepauzeerd plan: gepauzeerd is alleen het schema. De back-up telt mee voor het plan en geldt als zijn laatste run. De volgende geplande run verschuift die niet.

Parameter	Betekenis
`--background`	Het commando start de back-up en eindigt. De website voert hem zelf verder uit; de stand toont `wp cloneworx-backup job status`.
`--force`	Slaat de controle van de gebruiker over.

Zonder --background toont het commando per stap een regel met de voortgang: de fase, het aantal items, de hoeveelheid en, zodra die te schatten is, de resterende tijd. Aan het einde staat het resultaat met het aantal stappen en waarschuwingen, daaronder de details over database, bestanden en overdracht per doel. Na een goede back-up voert het commando ook het nawerk tot het einde uit: het verwijdert back-ups die boven Max. back-ups uitgaan, en ruimt resten op de doelen op.

Mislukt de back-up, dan noemt de uitvoer de laatste meldingen van de taak, de stand per doel en de reden. Heeft het plan geen bruikbaar doel of loopt er al een andere taak, dan start het commando niets en zegt dat.

Een plan verwijderen: remove

# Het plan verwijderen; zijn back-ups blijven
wp cloneworx-backup plan remove "Nachts"

Het commando vraagt niet om bevestiging

Anders dan op de pagina Back-up is er hier geen bevestigingsvraag: het plan is meteen verwijderd. De back-ups die het heeft gemaakt, blijven.

Verwijder je alle plannen, dan maakt de plugin met het volgende doel dat je toevoegt weer een eerste plan aan.

Als het commando een opgave weigert

Klopt een opgave niet, dan slaat het commando niets op. Het noemt het veld met een code en eindigt met Plan settings are not valid.

Veld	Code	Betekenis
`name`	`required`, `taken`, `too_long`	De naam is leeg, behoort al aan een ander plan toe of is langer dan 100 tekens.
`rhythm`, `weekday`, `monthday`, `snapshot`	`invalid`	De waarde staat niet in de tabel met toegestane waarden.
`roots`	`required`, `invalid`	De lijst is leeg of noemt een onderdeel dat niet bestaat.
`targets`	`required`	De lijst is leeg.
`targets`	`too_many`	Het plan noemt meer doelen dan toegestaan.
`targets`	`unknown`	Het doel bestaat niet, of het is verwijderd.
`targets`	`not_usable`	Het doel is niet bruikbaar. Test eerst de verbinding ervan.
`retention`	`invalid`, `out_of_range`	De waarde is geen geheel getal of ligt niet tussen 1 en 99.
`state`	`no_usable_target`	Het plan kan niet worden ingeschakeld omdat het geen bruikbaar doel heeft.

Een tijd in een verkeerde vorm weigert het commando meteen en het noemt de toegestane vorm. Is het maximale aantal plannen bereikt, dan meldt het de grens, bijvoorbeeld At most 2 plans.

Zie ook