summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/server.rst
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-05-22 20:41:43 +0000
committerGerrit Code Review <review@openstack.org>2017-05-22 20:41:43 +0000
commit2be3de2df47b1c0fd97fdf2b46eccbc17271af9c (patch)
tree155d7c31cde559e20b196aea1f9f0912335991aa /doc/source/command-objects/server.rst
parent411cda722b082bc9274dd23f7e6b0c47e2cc9765 (diff)
parent7a7bb06377c96f7bfc2c371aa2ff726ee364a9db (diff)
downloadpython-openstackclient-2be3de2df47b1c0fd97fdf2b46eccbc17271af9c.tar.gz
Merge "Make block-device-mapping more stable and clear"
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>