From 79d0e21a4519de57a25ccd4a06a26795dba5636d Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Mon, 5 Jan 2015 20:26:35 -0500 Subject: Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3 --- doc/source/command-objects/backup.rst | 104 ++++++++++++++++++++++++++++++++++ doc/source/commands.rst | 2 +- 2 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 doc/source/command-objects/backup.rst (limited to 'doc/source') 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 ] + [--name ] + [--description ] + + +.. option:: --container + + Optional backup container name + +.. option:: --name + + Name of the backup + +.. option:: --description + + Description of the backup + +.. _backup_create-backup: +.. describe:: + + Volume to backup (name or ID) + +backup delete +------------- + +Delete backup(s) + +.. program:: backup delete +.. code:: bash + + os backup delete + [ ...] + +.. _backup_delete-backup: +.. describe:: + + 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_restore-backup: +.. describe:: + + Backup to restore (ID only) + +.. describe:: + + Volume to restore to (name or ID) + +backup show +----------- + +Display backup details + +.. program:: backup show +.. code:: bash + + os backup show + + +.. _backup_show-backup: +.. describe:: + + Backup to display (ID only) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 4b2e6355..4649b012 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 -- cgit v1.2.1