Gestionar destinos con WP-CLI

Con el comando target gestionas tus destinos en la línea de comandos: mostrar, crear, cambiar, probar, comprobar, limpiar y quitar. A esto se añaden las acciones para un conflicto de huella y para recuperar copias de seguridad.

¿Aún no tienes WP-CLI configurado? Entonces empieza por Instalar WP-CLI. Lo que rige para cada comando, por ejemplo el usuario y el parámetro --background, está en Los comandos de un vistazo.

Nombrar un destino

Un destino lo nombras con su identificador o con su nombre. El identificador se compone del tipo de destino y un número correlativo, por ejemplo local-1 o sftp-1. El identificador nunca cambia, aunque renombres el destino. En los nombres no importan las mayúsculas y minúsculas; un nombre con espacios va entre comillas.

Todas las acciones excepto list comprueban si estás trabajando como el usuario al que pertenecen las carpetas del plugin. --force omite esa comprobación.

Mostrar destinos: list

# Mostrar todos los destinos con identificador y estado
wp cloneworx-backup target list

La salida muestra una línea por destino: identificador, tipo de destino, nombre, estado y ubicación. La última línea empieza por Types: y enumera los tipos de destino que existen: local, ftp, sftp, webdav, amazon-s3, s3, google-drive y dropbox. Si al servidor le falta algo para un tipo de destino, aparece entre paréntesis detrás.

Estado en la salida	Significado	Utilizable
connected (tested …)	La última prueba de conexión ha tenido éxito; detrás aparece su momento.	sí
not tested yet	Guardado, pero sin prueba correcta desde el último cambio de los ajustes.	no
test failed (…)	La última prueba de conexión ha fallado; entre paréntesis está el código del motivo.	no
disconnected (…)	Las credenciales guardadas ya no se pueden usar; entre paréntesis está el código del motivo, por ejemplo secrets_unreadable (ya no legibles) o auth_failed (rechazadas por el destino). Introdúcelas de nuevo en la página Destinos: Renovar las credenciales de un destino. En un destino del tipo Google Drive o Dropbox, el código es grant_invalid cuando el proveedor ya no acepta el consentimiento; allí lo vuelves a conectar.	no
type not available	Al servidor le falta algo para este tipo de destino.	no
removed	Quitado; las copias de seguridad de la lista aún hacen referencia al destino.	no

Detrás del estado pueden aparecer dos indicaciones. CATALOG CONFLICT es un conflicto de huella: el catálogo del destino pertenece a otra instalación; la salida indica su dirección. catalog stale significa: el catálogo del destino no se pudo escribir la última vez; la copia de seguridad es buena de todos modos, y la siguiente copia vuelve a escribir el catálogo.

Crear un destino: add

# Crear una carpeta local como destino
wp cloneworx-backup target add local --name="Archiv" --set-path=/var/backups

# Probar el nuevo destino
wp cloneworx-backup target test local-1

Dato	Significado	Valores permitidos
Tipo de destino	Va justo detrás de add.	local. Los demás tipos de destino exigen una contraseña o una clave y por eso no se pueden crear aquí. google-drive y dropbox los rechaza el comando e indica el camino en el navegador: página Destinos, Añadir destino.
--name=<nombre>	Tu nombre para el destino. Sin el parámetro, el plugin asigna su propuesta.	Como máximo 100 caracteres. Vale cualquier nombre que aún no esté en uso, tampoco por un destino quitado.
--set-path=<carpeta>	La carpeta en el servidor, en el formulario el campo Carpeta en el servidor. Obligatorio.	Una ruta absoluta a una carpeta que ya exista y en la que se pueda escribir. No puede estar en el directorio del plugin, que WordPress borra en cada actualización.
--force	Omite la comprobación del usuario.

El comando guarda el destino e indica su identificador. Con eso aún no está probado: un destino solo se vuelve utilizable con una prueba de conexión correcta. La carpeta propia del plugin no tienes que crearla; se crea dentro de la carpeta que indicas.

Con tu primer destino, el plugin crea el plan «Copia diaria». Está en pausa hasta que lo actives. Más al respecto: Gestionar planes de copia de seguridad con WP-CLI.

Si un dato no es correcto, el comando no guarda nada. Nombra el campo con un código y termina con Settings are not valid.

Código	Significado
required	Un campo obligatorio está vacío.
base_invalid	La ruta no es absoluta o la carpeta no existe.
base_in_plugin	La carpeta está en el directorio del plugin.
base_not_writable	No se puede escribir en la carpeta.
taken, too_long	El nombre ya está en uso o tiene más de 100 caracteres.
invalid, out_of_range	El valor no está permitido o está fuera de sus límites.

Cambiar un destino: edit

# Renombrar un destino
wp cloneworx-backup target edit local-1 --name="Archiv 2"

# Cambiar un ajuste y volver a probar
wp cloneworx-backup target edit sftp-1 --set-port=2222
wp cloneworx-backup target test sftp-1

edit necesita al menos --name o un ajuste. Un ajuste lo estableces con --set-, seguido del nombre del ajuste y su valor, por ejemplo --set-port=2222. Las contraseñas y claves guardadas se conservan. Tras un ajuste cambiado, el destino vuelve a contar como no probado: pruébalo de nuevo, si no, los planes y las copias de seguridad lo omiten. Un nombre nuevo no cambia nada de eso.

Ajuste	Campo en el formulario	Tipos de destino	Valores permitidos
path	Carpeta en el servidor, Carpeta en el servidor FTP, Carpeta en el servidor SFTP, Carpeta en el bucket, Carpeta en Google Drive	local, ftp, sftp, amazon-s3, s3, google-drive	Obligatorio en local. En los demás, el valor puede estar vacío.
host	Servidor	ftp, sftp	Nombre de host o dirección IP
user	Nombre de usuario	ftp, sftp, webdav
port	Puerto	ftp, sftp	De 1 a 65535. Vacío significa 21 en ftp, 990 en FTPS implícito, 22 en sftp.
timeout	Tiempo límite de conexión (segundos)	ftp, sftp, webdav, amazon-s3, s3, google-drive, dropbox	De 3 a 60, predeterminado 10
security	Cifrado	ftp	explicit (FTPS con TLS), none (ninguno), implicit (FTPS implícito)
mode	Modo de transferencia	ftp	passive, active
auth	Inicio de sesión	sftp	password, key
url	Dirección de la carpeta	webdav	La dirección completa
method	Método de subida	webdav	range, chunks, whole. Vacío significa: lo que la prueba de conexión ha determinado.
upload_rate	Velocidad de subida (bytes por segundo)	webdav, amazon-s3, s3, google-drive, dropbox	De 1024 a 1073741824. Vacío significa: lo que la prueba de conexión ha medido.
bucket	Bucket	amazon-s3, s3
access_key	Clave de acceso	amazon-s3, s3
region	Región	amazon-s3, s3
endpoint	Dirección del servicio	s3	La dirección sin el bucket
style	Forma de la dirección	s3	path, virtual. Vacío significa: lo que la prueba de conexión ha determinado.

No se acepta lo que es secreto: password, private_key y secret_key. Los ajustes tls_pin y host_key contienen un certificado aceptado o la clave confirmada de un servidor. Ambos los establece la página Destinos cuando aceptas allí un certificado o una clave de servidor. Si indicas un ajuste que el tipo de destino no conoce, el comando enumera los ajustes del tipo de destino.

Probar la conexión: test

# Probar la conexión de un destino
wp cloneworx-backup target test sftp-1

La prueba escribe un archivo pequeño en el destino, lo vuelve a leer, lo compara y lo borra de nuevo. El resultado se guarda en el destino: tras una prueba correcta, el destino es utilizable.

La salida indica los detalles de la prueba como líneas de nombre y valor, por ejemplo el espacio libre en la línea free_space. La última línea dice si el destino funciona (works) o por qué motivo ha fallado la prueba (failed). Si los archivos nuevos pertenecen a un usuario distinto del de la carpeta del destino, el comando advierte: puede que el sitio web no pueda cambiar ni borrar esos archivos.

Comprobar las copias de seguridad de un destino: check

# Comprobar cada copia de seguridad de este destino
wp cloneworx-backup target check sftp-1

# Solo iniciar la comprobación; el sitio web la continúa
wp cloneworx-backup target check sftp-1 --background

La comprobación lee cada copia de seguridad que está en este destino, la más reciente primero: cada archivo, el archivo de información, cada parte con su suma de comprobación y cada bloque. No se restaura nada. El resultado aparece después también en la lista de copias de seguridad.

La salida muestra una línea por copia de seguridad con el resultado y al final el total:

Resultado en la salida	Significado
ok	La copia de seguridad es legible y completa. Detrás aparecen el número de partes, el número de entradas y la cantidad leída.
damaged or incomplete	La copia de seguridad está dañada o incompleta en este destino. Detrás se indica qué no está bien.
not checked	El destino no ha respondido. Es una advertencia, no un daño en la copia.
not complete at this target	La copia de seguridad no está completa en este destino.

Se comprueba cada copia buena que está completa en el destino o que está marcada allí como dañada. Si no hay ninguna, la comprobación no se inicia y lo dice.

Limpiar restos: cleanup

# Mostrar solo lo que se eliminaría
wp cloneworx-backup target cleanup local-1 --dry-run

# Eliminar los restos
wp cloneworx-backup target cleanup local-1

Un resto es una carpeta que un trabajo cancelado ha dejado en el destino y que nunca será una copia de seguridad: no tiene archivo de información, no pertenece al trabajo en curso y la lista de copias no la tiene en este destino. Una subida sin terminar también cuenta como resto. La misma ejecución elimina archivos antiguos de la carpeta de trabajo del plugin en el servidor. Una carpeta con archivo de información siempre se queda, y lo que está en la lista la limpieza nunca lo toca.

Parámetro	Significado
--dry-run	Muestra por carpeta el número de archivos y el tamaño, y no elimina nada. No se ejecuta ningún trabajo.
--background	Inicia el trabajo; el sitio web lo continúa.
--force	Omite la comprobación del usuario.

La salida indica por destino el número de carpetas y archivos eliminados y su tamaño, además del número de carpetas de copia que se quedan aunque la lista no las conozca. Esas copias las traes a la lista con rebuild. La limpieza también se ejecuta por sí sola después de cada copia buena, en los destinos a los que ha llegado esa copia.

Responder a un conflicto de huella: moved y copy

Antes de escribir en un destino, el plugin compara la huella del catálogo del destino con la suya. Si no coinciden, no escribe ni borra nada allí hasta que decidas. Qué respuesta es la correcta en cada caso lo explica El sitio web se ha mudado o es una copia.

# Mismo sitio web, nueva dirección o nueva ruta: trasladado
wp cloneworx-backup target moved sftp-1

# Esta instalación es una copia del original
wp cloneworx-backup target copy sftp-1 --yes

Acción	Qué ocurre
moved	El catálogo del destino se vuelve a escribir con la huella de esta instalación, el conflicto anotado queda resuelto y el destino se vuelve a usar. La salida indica la dirección que el catálogo tenía antes. Nunca uses moved para una copia.
copy --yes	Esta instalación recibe un nuevo código de carpeta y con él una carpeta propia en cada destino. La carpeta de registros y la carpeta de trabajo se trasladan con ella. Las copias de seguridad de la lista de esta instalación pertenecen al original y desaparecen de la lista; en los destinos no se borra nada. Todos los conflictos anotados quedan resueltos. La siguiente copia escribe en la nueva carpeta.

copy se aplica a toda la instalación, no solo al destino indicado. Sin --yes, el comando no cambia nada: indica las consecuencias y el número de entradas que desaparecerían de la lista.

Recuperar copias de seguridad: sites, adopt y rebuild

Cada instalación del plugin tiene un código de carpeta propio, y sus copias de seguridad están en cada destino en la carpeta cloneworx-backup-<código>. Tras una pérdida total, la instalación nueva no conoce la carpeta de la anterior. Todo el camino lo describe Recuperar copias de seguridad tras una pérdida total.

# Mostrar lo que hay en la ubicación del destino
wp cloneworx-backup target sites sftp-1

# Asumir la carpeta de una instalación anterior
wp cloneworx-backup target adopt sftp-1 --folder=cloneworx-backup-0123456789abcdef0123456789abcdef

# Añadir a la lista las copias de seguridad de la propia carpeta
wp cloneworx-backup target rebuild sftp-1

sites

La salida empieza con la carpeta propia: si su catálogo es legible, cuántas copias de seguridad nombra el catálogo, cuántas copias tiene la lista en este destino y cuántas copias de la carpeta faltan en la lista. Debajo siguen las carpetas de otras instalaciones, cada carpeta con la dirección del sitio web de su catálogo, el número de copias, la fecha de la última y la versión del plugin. La última línea dice si asumir es posible en este momento.

adopt

Parámetro	Significado	Valores permitidos
--folder=<nombre>	La carpeta de la instalación anterior en el destino. Obligatorio.	El nombre de la carpeta, cloneworx-backup- y 32 caracteres, o los 32 caracteres solos.
--background	Inicia la incorporación a la lista; el sitio web la continúa.
--force	Omite la comprobación del usuario.

Esta instalación sigue trabajando después con el código de carpeta de la anterior. La carpeta de registros y la carpeta de trabajo se trasladan con él, las carpetas vacías con el código anterior se eliminan en los destinos locales, y las copias de seguridad de la carpeta pasan a la lista. Asumir confirma a la vez que el sitio web se ha trasladado.

rebuild

rebuild incorpora a la lista las copias de seguridad de la carpeta propia en el destino que faltan allí, por ejemplo después de quitar un destino y configurarlo de nuevo. El trabajo lee el catálogo del destino; sin catálogo legible, la lista de carpetas. De cada copia obtiene el archivo de información y comprueba si cada archivo está en el destino con su tamaño. Con --background, el sitio web continúa el trabajo.

La última línea indica el resultado: cuántas copias de seguridad se encontraron, cuántas se añadieron a la lista, cuántas ya estaban en ella y cuántas están incompletas. Las copias recuperadas nunca las borra el plugin automáticamente.

Quitar un destino: remove

# Quitar el destino; sus copias de seguridad se quedan allí
wp cloneworx-backup target remove local-1

# Primero borrar todas las copias del destino, después quitar el destino
wp cloneworx-backup target remove local-1 --with-backups

Parámetro	Significado
sin parámetro	El destino se quita. Las copias de seguridad se quedan en el destino, donde están.
--with-backups	El plugin borra primero cada copia de seguridad de este destino y después quita el destino. El comando lleva el trabajo por sí mismo hasta el final. Si hay copias bloqueadas en el destino, lo rechaza: desbloquéalas primero o quita el destino sin sus copias.
--force	Omite la comprobación del usuario.

• Si las copias de seguridad de la lista aún hacen referencia al destino, su entrada se queda como quitado, sin ajustes y sin credenciales. La salida indica el número de entradas que aún hacen referencia a él.
• Si ya ninguna copia hace referencia a él, el comando borra la entrada por completo. Esto también vale para un destino que ya está quitado.
• Un destino quitado sale de todos los planes de copia. Un plan sin destino se pone en pausa. Solo se puede volver a activar cuando le des un destino.
• En un destino del tipo Dropbox, el plugin revoca en Dropbox, tras quitarlo, el acceso que tenía el destino. Las copias de seguridad se quedan en tu Dropbox. La revocación no se produce si las credenciales guardadas ya no son legibles, si el destino ya se había quitado o si falta cURL. Falla si Dropbox o el servicio de inicio de sesión no están disponibles en ese momento. El destino se quita de todos modos. El acceso sigue siendo válido entonces en Dropbox hasta que desvincules la app en tu cuenta de Dropbox.
• En un destino del tipo Google Drive, el plugin no revoca nada: el acceso que tenía el destino sigue siendo válido en Google, y el consentimiento permanece en tu cuenta de Google hasta que lo elimines allí.

Consulta también

• La página «Destinos»
• Guardar copias de seguridad en una carpeta local
• Comprobar las copias en un destino y limpiar restos
• Quitar un destino
• Gestionar planes de copia de seguridad con WP-CLI