diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2016-09-08 15:13:38 -0700 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-06-13 10:26:35 -0400 |
| commit | 227d4c64ef4ac04b5fed6cdff035821bf0e6ae7e (patch) | |
| tree | 4cd0ee7edc8ec3b1aa1612b29d09f08902e742a8 /doc/source | |
| parent | eb793dc8c6a8bd30e612f19f30808528b10eb344 (diff) | |
| download | python-openstackclient-227d4c64ef4ac04b5fed6cdff035821bf0e6ae7e.tar.gz | |
Add project purge command to osc
See the initial implementation:
https://github.com/openstack/ospurge/blob/master/ospurge/client.py
Partial-Bug: 1584596
Change-Id: I3aa86af7c85e7ca3b7f04b43e8e07125f7d956d1
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/command-objects/project-purge.rst | 42 | ||||
| -rw-r--r-- | doc/source/commands.rst | 1 |
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 4e0a9258..ba3e335c 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -251,6 +251,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 |