summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/aggregate.rst
blob: 642942d4577f06fffa34ff7efeed65098c8bd470 (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
174
175
176
177
178
179
180
181
=========
aggregate
=========

Host aggregates provide a mechanism to group hosts according to certain
criteria.

Compute v2

aggregate add host
------------------

Add host to aggregate

.. program:: aggregate add host
.. code:: bash

    os aggregate add host
        <aggregate>
        <host>

.. _aggregate_add_host-aggregate:
.. describe:: <aggregate>

    Aggregate (name or ID)

.. describe:: <host>

    Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>`

aggregate create
----------------

Create a new aggregate

.. program:: aggregate create
.. code:: bash

    os aggregate create
        [--zone <availability-zone>]
        [--property <key=value> [...] ]
        <name>

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

    Availability zone name

.. option:: --property <key=value>

    Property to add to this aggregate (repeat option to set multiple properties)

.. describe:: <name>

    New aggregate name

aggregate delete
----------------

Delete existing aggregate(s)

.. program:: aggregate delete
.. code:: bash

    os aggregate delete
        <aggregate> [<aggregate> ...]

.. describe:: <aggregate>

    Aggregate(s) to delete (name or ID)

aggregate list
--------------

List all aggregates

.. program:: aggregate list
.. code:: bash

    os aggregate list
        [--long]

.. option:: --long

    List additional fields in output

aggregate remove host
---------------------

Remove host from aggregate

.. program:: aggregate remove host
.. code:: bash

    os aggregate remove host
        <aggregate>
        <host>

.. _aggregate_remove_host-aggregate:
.. describe:: <aggregate>

    Aggregate (name or ID)

.. describe:: <host>

    Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`

aggregate set
-------------

Set aggregate properties

.. program:: aggregate set
.. code:: bash

    os aggregate set
        [--name <new-name>]
        [--zone <availability-zone>]
        [--property <key=value> [...] ]
        [--no-property]
        <aggregate>

.. option:: --name <name>

    Set aggregate name

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

    Set availability zone name

.. option:: --property <key=value>

    Property to set on :ref:`\<aggregate\> <aggregate_set-aggregate>`
    (repeat option to set multiple properties)

.. option:: --no-property

    Remove all properties from :ref:`\<aggregate\> <aggregate_set-aggregate>`
    (specify both --property and --no-property to
    overwrite the current properties)

.. _aggregate_set-aggregate:
.. describe:: <aggregate>

    Aggregate to modify (name or ID)

aggregate show
--------------

Display aggregate details

.. program:: aggregate show
.. code:: bash

    os aggregate show
        <aggregate>

.. describe:: <aggregate>

    Aggregate to display (name or ID)

aggregate unset
---------------

Unset aggregate properties

.. program:: aggregate unset
.. code-block:: bash

    os aggregate unset
        [--property <key> [...] ]
        <aggregate>

.. option:: --property <key>

    Property to remove from :ref:`\<aggregate\> <aggregate_unset-aggregate>`
    (repeat option to remove multiple properties)

.. _aggregate_unset-aggregate:
.. describe:: <aggregate>

    Aggregate to modify (name or ID)