From 06b6a91c0a8587e9436d77ba0631be3e9f668b16 Mon Sep 17 00:00:00 2001 From: caoyuan Date: Thu, 6 Oct 2016 15:04:18 +0000 Subject: [PATCH] Update the usage of "cinder snapshot-create" and the output of "cinder" Change-Id: I1c7a0bd8b51eb999079b3deafadcf131029783a8 --- .../source/ops-user-facing-operations.rst | 46 +++++++++++-------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/doc/ops-guide/source/ops-user-facing-operations.rst b/doc/ops-guide/source/ops-user-facing-operations.rst index 8a9973db30..b4136316e6 100644 --- a/doc/ops-guide/source/ops-user-facing-operations.rst +++ b/doc/ops-guide/source/ops-user-facing-operations.rst @@ -870,11 +870,11 @@ volumes and the instances they are connected to, if any: .. code-block:: console $ cinder list - +------------+---------+--------------------+------+-------------+-------------+ - | ID | Status | Display Name | Size | Volume Type | Attached to | - +------------+---------+--------------------+------+-------------+-------------+ - | 0821...19f | active | | 10 | None | | - +------------+---------+--------------------+------+-------------+-------------+ + +------------+-----------+-------------+------+-------------+----------+-------------+ + | ID | Status | Name | Size | Volume Type | Bootable | Attached to | + +------------+-----------+-------------+------+-------------+----------+-------------+ + | 0821...19f | available | - | 10 | - | false | | + +------------+-----------+-------------+------+-------------+----------+-------------+ OpenStack Block Storage also allows creating snapshots of volumes. Remember that this is a block-level snapshot that is crash consistent, @@ -891,20 +891,28 @@ or run this from the command line: .. code-block:: console $ cinder help snapshot-create - usage: cinder snapshot-create [--force ] - [--display-name ] - [--display-description ] - - Add a new snapshot. - Positional arguments: ID of the volume to snapshot - Optional arguments: --force Optional flag to indicate whether to - snapshot a volume even if its - attached to an instance. - (Default=False) - --display-name Optional snapshot name. - (Default=None) - --display-description - Optional snapshot description. (Default=None) + usage: cinder snapshot-create [--force []] [--name ] + [--description ] + [--metadata [ [ ...]]] + + + Creates a snapshot. + + Positional arguments: + Name or ID of volume to snapshot. + + Optional arguments: + --force [] + Allows or disallows snapshot of a volume when the + volume is attached to an instance. If set to True, + ignores the current status of the volume when + attempting to snapshot it rather than forcing it to be + available. Default=False. + --name Snapshot name. Default=None. + --description + Snapshot description. Default=None. + --metadata [ [ ...]] + Snapshot metadata key and value pairs. Default=None. .. note::