summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/backup.rst
blob: 9d7fb95d685895c0a1a063803c1db45526a0db8c (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
======
backup
======

Block Storage v1

backup create
-------------

Create new backup

.. program:: backup create
.. code:: bash

    os backup create
        [--container <container>]
        [--name <name>]
        [--description <description>]
        <volume>

.. option:: --container <container>

    Optional backup container name

.. option:: --name <name>

    Name of the backup

.. option:: --description <description>

    Description of the backup

.. _backup_create-backup:
.. describe:: <volume>

    Volume to backup (name or ID)

backup delete
-------------

Delete backup(s)

.. program:: backup delete
.. code:: bash

    os backup delete
        <backup> [<backup> ...]

.. _backup_delete-backup:
.. describe:: <backup>

    Backup(s) to delete (ID only)

backup list
-----------

List backups

.. program:: backup list
.. code:: bash

    os backup list

.. _backup_list-backup:
.. option:: --long

    List additional fields in output

backup restore
--------------

Restore backup

.. program:: backup restore
.. code:: bash

    os backup restore
        <backup>
        <volume>

.. _backup_restore-backup:
.. describe:: <backup>

    Backup to restore (ID only)

.. describe:: <volume>

    Volume to restore to (name or ID)

backup show
-----------

Display backup details

.. program:: backup show
.. code:: bash

    os backup show
        <backup>

.. _backup_show-backup:
.. describe:: <backup>

    Backup to display (ID only)