openstack/python-openstackclient
Code Issues Proposed changes
0fb1378c6c
python-openstackclient/doc/source/command-objects/backup.rst

138 lines
2.2 KiB
ReStructuredText
Raw Normal View History

Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
======
backup
======
Add '--force' option to 'backup delete' command in volumev2 Add '--force' option to 'backup delete' command in volumev2 (v2 only) to allow delete in state other than error or available. Change-Id: I661ea0d465db227e374cbacdde0206fa1a6dd3d5 Closes-Bug: #1597188
2016-07-06 11:11:56 +08:00
Block Storage v1, v2
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
backup create
-------------
Create new backup
Rename backup commands in volume v1 and v2 Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-08-09 10:12:04 +08:00
(Deprecated, please use ``volume backup create`` instead)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. program:: backup create
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack backup create
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
[--container <container>]
[--name <name>]
[--description <description>]
Add missing "Volume version 2 only" message in backup.rst Former patchs add some volume v2 only options for backup but miss "Volume version 2 only" message. This patch adds them. Change-Id: Id50db25617776b6ee0d0ad6b4b82bd443b940343
2016-07-11 09:56:55 +08:00
[--snapshot <snapshot>]
Add "--force" option to "backup create" command in volumev2 Cinder V2 API supports creating volume backup with "--force" option. However, OSC doesn't support this argument. So this patch add the "--force" option to allow users to back up a in-use volume. Change-Id: I326f8d6172b2830da4cf1317348af50142cc5490 Closes-Bug: #1596443
2016-06-27 16:59:51 +08:00
[--force]
Add "--incremental" option to "backup create" command in volume v2 Cinder V2 API supports creating volume backup with "--incremental" option. However, OSC doesn't support this argument. So this patch adds the "--incremental" option to allow users to create incremental style backups. Change-Id: Iefac5f1a6c9ef006ad9c22d4250ae6df50504781 Closes-Bug: 1600196
2016-07-08 11:25:25 +00:00
[--incremental]
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
<volume>
.. option:: --container <container>
Optional backup container name
.. option:: --name <name>
Name of the backup
.. option:: --description <description>
Description of the backup
Add "--snapshot" option to "backup create" command in volumev2 Add "--snapshot" option to "backup create" command to support backing up a snapshot. Change-Id: Ibecbf1902599875f422d372d529835f73211d3ec Closes-Bug: #1597184
2016-06-30 15:06:58 +08:00
.. option:: --snapshot <snapshot>
Snapshot to backup (name or ID)
Add missing "Volume version 2 only" message in backup.rst Former patchs add some volume v2 only options for backup but miss "Volume version 2 only" message. This patch adds them. Change-Id: Id50db25617776b6ee0d0ad6b4b82bd443b940343
2016-07-11 09:56:55 +08:00
*Volume version 2 only*
Add "--force" option to "backup create" command in volumev2 Cinder V2 API supports creating volume backup with "--force" option. However, OSC doesn't support this argument. So this patch add the "--force" option to allow users to back up a in-use volume. Change-Id: I326f8d6172b2830da4cf1317348af50142cc5490 Closes-Bug: #1596443
2016-06-27 16:59:51 +08:00
.. option:: --force
Allow to back up an in-use volume
Add missing "Volume version 2 only" message in backup.rst Former patchs add some volume v2 only options for backup but miss "Volume version 2 only" message. This patch adds them. Change-Id: Id50db25617776b6ee0d0ad6b4b82bd443b940343
2016-07-11 09:56:55 +08:00
*Volume version 2 only*
Add "--incremental" option to "backup create" command in volume v2 Cinder V2 API supports creating volume backup with "--incremental" option. However, OSC doesn't support this argument. So this patch adds the "--incremental" option to allow users to create incremental style backups. Change-Id: Iefac5f1a6c9ef006ad9c22d4250ae6df50504781 Closes-Bug: 1600196
2016-07-08 11:25:25 +00:00
.. option:: --incremental
Perform an incremental backup
*Volume version 2 only*
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. _backup_create-backup:
.. describe:: <volume>
Volume to backup (name or ID)
backup delete
-------------
Delete backup(s)
Rename backup commands in volume v1 and v2 Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-08-09 10:12:04 +08:00
(Deprecated, please use ``volume backup delete`` instead)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. program:: backup delete
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack backup delete
Add '--force' option to 'backup delete' command in volumev2 Add '--force' option to 'backup delete' command in volumev2 (v2 only) to allow delete in state other than error or available. Change-Id: I661ea0d465db227e374cbacdde0206fa1a6dd3d5 Closes-Bug: #1597188
2016-07-06 11:11:56 +08:00
[--force]
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
<backup> [<backup> ...]
Add '--force' option to 'backup delete' command in volumev2 Add '--force' option to 'backup delete' command in volumev2 (v2 only) to allow delete in state other than error or available. Change-Id: I661ea0d465db227e374cbacdde0206fa1a6dd3d5 Closes-Bug: #1597188
2016-07-06 11:11:56 +08:00
.. option:: --force
Allow delete in state other than error or available
*Volume version 2 only*
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. _backup_delete-backup:
.. describe:: <backup>
Change "ID only" to "name or ID" for backup commands Tested "find_resulce()" can find a backup by name or ID. But some help messages and doc were "ID only", this patch modify them. Change-Id: I22dcc3a0b40f2bafabb6d26498158e2468037312
2016-06-27 19:53:52 +08:00
Backup(s) to delete (name or ID)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
backup list
-----------
List backups
Rename backup commands in volume v1 and v2 Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-08-09 10:12:04 +08:00
(Deprecated, please use ``volume backup list`` instead)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. program:: backup list
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack backup list
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. _backup_list-backup:
.. option:: --long
List additional fields in output
backup restore
--------------
Restore backup
Rename backup commands in volume v1 and v2 Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-08-09 10:12:04 +08:00
(Deprecated, please use ``volume backup restore`` instead)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. program:: backup restore
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack backup restore
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
<backup>
<volume>
.. _backup_restore-backup:
.. describe:: <backup>
Change "ID only" to "name or ID" for backup commands Tested "find_resulce()" can find a backup by name or ID. But some help messages and doc were "ID only", this patch modify them. Change-Id: I22dcc3a0b40f2bafabb6d26498158e2468037312
2016-06-27 19:53:52 +08:00
Backup to restore (name or ID)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. describe:: <volume>
Volume to restore to (name or ID)
backup show
-----------
Display backup details
Rename backup commands in volume v1 and v2 Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-08-09 10:12:04 +08:00
(Deprecated, please use ``volume backup show`` instead)
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
.. program:: backup show
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack backup show
Command doc: backup Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3
2015-01-05 20:26:35 -05:00
<backup>
.. _backup_show-backup:
.. describe:: <backup>
Change "ID only" to "name or ID" for backup commands Tested "find_resulce()" can find a backup by name or ID. But some help messages and doc were "ID only", this patch modify them. Change-Id: I22dcc3a0b40f2bafabb6d26498158e2468037312
2016-06-27 19:53:52 +08:00
Backup to display (name or ID)
Copy Permalink