openstack/python-openstackclient
Code Issues Proposed changes
61025bf102
python-openstackclient/doc/source/cli/command-objects/volume-backup.rst

202 lines
3.6 KiB
ReStructuredText
Raw Normal View History

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
=============
volume backup
=============
Block Storage v1, v2
volume backup create
--------------------
Create new volume backup
.. program:: volume backup create
.. code:: bash
Fix all missing "os to openstack" transformation Checked and fix all missing of the review: https://review.openstack.org/#/c/412669/ https://review.openstack.org/#/c/412673/ https://review.openstack.org/#/c/412678/ Change-Id: Ice85958874121eeb574d0b4cfa58e1590b014ed6
2016-12-21 10:29:38 +08:00
openstack volume backup create
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
[--container <container>]
[--name <name>]
[--description <description>]
[--snapshot <snapshot>]
[--force]
[--incremental]
<volume>
.. option:: --container <container>
Optional backup container name
.. option:: --name <name>
Name of the backup
.. option:: --description <description>
Description of the backup
.. option:: --snapshot <snapshot>
Snapshot to backup (name or ID)
*Volume version 2 only*
.. option:: --force
Allow to back up an in-use volume
*Volume version 2 only*
.. option:: --incremental
Perform an incremental backup
*Volume version 2 only*
.. _volume_backup_create-backup:
.. describe:: <volume>
Volume to backup (name or ID)
volume backup delete
--------------------
Delete volume backup(s)
.. program:: volume backup delete
.. code:: bash
change os in command example to openstack(3) 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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack volume backup delete
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
[--force]
<backup> [<backup> ...]
.. option:: --force
Allow delete in state other than error or available
*Volume version 2 only*
.. _volume_backup_delete-backup:
.. describe:: <backup>
Backup(s) to delete (name or ID)
volume backup list
------------------
List volume backups
.. program:: volume backup list
.. code:: bash
change os in command example to openstack(3) 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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack volume backup list
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
[--long]
[--name <name>]
[--status <status>]
[--volume <volume>]
Help/docs cleanups: marker, limit, ip-address metavars Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-03 16:15:14 -05:00
[--marker <volume-backup>]
[--limit <num-backups>]
Add 'all-projects' option to 'volume backup list' Similar to what 'volume list --all-projects' does, 'volume backup list --all-projects' list volume backups accross all projects. Change-Id: Id5dda9b5adc822c4ddfb2dda339946d3322858e2
2016-11-04 13:13:20 +01:00
[--all-projects]
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
.. _volume_backup_list-backup:
.. option:: --long
List additional fields in output
Fix sphinx errors It's :option: instead of :options:, fix typo. Change-Id: I273d592f38db07fef7633fe833b1c0ab9e52e6a8
2017-01-26 19:52:31 +01:00
.. option:: --name <name>
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
Filters results by the backup name
Fix sphinx errors It's :option: instead of :options:, fix typo. Change-Id: I273d592f38db07fef7633fe833b1c0ab9e52e6a8
2017-01-26 19:52:31 +01:00
.. option:: --status <status>
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
Filters results by the backup status
('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring')
Fix sphinx errors It's :option: instead of :options:, fix typo. Change-Id: I273d592f38db07fef7633fe833b1c0ab9e52e6a8
2017-01-26 19:52:31 +01:00
.. option:: --volume <volume>
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
Filters results by the volume which they backup (name or ID)"
Help/docs cleanups: marker, limit, ip-address metavars Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-03 16:15:14 -05:00
.. option:: --marker <volume-backup>
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
The last backup of the previous page (name or ID)
*Volume version 2 only*
Help/docs cleanups: marker, limit, ip-address metavars Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-03 16:15:14 -05:00
.. option:: --limit <num-backups>
Add options to "volume backup list" command Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
2016-11-07 17:19:24 +08:00
Maximum number of backups to display
*Volume version 2 only*
Add 'all-projects' option to 'volume backup list' Similar to what 'volume list --all-projects' does, 'volume backup list --all-projects' list volume backups accross all projects. Change-Id: Id5dda9b5adc822c4ddfb2dda339946d3322858e2
2016-11-04 13:13:20 +01:00
.. option:: --all-projects
Include all projects (admin only)
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
volume backup restore
---------------------
Restore volume backup
.. program:: volume backup restore
.. code:: bash
change os in command example to openstack(3) 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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack volume backup restore
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
<backup>
<volume>
.. _volume_backup_restore-backup:
.. describe:: <backup>
Backup to restore (name or ID)
.. describe:: <volume>
Volume to restore to (name or ID)
Add "volume backup set" command in volume v2 Add "volume backup set" command in volume v2 (v2 only) to set backup name, description and state Change-Id: If17e8457db9a4704fb5bb9c75921ed82fd0069cf Closes-Bug: #1613261
2016-08-16 10:52:26 +08:00
volume backup set
-----------------
Set volume backup properties
.. program:: volume backup set
.. code:: bash
change os in command example to openstack(3) 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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack volume backup set
Add "volume backup set" command in volume v2 Add "volume backup set" command in volume v2 (v2 only) to set backup name, description and state Change-Id: If17e8457db9a4704fb5bb9c75921ed82fd0069cf Closes-Bug: #1613261
2016-08-16 10:52:26 +08:00
[--name <name>]
[--description <description>]
[--state <state>]
<backup>
.. option:: --name <name>
New backup name
.. option:: --description <description>
New backup description
.. option:: --state <state>
New backup state ("available" or "error") (admin only)
Add warning message for --state option of set command in volume There are some set commands can set object state, it maybe a danger behavor for users, so add explanation and warning in the help message of the "--state" option to talk users be caution when using (cinderclient have done this too) Change-Id: I6a902887ea98879999c9972f36b1b7ef332173c3
2016-09-25 15:44:03 +08:00
(This option simply changes the state of the backup in the database with
no regard to actual status, exercise caution when using)
Add "volume backup set" command in volume v2 Add "volume backup set" command in volume v2 (v2 only) to set backup name, description and state Change-Id: If17e8457db9a4704fb5bb9c75921ed82fd0069cf Closes-Bug: #1613261
2016-08-16 10:52:26 +08:00
.. _backup_set-volume-backup:
.. describe:: <backup>
Backup to modify (name or ID)
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
volume backup show
------------------
Display volume backup details
.. program:: volume backup show
.. code:: bash
change os in command example to openstack(3) 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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack volume backup show
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
<backup>
.. _volume_backup_show-backup:
.. describe:: <backup>
Backup to display (name or ID)
Copy Permalink