summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/project-purge.rst42
1 files changed, 42 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.