summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-01-05 01:27:47 -0500
committerSteve Martinelli <stevemar@ca.ibm.com>2015-01-05 21:46:32 -0500
commitca92608974a8fe9a54951d0ea6b24ab59a5b7a06 (patch)
tree6a4f02e75acaa968fd156768cd9cb33bee0dbd0e /doc
parent32c15633f4cf23cf1469ce20e6e478214eef85ff (diff)
downloadpython-openstackclient-ca92608974a8fe9a54951d0ea6b24ab59a5b7a06.tar.gz
Command doc: volume type
Change-Id: I7e36daa027639d6a782043d4181c1b328335975a
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/volume-type.rst95
-rw-r--r--doc/source/commands.rst2
2 files changed, 96 insertions, 1 deletions
diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst
new file mode 100644
index 00000000..0898df52
--- /dev/null
+++ b/doc/source/command-objects/volume-type.rst
@@ -0,0 +1,95 @@
+===========
+volume type
+===========
+
+Volume v1
+
+volume type create
+------------------
+
+Create new volume type
+
+.. program:: volume type create
+.. code:: bash
+
+ os volume type create
+ [--property <key=value> [...] ]
+ <name>
+
+.. option:: --property <key=value>
+
+ Set a property on this volume type (repeat option to set multiple properties)
+
+.. describe:: <name>
+
+ New volume type name
+
+volume type delete
+------------------
+
+Delete volume type
+
+.. program:: volume type delete
+.. code:: bash
+
+ os volume type delete
+ <volume-type>
+
+.. describe:: <volume-type>
+
+ Volume type to delete (name or ID)
+
+volume type list
+----------------
+
+List volume types
+
+.. program:: volume type list
+.. code:: bash
+
+ os volume type list
+ [--long]
+
+.. option:: --long
+
+ List additional fields in output
+
+volume type set
+---------------
+
+Set volume type properties
+
+.. program:: volume type set
+.. code:: bash
+
+ os volume type set
+ [--property <key=value> [...] ]
+ <volume-type>
+
+.. option:: --property <key=value>
+
+ Property to add or modify for this volume type (repeat option to set multiple properties)
+
+.. describe:: <volume-type>
+
+ Volume type to modify (name or ID)
+
+volume type unset
+-----------------
+
+Unset volume type properties
+
+.. program:: volume type unset
+.. code:: bash
+
+ os volume type unset
+ [--property <key>]
+ <volume-type>
+
+.. option:: --property <key>
+
+ Property to remove from volume type (repeat option to remove multiple properties)
+
+.. describe:: <volume-type>
+
+ Volume type to modify (name or ID)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 4b2e6355..5bec1a85 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -113,7 +113,7 @@ referring to both Compute and Volume quotas.
* ``user``: (**Identity**) individual cloud resources users
* ``user role``: (**Identity**) roles assigned to a user
* ``volume``: Volume - block volumes
-* ``volume type``: Volume - deployment-specific types of volumes available
+* ``volume type``: (**Volume**) deployment-specific types of volumes available
Actions
-------