summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/backup.rst
blob: f892327695a17e48b099f099ce0577d429a6bff8 (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
======
backup
======

Block Storage v1, v2

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

Create new backup
(Deprecated, please use ``volume backup create`` instead)

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

    openstack backup create
        [--container <container>]
        [--name <name>]
        [--description <description>]
        [--snapshot <snapshot>]
        [--force]
        [--incremental]
        <volume>

.. option:: --container <container>

    Optional backup container name

.. option:: --name <name>

    Name of the backup

.. option:: --description <description>

    Description of the backup

.. option:: --snapshot <snapshot>

    Snapshot to backup (name or ID)

    *Volume version 2 only*

.. option:: --force

    Allow to back up an in-use volume

    *Volume version 2 only*

.. option:: --incremental

    Perform an incremental backup

    *Volume version 2 only*

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

    Volume to backup (name or ID)

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

Delete backup(s)
(Deprecated, please use ``volume backup delete`` instead)

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

    openstack backup delete
        [--force]
        <backup> [<backup> ...]

.. option:: --force

    Allow delete in state other than error or available

    *Volume version 2 only*

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

    Backup(s) to delete (name or ID)

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

List backups
(Deprecated, please use ``volume backup list`` instead)

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

    openstack backup list

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

    List additional fields in output

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

Restore backup
(Deprecated, please use ``volume backup restore`` instead)

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

    openstack backup restore
        <backup>
        <volume>

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

    Backup to restore (name or ID)

.. describe:: <volume>

    Volume to restore to (name or ID)

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

Display backup details
(Deprecated, please use ``volume backup show`` instead)

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

    openstack backup show
        <backup>

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

    Backup to display (name or ID)