diff options
Diffstat (limited to 'doc/source/cli/command-objects/project.rst')
| -rw-r--r-- | doc/source/cli/command-objects/project.rst | 297 |
1 files changed, 0 insertions, 297 deletions
diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst deleted file mode 100644 index afa785cb..00000000 --- a/doc/source/cli/command-objects/project.rst +++ /dev/null @@ -1,297 +0,0 @@ -======= -project -======= - -Identity v2, v3 - -project create --------------- - -Create new project - -.. program:: project create -.. code:: bash - - openstack project create - [--domain <domain>] - [--parent <project>] - [--description <description>] - [--immutable | --no-immutable] - [--enable | --disable] - [--property <key=value>] - [--or-show] - [--tag <tag>] - <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:: --immutable - - Make project immutable. An immutable project may not be deleted or - modified except to remove the immutable flag - -.. option:: --no-immutable - - Make project mutable (default) - -.. 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. - -.. option:: --tag - - Add a tag to the project - (repeat option to set multiple tags) - - .. versionadded:: 3 - -.. _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>] - [--parent <parent>] - [--user <user>] - [--my-projects] - [--long] - [--sort <key>[:<direction>,<key>:<direction>,..]] - [--tags <tag>[,<tag>,...]] [--tags-any <tag>[,<tag>,...]] - [--not-tags <tag>[,<tag>,...]] [--not-tags-any <tag>[,<tag>,...]] - -.. option:: --domain <domain> - - Filter projects by :option:`\<domain\> <--domain>` (name or ID) - - .. versionadded:: 3 - -.. option:: --parent <parent> - - Filter projects whose parent is :option:`\<parent\> <--parent>` (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>,..] - -.. option:: --tags <tag>[,<tag>,...] - - List projects which have all given tag(s) - - .. versionadded:: 3 - -.. option:: --tags-any <tag>[,<tag>,...] - - List projects which have any given tag(s) - - .. versionadded:: 3 - -.. option:: --not-tags <tag>[,<tag>,...] - - Exclude projects which have all given tag(s) - - .. versionadded:: 3 - -.. option:: --not-tags-any <tag>[,<tag>,...] - - Exclude projects which have any given tag(s) - - .. versionadded:: 3 - -project set ------------ - -Set project properties - -.. program:: project set -.. code:: bash - - openstack project set - [--name <name>] - [--domain <domain>] - [--description <description>] - [--immutable | --no-immutable] - [--enable | --disable] - [--property <key=value>] - [--tag <tag> | --clear-tags | --remove-tags <tag>] - <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:: --immutable - - Make project immutable. An immutable project may not be deleted or - modified except to remove the immutable flag - -.. option:: --no-immutable - - Make project mutable (default) - -.. 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) |