From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/project.rst | 235 +++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 doc/source/cli/command-objects/project.rst (limited to 'doc/source/cli/command-objects/project.rst') 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 ] + [--parent ] + [--description ] + [--enable | --disable] + [--property ] + [--or-show] + + +.. option:: --domain + + Domain owning the project (name or ID) + + .. versionadded:: 3 + +.. option:: --parent + + Parent of the project (name or ID) + + .. versionadded:: 3 + +.. option:: --description + + Project description + +.. option:: --enable + + Enable project (default) + +.. option:: --disable + + Disable project + +.. option:: --property + + Add a property to :ref:`\ ` + (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:: + + New project name + +project delete +-------------- + +Delete project(s) + +.. program:: project delete +.. code:: bash + + openstack project delete + [--domain ] + [ ...] + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. _project_delete-project: +.. describe:: + + Project to delete (name or ID) + +project list +------------ + +List projects + +.. program:: project list +.. code:: bash + + openstack project list + [--domain ] + [--user ] + [--my-projects] + [--long] + [--sort [:,:,..]] + +.. option:: --domain + + Filter projects by :option:`\ <--domain>` (name or ID) + + .. versionadded:: 3 + +.. option:: --user + + Filter projects by :option:`\ <--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 [:,:,..] + + Sort output by selected keys and directions (asc or desc) (default: asc), + multiple keys and directions can be specified --sort + [:,:,..] + +project set +----------- + +Set project properties + +.. program:: project set +.. code:: bash + + openstack project set + [--name ] + [--domain ] + [--description ] + [--enable | --disable] + [--property ] + + +.. option:: --name + + Set project name + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. option:: --description + + Set project description + +.. option:: --enable + + Enable project (default) + +.. option:: --disable + + Disable project + +.. option:: --property + + Set a property on :ref:`\ ` + (repeat option to set multiple properties) + + *Identity version 2 only* + +.. _project_set-project: +.. describe:: + + Project to modify (name or ID) + +project show +------------ + +Display project details + +.. program:: project show +.. code:: bash + + openstack project show + [--domain ] + + +.. option:: --domain + + Domain owning :ref:`\ ` (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 to display (name or ID) + +project unset +------------- + +Unset project properties + +*Identity version 2 only* + +.. program:: project unset +.. code:: bash + + openstack project unset + --property [--property ...] + + +.. option:: --property + + Property key to remove from project (repeat option to remove multiple properties) + +.. describe:: + + Project to modify (name or ID) -- cgit v1.2.1