From 23ee2fd8f060ed312a84eb03c99494e8af2ffb6f Mon Sep 17 00:00:00 2001 From: Huanxuan Ao Date: Wed, 14 Sep 2016 14:54:29 +0800 Subject: Refactor "snapshot" commands 1.change the command name ``snapshot create/delete/list/ show/set/unset`` to ``volume snapshot create/delete/list/ show/set/unset``. 2.change the optional parameter "--name " to a positional parameter ""; Change the positional parameter "" to a optional parameter "--volume " Change-Id: If03276ecdf6f0d96893d5ecf91c2aaa64929cff3 Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana --- doc/source/command-objects/snapshot.rst | 6 + doc/source/command-objects/volume-snapshot.rst | 171 +++++++++++++++++++++++++ doc/source/commands.rst | 3 +- 3 files changed, 178 insertions(+), 2 deletions(-) create mode 100644 doc/source/command-objects/volume-snapshot.rst (limited to 'doc/source') diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index a2709adb..e75693ca 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -8,6 +8,7 @@ snapshot create --------------- Create new snapshot +(Deprecated, please use ``volume snapshot create`` instead) .. program:: snapshot create .. code:: bash @@ -46,6 +47,7 @@ snapshot delete --------------- Delete snapshot(s) +(Deprecated, please use ``volume snapshot delete`` instead) .. program:: snapshot delete .. code:: bash @@ -62,6 +64,7 @@ snapshot list ------------- List snapshots +(Deprecated, please use ``volume snapshot list`` instead) .. program:: snapshot list .. code:: bash @@ -96,6 +99,7 @@ snapshot set ------------ Set snapshot properties +(Deprecated, please use ``volume snapshot set`` instead) .. program:: snapshot set .. code:: bash @@ -137,6 +141,7 @@ snapshot show ------------- Display snapshot details +(Deprecated, please use ``volume snapshot show`` instead) .. program:: snapshot show .. code:: bash @@ -153,6 +158,7 @@ snapshot unset -------------- Unset snapshot properties +(Deprecated, please use ``volume snapshot unset`` instead) .. program:: snapshot unset .. code:: bash diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst new file mode 100644 index 00000000..b84601f4 --- /dev/null +++ b/doc/source/command-objects/volume-snapshot.rst @@ -0,0 +1,171 @@ +=============== +volume snapshot +=============== + +Block Storage v1, v2 + +volume snapshot create +---------------------- + +Create new volume snapshot + +.. program:: volume snapshot create +.. code:: bash + + os volume snapshot create + [--volume ] + [--description ] + [--force] + [--property [...] ] + + +.. option:: --volume + + Volume to snapshot (name or ID) (default is ) + +.. option:: --description + + Description of the snapshot + +.. option:: --force + + Create a snapshot attached to an instance. Default is False + +.. option:: --property + + Set a property to this snapshot (repeat option to set multiple properties) + + *Volume version 2 only* + +.. _volume_snapshot_create-snapshot-name: +.. describe:: + + Name of the new snapshot (default to None) + +volume snapshot delete +---------------------- + +Delete volume snapshot(s) + +.. program:: volume snapshot delete +.. code:: bash + + os volume snapshot delete + [ ...] + +.. _volume_snapshot_delete-snapshot: +.. describe:: + + Snapshot(s) to delete (name or ID) + +volume snapshot list +-------------------- + +List volume snapshots + +.. program:: volume snapshot list +.. code:: bash + + os volume snapshot list + [--all-projects] + [--long] + [--limit ] + [--marker ] + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --long + + List additional fields in output + +.. option:: --limit + + Maximum number of snapshots to display + + *Volume version 2 only* + +.. option:: --marker + + The last snapshot ID of the previous page + + *Volume version 2 only* + +volume snapshot set +------------------- + +Set volume snapshot properties + +.. program:: volume snapshot set +.. code:: bash + + os volume snapshot set + [--name ] + [--description ] + [--property [...] ] + [--state ] + + +.. option:: --name + + New snapshot name + +.. option:: --description + + New snapshot description + +.. option:: --property + + Property to add or modify for this snapshot (repeat option to set multiple properties) + +.. option:: --state + + New snapshot state. + ("available", "error", "creating", "deleting", or "error_deleting") (admin only) + (This option simply changes the state of the snapshot in the database with + no regard to actual status, exercise caution when using) + + *Volume version 2 only* + +.. _volume_snapshot_set-snapshot: +.. describe:: + + Snapshot to modify (name or ID) + +volume snapshot show +-------------------- + +Display volume snapshot details + +.. program:: volume snapshot show +.. code:: bash + + os volume snapshot show + + +.. _volume_snapshot_show-snapshot: +.. describe:: + + Snapshot to display (name or ID) + +volume snapshot unset +--------------------- + +Unset volume snapshot properties + +.. program:: volume snapshot unset +.. code:: bash + + os volume snapshot unset + [--property ] + + +.. option:: --property + + Property to remove from snapshot (repeat option to remove multiple properties) + +.. _volume_snapshot_unset-snapshot: +.. describe:: + + Snapshot to modify (name or ID) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 3e0f932e..36c48b0e 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -74,7 +74,6 @@ referring to both Compute and Volume quotas. * ``address scope``: (**Network**) a scope of IPv4 or IPv6 addresses * ``aggregate``: (**Compute**) a grouping of compute hosts * ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services -* ``backup``: (**Volume**) a volume copy * ``catalog``: (**Identity**) service catalog * ``command``: (**Internal**) installed commands in the OSC process * ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor @@ -134,7 +133,6 @@ referring to both Compute and Volume quotas. * ``server image``: (**Compute**) saved server disk image * ``service``: (**Identity**) a cloud service * ``service provider``: (**Identity**) a resource that consumes assertions from an ``identity provider`` -* ``snapshot``: (**Volume**) a point-in-time copy of a volume * ``subnet``: (**Network**) - a contiguous range of IP addresses assigned to a network * ``subnet pool``: (**Network**) - a pool of subnets * ``token``: (**Identity**) a bearer token managed by Identity service @@ -145,6 +143,7 @@ referring to both Compute and Volume quotas. * ``volume``: (**Volume**) block volumes * ``volume backup``: (**Volume**) backup for volumes * ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes +* ``volume snapshot``: (**Volume**) a point-in-time copy of a volume * ``volume type``: (**Volume**) deployment-specific types of volumes available * ``volume service``: (**Volume**) services to manage block storage operations * ``volume transfer request``: (**Volume**) volume owner transfer request -- cgit v1.2.1