Command doc: volume type
Change-Id: I7e36daa027639d6a782043d4181c1b328335975a
This commit is contained in:
		
							
								
								
									
										95
									
								
								doc/source/command-objects/volume-type.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										95
									
								
								doc/source/command-objects/volume-type.rst
									
									
									
									
									
										Normal file
									
								
							@@ -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)
 | 
			
		||||
@@ -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
 | 
			
		||||
-------
 | 
			
		||||
 
 | 
			
		||||
@@ -71,7 +71,7 @@ class DeleteVolumeType(command.Command):
 | 
			
		||||
        parser.add_argument(
 | 
			
		||||
            'volume_type',
 | 
			
		||||
            metavar='<volume-type>',
 | 
			
		||||
            help='Name or ID of volume type to delete',
 | 
			
		||||
            help='Volume type to delete (name or ID)',
 | 
			
		||||
        )
 | 
			
		||||
        return parser
 | 
			
		||||
 | 
			
		||||
@@ -115,7 +115,7 @@ class ListVolumeType(lister.Lister):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class SetVolumeType(command.Command):
 | 
			
		||||
    """Set volume type property"""
 | 
			
		||||
    """Set volume type properties"""
 | 
			
		||||
 | 
			
		||||
    log = logging.getLogger(__name__ + '.SetVolumeType')
 | 
			
		||||
 | 
			
		||||
@@ -124,13 +124,13 @@ class SetVolumeType(command.Command):
 | 
			
		||||
        parser.add_argument(
 | 
			
		||||
            'volume_type',
 | 
			
		||||
            metavar='<volume-type>',
 | 
			
		||||
            help='Volume type name or ID to update',
 | 
			
		||||
            help='Volume type to modify (name or ID)',
 | 
			
		||||
        )
 | 
			
		||||
        parser.add_argument(
 | 
			
		||||
            '--property',
 | 
			
		||||
            metavar='<key=value>',
 | 
			
		||||
            action=parseractions.KeyValueAction,
 | 
			
		||||
            help='Property to add/change for this volume type '
 | 
			
		||||
            help='Property to add or modify for this volume type '
 | 
			
		||||
                 '(repeat option to set multiple properties)',
 | 
			
		||||
        )
 | 
			
		||||
        return parser
 | 
			
		||||
@@ -148,7 +148,7 @@ class SetVolumeType(command.Command):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class UnsetVolumeType(command.Command):
 | 
			
		||||
    """Unset volume type property"""
 | 
			
		||||
    """Unset volume type properties"""
 | 
			
		||||
 | 
			
		||||
    log = logging.getLogger(__name__ + '.UnsetVolumeType')
 | 
			
		||||
 | 
			
		||||
@@ -157,14 +157,14 @@ class UnsetVolumeType(command.Command):
 | 
			
		||||
        parser.add_argument(
 | 
			
		||||
            'volume_type',
 | 
			
		||||
            metavar='<volume-type>',
 | 
			
		||||
            help='Type ID or name to remove',
 | 
			
		||||
            help='Volume type to modify (name or ID)',
 | 
			
		||||
        )
 | 
			
		||||
        parser.add_argument(
 | 
			
		||||
            '--property',
 | 
			
		||||
            metavar='<key>',
 | 
			
		||||
            action='append',
 | 
			
		||||
            default=[],
 | 
			
		||||
            help='Property key to remove from volume '
 | 
			
		||||
            help='Property to remove from volume type '
 | 
			
		||||
                 '(repeat option to remove multiple properties)',
 | 
			
		||||
        )
 | 
			
		||||
        return parser
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user