openstack/python-freezerclient
Code Issues Proposed changes

Update cli reference

Browse Source 
Change-Id: I7c98cb3a8efe0543858ccfe874a342c213c54444
This commit is contained in:
Saad Zaher 2017-09-24 02:14:26 +01:00
parent a9e69139db
commit 4ec9036ec3
1 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/source/cli/index.rst
View File

@ -20,11 +20,11 @@
Backup, Restore, and Disaster Recovery service (freezer) command-line client Backup, Restore, and Disaster Recovery service (freezer) command-line client
============================================================================ ============================================================================
The freezer client is the command-line interface (CLI) for The freezer client is the command-line interface (CLI) for the
the Backup, Restore, and Disaster Recovery service (freezer) API Backup, Restore, and Disaster Recovery service (freezer) API
and its extensions. and its extensions.
This chapter documents :command:`freezer` version ``1.4.1``. This chapter documents :command:`freezer` version ``1.5.0``.
For help on a specific :command:`freezer` command, enter: For help on a specific :command:`freezer` command, enter:
@ -49,6 +49,7 @@ freezer usage
[--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-name OS_PROJECT_NAME] [--os-project-name OS_PROJECT_NAME]
[--os-region-name OS_REGION_NAME] [--os-tenant-id OS_TENANT_ID] [--os-region-name OS_REGION_NAME] [--os-tenant-id OS_TENANT_ID]
[--os-project-id OS_PROJECT_ID]
[--os-tenant-name OS_TENANT_NAME] [--os-tenant-name OS_TENANT_NAME]
[--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-user-domain-id OS_USER_DOMAIN_ID] [-k] [--os-user-domain-id OS_USER_DOMAIN_ID] [-k]
@ -119,6 +120,9 @@ freezer optional arguments
``--os-tenant-id OS_TENANT_ID`` ``--os-tenant-id OS_TENANT_ID``
Tenant to request authorization on Tenant to request authorization on
``--os-project-id OS_PROJECT_ID``
Project to request authorization on
``--os-tenant-name OS_TENANT_NAME`` ``--os-tenant-name OS_TENANT_NAME``
Tenant to request authorization on Tenant to request authorization on
@ -189,8 +193,8 @@ freezer action-list
.. code-block:: console .. code-block:: console
usage: freezer action-list [-h] [-f {csv,html,json,table,value,yaml}] usage: freezer action-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
@ -217,8 +221,8 @@ freezer action-show
.. code-block:: console .. code-block:: console
usage: freezer action-show [-h] [-f {html,json,shell,table,value,yaml}] usage: freezer action-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
action_id action_id
Show a single action Show a single action
@ -286,8 +290,8 @@ freezer backup-list
.. code-block:: console .. code-block:: console
usage: freezer backup-list [-h] [-f {csv,html,json,table,value,yaml}] usage: freezer backup-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
@ -314,8 +318,8 @@ freezer backup-show
.. code-block:: console .. code-block:: console
usage: freezer backup-show [-h] [-f {html,json,shell,table,value,yaml}] usage: freezer backup-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
backup_uuid backup_uuid
Show the metadata of a single backup Show the metadata of a single backup
@ -359,8 +363,8 @@ freezer client-list
.. code-block:: console .. code-block:: console
usage: freezer client-list [-h] [-f {csv,html,json,table,value,yaml}] usage: freezer client-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
@ -406,8 +410,8 @@ freezer client-show
.. code-block:: console .. code-block:: console
usage: freezer client-show [-h] [-f {html,json,shell,table,value,yaml}] usage: freezer client-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
client_id client_id
Show a single client Show a single client
@ -519,8 +523,8 @@ freezer job-list
.. code-block:: console .. code-block:: console
usage: freezer job-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] usage: freezer job-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--print-empty] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty]
[--quote {all,minimal,none,nonnumeric}] [--noindent] [--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
[--client CLIENT_ID] [--client CLIENT_ID]
@ -551,8 +555,8 @@ freezer job-show
.. code-block:: console .. code-block:: console
usage: freezer job-show [-h] [-f {html,json,shell,table,value,yaml}] usage: freezer job-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
job_id job_id
Show a single job Show a single job
@ -703,7 +707,7 @@ freezer session-list
.. code-block:: console .. code-block:: console
usage: freezer session-list [-h] [-f {csv,html,json,table,value,yaml}] usage: freezer session-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--limit LIMIT] [--offset OFFSET]
@ -754,7 +758,7 @@ freezer session-show
.. code-block:: console .. code-block:: console
usage: freezer session-show [-h] [-f {html,json,shell,table,value,yaml}] usage: freezer session-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
session_id session_id