.. _Backup and Restoration Utilities:

Backup and Restoration Utilities
--------------------------------

Any container is defined by its private area, configuration files, action scripts, and quota information. Backing up these components allows you to restore all the content of a container on any Virtuozzo-based system at any time if the container gets broken.

.. _prlctl backup, backup-list, backup-delete, restore:

prlctl backup, backup-list, backup-delete, restore
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Creates, lists, deletes or restores container backups.

::

    prlctl backup <CT_name|CT_UUID> [-f, --full] [-i, --incremental] 
                  [-s, --storage [<user>[:<passwd>]@]<server>[:<port>]]
                  [--description <desc>] [--no-compression] [--no-tunnel]
    prlctl backup-list [<CT_name|CT_UUID>] [-f, --full] [--localvms] [--vmtype ct]
                       [-s, --storage [<user>[:<passwd>]@]<server>[:<port>]]
    prlctl backup-delete {<CT_name|CT_UUID> | -t, --tag <backup_ID>} [--keep-chain]
    prlctl restore {<CT_UUID> | -t, --tag <backup_ID>} [-n, --name <new_name>]
                   [--dst=<path>] [-s, --storage [<user>[:<passwd>]@]<server>[:<port>]]
                   [--no-tunnel]

+------------------------------------------------------------------------+------------------------------------------------------------------------+
| Name                                                                   | Description                                                            |
+========================================================================+========================================================================+
| ``<CT_name|CT_UUID>``                                                  | Container name or UUID.                                                |
|                                                                        |                                                                        |
|                                                                        | -  Use with ``prlctl backup`` to create a backup of the specified      |
|                                                                        |    container.                                                          |
|                                                                        |                                                                        |
|                                                                        | -  Use with ``prlctl backup-list`` to list backups of the specified    |
|                                                                        |    container.                                                          |
|                                                                        |                                                                        |
|                                                                        | -  Use with ``prlctl backup-delete`` to delete all backups of the      |
|                                                                        |    specified container.                                                |
|                                                                        |                                                                        |
|                                                                        | -  Use <CT_UUID> with ``prlctl restore`` to restore the most recent    |
|                                                                        |    backup of the specified container.                                  |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``-s, --storage [<user>[:<passwd>]@]<server>[:<port>]``                | Specifies a remote backup server address, port, and credentials. If    |
|                                                                        | this option is omitted, the backup will be saved on the default backup |
|                                                                        | server that can be configured using the ``prlsrvctl set`` command.     |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--description <desc>``                                               | Backup description. Descriptions with white spaces must be enclosed in |
|                                                                        | quotation marks.                                                       |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``-f, --full``                                                         | -  Use with ``prlctl backup`` to create a full backup of the           |
|                                                                        |    container. A full backup contains all container data.               |
|                                                                        |                                                                        |
|                                                                        | -  Use with ``prlctl backup-list`` to display full backup information. |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``-i, --incremental``                                                  | Create an incremental backup of the container. An incremental backup   |
|                                                                        | contains only the files changed since the previous full or incremental |
|                                                                        | backup. This is the default backup type.                               |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--localvms``                                                         | List local backups only.                                               |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--vmtype ct``                                                        | List container backups on the server.                                  |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``-t, --tag <backup_ID>``                                              | The ID of the backup to restore or delete.                             |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``-n, --name <new_name>``                                              | A new name to assign to the restored container. If this option is      |
|                                                                        | omitted, the container will be restored with the original name.        |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--dst=<path>``                                                       | Restore the container to the specified directory on the server. If     |
|                                                                        | this option is omitted, the container will be restored to              |
|                                                                        | ``/vz/private/<CT_UUID>``.                                             |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--no-compression``                                                   | Do not compress the created backup image.                              |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--no-tunnel``                                                        | Disables connection tunneling for backup. Connection tunneling         |
|                                                                        | provides secure data transmission.                                     |
|                                                                        |                                                                        |
|                                                                        | To use this option, configure the firewall of the destination server   |
|                                                                        | to allow incoming connections on any port on the corresponding network |
|                                                                        | interface.                                                             |
+------------------------------------------------------------------------+------------------------------------------------------------------------+
| ``--keep-chain``                                                       | Preserve the rest of the backup chain when deleting specific backups.  |
+------------------------------------------------------------------------+------------------------------------------------------------------------+

