summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/server-backup.rst
blob: 9ddb2cdfabec6c46498849cc1c3073ed9337f6a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
=============
server backup
=============

A server backup is a disk image created in the Image store from a running server
instance.  The backup command manages the number of archival copies to retain.

Compute v2

server backup create
--------------------

Create a server backup image

.. program:: server create
.. code:: bash

    openstack server backup create
        [--name <image-name>]
        [--type <backup-type>]
        [--rotate <count>]
        [--wait]
        <server>

.. option:: --name <image-name>

    Name of the backup image (default: server name)

.. option:: --type <backup-type>

    Used to populate the ``backup_type`` property of the backup
    image (default: empty)

.. option:: --rotate <count>

    Number of backup images to keep (default: 1)

.. option:: --wait

    Wait for operation to complete

.. describe:: <server>

    Server to back up (name or ID)