summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/consistency-group.rst
blob: 57082c6df856224908d5559c788cf384f6c0a165 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
=================
consistency group
=================

Block Storage v2

consistency group add volume
----------------------------

Add volume(s) to consistency group.

.. program:: consistency group add volume
.. code:: bash

    openstack consistency group add volume
        <consistency-group>
        <volume> [<volume> ...]

.. _consistency_group_add_volume:
.. describe:: <consistency-group>

    Consistency group to contain <volume> (name or ID)

.. describe:: <volume>

    Volume(s) to add to <consistency-group> (name or ID)
    (repeat option to add multiple volumes)

consistency group create
------------------------

Create new consistency group.

.. program:: consistency group create
.. code:: bash

    openstack consistency group create
        --volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>
        [--description <description>]
        [--availability-zone <availability-zone>]
        [<name>]

.. option:: --volume-type <volume-type>

    Volume type of this consistency group (name or ID)

.. option:: --consistency-group-source <consistency-group>

    Existing consistency group (name or ID)

.. option:: --consistency-group-snapshot <consistency-group-snapshot>

    Existing consistency group snapshot (name or ID)

.. option:: --description <description>

    Description of this consistency group

.. option:: --availability-zone <availability-zone>

    Availability zone for this consistency group
    (not available if creating consistency group from source)

.. _consistency_group_create-name:
.. describe:: <name>

    Name of new consistency group (default to None)

consistency group delete
------------------------

Delete consistency group(s).

.. program:: consistency group delete
.. code:: bash

    openstack consistency group delete
        [--force]
        <consistency-group> [<consistency-group> ...]

.. option:: --force

    Allow delete in state other than error or available

.. _consistency_group_delete-consistency-group:
.. describe:: <consistency-group>

    Consistency group(s) to delete (name or ID)

consistency group list
----------------------

List consistency groups.

.. program:: consistency group list
.. code:: bash

    openstack consistency group list
        [--all-projects]
        [--long]

.. option:: --all-projects

    Show detail for all projects. Admin only.
    (defaults to False)

.. option:: --long

    List additional fields in output

consistency group remove volume
-------------------------------

Remove volume(s) from consistency group.

.. program:: consistency group remove volume
.. code:: bash

    openstack consistency group remove volume
        <consistency-group>
        <volume> [<volume> ...]

.. _consistency_group_remove_volume:
.. describe:: <consistency-group>

    Consistency group containing <volume> (name or ID)

.. describe:: <volume>

    Volume(s) to remove from <consistency-group> (name or ID)
    (repeat option to remove multiple volumes)

consistency group set
---------------------

Set consistency group properties.

.. program:: consistency group set
.. code:: bash

    openstack consistency group set
        [--name <name>]
        [--description <description>]
        <consistency-group>

.. option:: --name <name>

    New consistency group name

.. option:: --description <description>

    New consistency group description

.. _consistency_group_set-consistency-group:
.. describe:: <consistency-group>

    Consistency group to modify (name or ID)

consistency group show
----------------------

Display consistency group details.

.. program:: consistency group show
.. code:: bash

    openstack consistency group show
        <consistency-group>

.. _consistency_group_show-consistency-group:
.. describe:: <consistency-group>

    Consistency group to display (name or ID)