File: project.rst

package info (click to toggle)
python-openstackclient 2.3.0-2~bpo8%2B1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-backports
  • size: 3,376 kB
  • sloc: python: 39,869; makefile: 158; sh: 40
file content (221 lines) | stat: -rw-r--r-- 3,786 bytes parent folder | download | duplicates (2)
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
=======
project
=======

Identity v2, v3

project create
--------------

Create new project

.. program:: project create
.. code:: bash

    os project create
        [--domain <domain>]
        [--parent <project>]
        [--description <description>]
        [--enable | --disable]
        [--property <key=value>]
        [--or-show]
        <name>

.. option:: --domain <domain>

    Domain owning the project (name or ID)

    .. versionadded:: 3

.. option:: --parent <project>

    Parent of the project (name or ID)

    .. versionadded:: 3

.. option:: --description <description>

    Project description

.. option:: --enable

    Enable project (default)

.. option:: --disable

    Disable project

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

    Add a property to :ref:`\<name\> <project_create-name>`
    (repeat option to set multiple properties)

.. option:: --or-show

    Return existing project

    If the project already exists return the existing project data and do not fail.

.. _project_create-name:
.. describe:: <name>

    New project name

project delete
--------------

Delete project(s)

.. program:: project delete
.. code:: bash

    os project delete
        [--domain <domain>]
        <project> [<project> ...]

.. option:: --domain <domain>

    Domain owning :ref:`\<project\> <project_delete-project>` (name or ID)

    .. versionadded:: 3

.. _project_delete-project:
.. describe:: <project>

    Project to delete (name or ID)

project list
------------

List projects

.. program:: project list
.. code:: bash

    os project list
        [--domain <domain>]
        [--user <user>]
        [--long]

.. option:: --domain <domain>

    Filter projects by :option:`\<domain\> <--domain>` (name or ID)

    .. versionadded:: 3

.. option:: --user <user>

    Filter projects by :option:`\<user\> <--user>` (name or ID)

    .. versionadded:: 3

.. option:: --long

    List additional fields in output

project set
-----------

Set project properties

.. program:: project set
.. code:: bash

    os project set
        [--name <name>]
        [--domain <domain>]
        [--description <description>]
        [--enable | --disable]
        [--property <key=value>]
        <project>

.. option:: --name <name>

    Set project name

.. option:: --domain <domain>

    Domain owning :ref:`\<project\> <project_set-project>` (name or ID)

    .. versionadded:: 3

.. option:: --description <description>

    Set project description

.. option:: --enable

    Enable project (default)

.. option:: --disable

    Disable project

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

    Set a property on :ref:`\<project\> <project_set-project>`
    (repeat option to set multiple properties)

    *Identity version 2 only*

.. _project_set-project:
.. describe:: <project>

    Project to modify (name or ID)

project show
------------

Display project details

.. program:: project show
.. code:: bash

    os project show
        [--domain <domain>]
        <project>

.. option:: --domain <domain>

    Domain owning :ref:`\<project\> <project_show-project>` (name or ID)

    .. versionadded:: 3

.. option:: --parents

    Show the project\'s parents as a list

    .. versionadded:: 3

.. option:: --children

    Show project\'s subtree (children) as a list

    .. versionadded:: 3

.. _project_show-project:
.. describe:: <project>

    Project to display (name or ID)

project unset
-------------

Unset project properties

*Identity version 2 only*

.. program:: project unset
.. code:: bash

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

.. option:: --property <key>

    Property key to remove from project (repeat option to remove multiple properties)

.. describe:: <project>

    Project to modify (name or ID)