diff --git a/doc/common/cli-manage-volumes.rst b/doc/common/cli-manage-volumes.rst index e49cda449b..14793d82ed 100644 --- a/doc/common/cli-manage-volumes.rst +++ b/doc/common/cli-manage-volumes.rst @@ -24,20 +24,20 @@ Possible use cases for data migration include: * Free up space in a thinly-provisioned back end. -Migrate a volume with the :command:`cinder migrate` command, as shown in the -following example: +Migrate a volume with the :command:`openstack volume migrate` command, as shown +in the following example: .. code-block:: console - $ cinder migrate --force-host-copy - --lock-volume - + $ openstack volume migrate [-h] --host [--force-host-copy] + [--lock-volume | --unlock-volume] + -In this example, ``--force-host-copy True`` forces the generic +In this example, ``--force-host-copy`` forces the generic host-based migration mechanism and bypasses any driver optimizations. -``--lock-volume `` applies to the available volume. +``--lock-volume | --unlock-volume`` applies to the available volume. To determine whether the termination of volume migration caused by other -commands. ``True`` locks the volume state and does not allow the +commands. ``--lock-volume`` locks the volume state and does not allow the migration to be aborted. .. note:: @@ -608,16 +608,17 @@ you can manage and unmanage snapshots. Manage a snapshot ----------------- -Manage a snapshot with the :command:`openstack snapshot set` command: +Manage a snapshot with the :command:`openstack volume snapshot set` command: .. code-block:: console - $ openstack snapshot set \ - [--name ] \ - [--description ] \ - [--property [...] ] \ - [--state ] \ - + $ openstack volume snapshot set [-h] + [--name ] + [--description ] + [--no-property] + [--property ] + [--state ] + The arguments to be passed are: @@ -627,6 +628,11 @@ The arguments to be passed are: ``--description `` New snapshot description +``--no-property`` + Remove all properties from (specify both + --no-property and --property to remove the current + properties before setting new properties.) + ``--property `` Property to add or modify for this snapshot (repeat option to set multiple properties) @@ -642,24 +648,30 @@ The arguments to be passed are: .. code-block:: console - $ openstack snapshot set my-snapshot-id + $ openstack volume snapshot set my-snapshot-id Unmanage a snapshot ------------------- -Unmanage a snapshot with the :command:`cinder snapshot-unmanage` command: +Unmanage a snapshot with the :command:`openstack volume snapshot unset` +command: .. code-block:: console - $ cinder snapshot-unmanage SNAPSHOT + $ openstack volume snapshot unset [-h] + [--property ] + The arguments to be passed are: -SNAPSHOT - Name or ID of the snapshot to unmanage. +``--property `` + Property to remove from snapshot (repeat option to remove multiple properties) + +```` + Snapshot to modify (name or ID). The following example unmanages the ``my-snapshot-id`` image: .. code-block:: console - $ cinder snapshot-unmanage my-snapshot-id + $ openstack volume snapshot unset my-snapshot-id