volume¶
volume create¶
Usage
usage: -c volume create [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--size SIZE] [--source-id SOURCE_ID]
[--storage-pool STORAGE_POOL]
[--description DESCRIPTION]
[--source-type SOURCE_TYPE] [--project-id PROJECT_ID]
name
Description
Create a new volume.
Return
Returns dict: New volume information.
Optional
optional arguments:
-h, --help show this help message and exit
--size SIZE Volume size in GB.
--source-id SOURCE_ID
ID of the source for the new volume.
--storage-pool STORAGE_POOL
ID of the storage pool to create the volume in.
--description DESCRIPTION
Description for the volume.
--source-type SOURCE_TYPE
The type of the source entity (Deprecated param).
--project-id PROJECT_ID
ID of the project that the new volume should belong to.
volume create-and-upload¶
Usage
usage: -c volume create-and-upload [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project-id PROJECT_ID]
[--description DESCRIPTION]
[--storage-pool STORAGE_POOL]
file name
Description
Create a new volume and upload file to it
Return
Returns dict: New volume information.
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
ID of the project that the new volume should belong to.
--description DESCRIPTION
Description for the volume.
--storage-pool STORAGE_POOL
ID of the storage pool to create the volume in.
volume expose¶
Usage
usage: -c volume expose [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
volume_id
Description
Expose a volume
Return
Returns dict: exposed volume information
Optional
optional arguments:
-h, --help show this help message and exit
volume extend¶
Usage
usage: -c volume extend [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
volume_id size
Description
Extend volume size.
Return
Returns dict: The extended volume information.
Optional
optional arguments:
-h, --help show this help message and exit
volume get¶
Usage
usage: -c volume get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--with-tags WITH_TAGS] [--skip-cache SKIP_CACHE]
volume_id
Description
Get information on a volume.
Return
Returns dict: Volume information.
Optional
optional arguments:
-h, --help show this help message and exit
--with-tags WITH_TAGS
--skip-cache SKIP_CACHE
volume list¶
Usage
usage: -c volume list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--filter-list FILTER_LIST] [--tag TAG]
[--tag-key TAG_KEY] [--tag-value TAG_VALUE]
[--with-tags] [--skip-cache SKIP_CACHE]
Description
List volumes.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--filter-list FILTER_LIST
Filter list of volumes by provided keys (filter list is a string of key=value)
--tag TAG Tag to filter the list of volumes by
--tag-key TAG_KEY
--tag-value TAG_VALUE
--with-tags Flag that indicates if list should get ports-tags or not
--skip-cache SKIP_CACHE
volume list-manageable¶
Usage
usage: -c volume list-manageable [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
storage_pool
Description
Lists volumes on the back-end that are available for managing.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
volume manage¶
Usage
usage: -c volume manage [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--description DESCRIPTION] [--project-id PROJECT_ID]
[--volume-id VOLUME_ID]
name storage_pool reference
Description
Manage a volume that already exists in a back-end.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
Description for the volume.
--project-id PROJECT_ID
ID of the project that the new volume should belong to.
--volume-id VOLUME_ID
Specify an ID for the volume rather than using a random one.
volume remove¶
Usage
usage: -c volume remove [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--override-protection]
volume_id
Description
Remove a volume.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True and the caller is an admin, allow deleting resource
volume tag add¶
Usage
usage: -c volume tag add [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
volume_id tags
Description
Add tags to a volume
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
volume tag remove¶
Usage
usage: -c volume tag remove [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
volume_id tags
Description
Remove tags from a volume
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
volume undelete¶
Usage
usage: -c volume undelete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
volume_id
Description
Restored a removed volume.
Return
Returns dict: Restored volume information.
Optional
optional arguments:
-h, --help show this help message and exit
volume unexpose¶
Usage
usage: -c volume unexpose [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
volume_id
Description
Unexpose an exposed volume
Return
Returns dict: Unexposed volume information
Optional
optional arguments:
-h, --help show this help message and exit
volume unmanage¶
Usage
usage: -c volume unmanage [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
volume_id
Description
Unmanage the volume.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
volume update¶
Usage
usage: -c volume update [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--name NAME] [--description DESCRIPTION]
volume_id
Description
Update metadata of an existing volume.
Return
Returns dict: Updated volume information.
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME New name for the volume.
--description DESCRIPTION
New description for the volume.