diff options
| author | Jenkins <jenkins@review.openstack.org> | 2015-01-08 23:04:59 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2015-01-08 23:04:59 +0000 |
| commit | c1f28bf7ca6d628029dfb53cd2d545fa26d18cf1 (patch) | |
| tree | 22855176f7a2d978c8282fc39b81f22f8d3a22d2 /doc | |
| parent | e252bae4c7fe7c01bef0f4c1140369fbce73a44c (diff) | |
| parent | 79d0e21a4519de57a25ccd4a06a26795dba5636d (diff) | |
| download | python-openstackclient-c1f28bf7ca6d628029dfb53cd2d545fa26d18cf1.tar.gz | |
Merge "Command doc: backup"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/command-objects/backup.rst | 104 | ||||
| -rw-r--r-- | doc/source/commands.rst | 2 |
2 files changed, 105 insertions, 1 deletions
diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst new file mode 100644 index 00000000..ec201aa3 --- /dev/null +++ b/doc/source/command-objects/backup.rst @@ -0,0 +1,104 @@ +====== +backup +====== + +Volume v1 + +backup create +------------- + +Create new backup + +.. program:: backup create +.. code:: bash + + os backup create + [--container <container>] + [--name <name>] + [--description <description>] + <volume> + +.. option:: --container <container> + + Optional backup container name + +.. option:: --name <name> + + Name of the backup + +.. option:: --description <description> + + Description of the backup + +.. _backup_create-backup: +.. describe:: <volume> + + Volume to backup (name or ID) + +backup delete +------------- + +Delete backup(s) + +.. program:: backup delete +.. code:: bash + + os backup delete + <backup> [<backup> ...] + +.. _backup_delete-backup: +.. describe:: <backup> + + Backup(s) to delete (ID only) + +backup list +----------- + +List backups + +.. program:: backup list +.. code:: bash + + os backup list + +.. _backup_list-backup: +.. option:: --long + + List additional fields in output + +backup restore +-------------- + +Restore backup + +.. program:: backup restore +.. code:: bash + + os backup restore + <backup> + <volume> + +.. _backup_restore-backup: +.. describe:: <backup> + + Backup to restore (ID only) + +.. describe:: <volume> + + Volume to restore to (name or ID) + +backup show +----------- + +Display backup details + +.. program:: backup show +.. code:: bash + + os backup show + <backup> + +.. _backup_show-backup: +.. describe:: <backup> + + Backup to display (ID only) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 2c159725..5c5df7f9 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -72,7 +72,7 @@ referring to both Compute and Volume quotas. * ``access token``: Identity - long-lived OAuth-based token * ``availability zone``: (**Compute**) a logical partition of hosts or volume services * ``aggregate``: (**Compute**) a grouping of servers -* ``backup``: Volume - a volume copy +* ``backup``: (**Volume**) a volume copy * ``catalog``: (**Identity**) service catalog * ``console log``: (**Compute**) server console text dump * ``console url``: (**Compute**) server remote console URL |
