summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-06-22 18:10:37 +0000
committerGerrit Code Review <review@openstack.org>2017-06-22 18:10:37 +0000
commitef25135e7aefa79904f9f895412e85ebad5a8507 (patch)
treecf96ad591ad8ea9e070129e32e9aa2cf4322f1cb /doc/source
parent244ac70ae9543bb11e95ae42712a9c0a5309e872 (diff)
parent227d4c64ef4ac04b5fed6cdff035821bf0e6ae7e (diff)
downloadpython-openstackclient-ef25135e7aefa79904f9f895412e85ebad5a8507.tar.gz
Merge "Add project purge command to osc"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/project-purge.rst42
-rw-r--r--doc/source/commands.rst1
2 files changed, 43 insertions, 0 deletions
diff --git a/doc/source/command-objects/project-purge.rst b/doc/source/command-objects/project-purge.rst
new file mode 100644
index 00000000..0ad0bbf9
--- /dev/null
+++ b/doc/source/command-objects/project-purge.rst
@@ -0,0 +1,42 @@
+=============
+project purge
+=============
+
+Clean resources associated with a specific project.
+
+Block Storage v1, v2; Compute v2; Image v1, v2
+
+project purge
+-------------
+
+Clean resources associated with a project
+
+.. program:: project purge
+.. code:: bash
+
+ openstack project purge
+ [--dry-run]
+ [--keep-project]
+ [--auth-project | --project <project>]
+ [--project-domain <project-domain>]
+
+.. option:: --dry-run
+
+ List a project's resources
+
+.. option:: --keep-project
+
+ Clean project resources, but don't delete the project.
+
+.. option:: --auth-project
+
+ Delete resources of the project used to authenticate
+
+.. option:: --project <project>
+
+ Project to clean (name or ID)
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID). This can be
+ used in case collisions between project names exist.
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index f4f046e3..cd71bdc8 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -252,6 +252,7 @@ Those actions with an opposite action are noted in parens if applicable.
live server migration if possible
* ``pause`` (``unpause``) - stop one or more servers and leave them in memory
* ``query`` - Query resources by Elasticsearch query string or json format DSL.
+* ``purge`` - clean resources associated with a specific project
* ``reboot`` - forcibly reboot a server
* ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create
* ``remove`` (``add``) - remove an object from a group of objects