From 04d30c1855f1229d986c7ad3bdae43a2b2d38990 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Tue, 18 Nov 2014 15:11:32 -0600 Subject: Command object docs: project, role, user project role user user role Change-Id: I445e09a3ffb69114912ae562a9285963a636bfd1 --- doc/source/command-objects/project.rst | 155 +++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 doc/source/command-objects/project.rst (limited to 'doc/source/command-objects/project.rst') diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst new file mode 100644 index 00000000..ba741d1d --- /dev/null +++ b/doc/source/command-objects/project.rst @@ -0,0 +1,155 @@ +======= +project +======= + +Identity v2, v3 + +project create +-------------- + +Create new project + +.. program:: project create +.. code:: bash + + os project create + [--domain ] + [--description ] + [--enable | --disable] + [--property ] + + +.. option:: --domain + + Domain owning 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) + +.. _project_create-name: +.. describe:: + + New project name + +project delete +-------------- + +Delete an existing project + +.. program:: project delete +.. code:: bash + + os project delete + + +.. _project_delete-project: +.. describe:: + + Project to delete (name or ID) + +project list +------------ + +List projects + +.. program:: project list +.. code:: bash + + os project list + [--domain ] + [--long] + +.. option:: --domain + + Filter projects by :option:`\ <--domain>` (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 ] + [--domain ] + [--description ] + [--enable | --disable] + [--property ] + + +.. option:: --name + + Set project name + +.. option:: --domain + + Set 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) + +.. _project_set-project: +.. describe:: + + Project to modify (name or ID) + +project show +------------ + +.. program:: project show +.. code:: bash + + os project show + [--domain ] + + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. _project_show-project: +.. describe:: + + Project to show (name or ID) -- cgit v1.2.1