Files
doc
source
_extra
cli
command-objects
access-token.rst
address-scope.rst
aggregate.rst
application-credentials.rst
availability-zone.rst
backup.rst
catalog.rst
command.rst
complete.rst
compute-agent.rst
compute-service.rst
configuration.rst
consistency-group-snapshot.rst
consistency-group.rst
console-log.rst
console-url.rst
consumer.rst
container.rst
credential.rst
domain.rst
ec2-credentials.rst
endpoint.rst
endpoint_group.rst
extension.rst
federation-protocol.rst
flavor.rst
floating-ip-pool.rst
floating-ip.rst
group.rst
host.rst
hypervisor-stats.rst
hypervisor.rst
identity-provider.rst
image.rst
implied_role.rst
ip-availability.rst
ip-fixed.rst
keypair.rst
limit.rst
limits.rst
mapping.rst
module.rst
network-agent.rst
network-auto-allocated-topology.rst
network-flavor-profile.rst
network-flavor.rst
network-meter-rule.rst
network-meter.rst
network-qos-policy.rst
network-qos-rule-type.rst
network-qos-rule.rst
network-rbac.rst
network-segment.rst
network-service-provider.rst
network.rst
object-store-account.rst
object.rst
policy.rst
port.rst
project-purge.rst
project.rst
quota.rst
region.rst
registered-limit.rst
request-token.rst
role-assignment.rst
role.rst
router.rst
security-group-rule.rst
security-group.rst
server-backup.rst
server-event.rst
server-group.rst
server-image.rst
server.rst
service-provider.rst
service.rst
snapshot.rst
subnet-pool.rst
subnet.rst
token.rst
trust.rst
usage.rst
user-role.rst
user.rst
versions.rst
volume-backend.rst
volume-backup.rst
volume-host.rst
volume-qos.rst
volume-service.rst
volume-snapshot.rst
volume-transfer-request.rst
volume-type.rst
volume.rst
data
man
authentication.rst
backwards-incompatible.rst
command-list.rst
commands.rst
decoder.rst
index.rst
interactive.rst
plugin-commands.rst
configuration
contributor
conf.py
index.rst
Makefile
requirements.txt
examples
openstackclient
playbooks
releasenotes
tools
.coveragerc
.gitignore
.gitreview
.mailmap
.stestr.conf
.testr.conf
.zuul.yaml
CONTRIBUTING.rst
HACKING.rst
LICENSE
README.rst
babel.cfg
lower-constraints.txt
requirements.txt
setup.cfg
setup.py
test-requirements.txt
tox.ini
python-openstackclient/doc/source/cli/command-objects/volume-backup.rst
Doug Hellmann 9599ffe65d reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00

3.6 KiB

volume backup

Block Storage v1, v2

volume backup create

Create new volume backup

volume backup create

openstack volume backup create
    [--container <container>]
    [--name <name>]
    [--description <description>]
    [--snapshot <snapshot>]
    [--force]
    [--incremental]
    <volume>

--container <container>

Optional backup container name

--name <name>

Name of the backup

--description <description>

Description of the backup

--snapshot <snapshot>

Snapshot to backup (name or ID)

Volume version 2 only

--force

Allow to back up an in-use volume

Volume version 2 only

--incremental

Perform an incremental backup

Volume version 2 only

Volume to backup (name or ID)

volume backup delete

Delete volume backup(s)

volume backup delete

openstack volume backup delete
    [--force]
    <backup> [<backup> ...]

--force

Allow delete in state other than error or available

Volume version 2 only

Backup(s) to delete (name or ID)

volume backup list

List volume backups

volume backup list

openstack volume backup list
    [--long]
    [--name <name>]
    [--status <status>]
    [--volume <volume>]
    [--marker <volume-backup>]
    [--limit <num-backups>]
    [--all-projects]




List additional fields in output

--name <name>

Filters results by the backup name

--status <status>

Filters results by the backup status ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring')

--volume <volume>

Filters results by the volume which they backup (name or ID)"

--marker <volume-backup>

The last backup of the previous page (name or ID)

Volume version 2 only

--limit <num-backups>

Maximum number of backups to display

Volume version 2 only

--all-projects

Include all projects (admin only)

volume backup restore

Restore volume backup

volume backup restore

openstack volume backup restore
    <backup>
    <volume>




Backup to restore (name or ID)

<volume>

Volume to restore to (name or ID)

volume backup set

Set volume backup properties

volume backup set

openstack volume backup set
    [--name <name>]
    [--description <description>]
    [--state <state>]
    <backup>

--name <name>

New backup name

--description <description>

New backup description

--state <state>

New backup state ("available" or "error") (admin only) (This option simply changes the state of the backup in the database with no regard to actual status, exercise caution when using)

Backup to modify (name or ID)

volume backup show

Display volume backup details

volume backup show

openstack volume backup show
    <backup>




Backup to display (name or ID)