summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/server.rst
diff options
context:
space:
mode:
authorRui Chen <chenrui.momo@gmail.com>2017-02-24 16:48:05 +0800
committerRui Chen <chenrui.momo@gmail.com>2017-05-17 01:42:12 +0000
commit7a7bb06377c96f7bfc2c371aa2ff726ee364a9db (patch)
tree518ae86b9137ae6e7921c018f363628316a38ce4 /doc/source/command-objects/server.rst
parent0181de38afc8cc4b96f226b00e173fb0c0d2e4dc (diff)
downloadpython-openstackclient-7a7bb06377c96f7bfc2c371aa2ff726ee364a9db.tar.gz
Make block-device-mapping more stable and clear
The patch fix the following issues: 1. ValueError is raised if input don't contain "=". Sometimes the whole "server create" command is very complex, it's difficult to find out root reason directly. 2. Don't support to add block device from snapshot, like: --block-device-mapping vdb=0c8ae9d8-cadc-4a23-8337-4254614d277e:snapshot:1, it's supported by novaclient, but not in osc. 3. If input "vdb=", not add any mapping information, the server will be launched successfully, not raise error message to let use add volume/snapshot id, just ignore "--block-device-mapping" option. 4. The help message of "block-device-mapping" option is so simple, need to add some details about how to add <type>, <delete_on_terminate> contains. Change-Id: Ib7f7a654c3dc2a8272545f168b4c4ced230ce39e Depends-On: Ib37913891bbf7a31b570404c4668c490d5ac859b Closes-Bug: #1667266
Diffstat (limited to 'doc/source/command-objects/server.rst')
-rw-r--r--doc/source/command-objects/server.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst
index dc78080b..26bb77ca 100644
--- a/doc/source/command-objects/server.rst
+++ b/doc/source/command-objects/server.rst
@@ -193,7 +193,23 @@ Create a new server
.. option:: --block-device-mapping <dev-name=mapping>
- Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)
+ Create a block device on the server.
+
+ Block device mapping in the format
+
+ <dev-name>=<id>:<type>:<size(GB)>:<delete-on-terminate>
+
+ <dev-name>: block device name, like: vdb, xvdc (required)
+
+ <id>: UUID of the volume or snapshot (required)
+
+ <type>: volume or snapshot; default: volume (optional)
+
+ <size(GB)>: volume size if create from snapshot (optional)
+
+ <delete-on-terminate>: true or false; default: false (optional)
+
+ (optional extension)
.. option:: --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>