diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/project.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.
Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.
Add a few toctrees and index pages for the new directories.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/project.rst')
| -rw-r--r-- | doc/source/cli/command-objects/project.rst | 235 |
1 files changed, 235 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst new file mode 100644 index 00000000..cb0941ca --- /dev/null +++ b/doc/source/cli/command-objects/project.rst @@ -0,0 +1,235 @@ +======= +project +======= + +Identity v2, v3 + +project create +-------------- + +Create new project + +.. program:: project create +.. code:: bash + + openstack 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 + + openstack 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 + + openstack project list + [--domain <domain>] + [--user <user>] + [--my-projects] + [--long] + [--sort <key>[:<direction>,<key>:<direction>,..]] + +.. 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:: --my-projects + + List projects for the authenticated user. Supersedes other filters. + + .. versionadded:: 3 + +.. option:: --long + + List additional fields in output + +.. option:: --sort <key>[:<direction>,<key>:<direction>,..] + + Sort output by selected keys and directions (asc or desc) (default: asc), + multiple keys and directions can be specified --sort + <key>[:<direction>,<key>:<direction>,..] + +project set +----------- + +Set project properties + +.. program:: project set +.. code:: bash + + openstack 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 + + openstack 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 + + openstack 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) |
