engine¶
engine category get¶
Usage
usage: -c engine category get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
category_id
Description
Returns a category based on a category ID.
Return
Returns dict: Category response
Optional
optional arguments:
-h, --help show this help message and exit
engine category list¶
Usage
usage: -c engine category 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}]
Description
Returns all category objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
engine get¶
Usage
usage: -c engine get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
engine_id
Description
Returns a engine based on a engine ID.
Return
Returns dict: Engine response
Optional
optional arguments:
-h, --help show this help message and exit
engine health get¶
Usage
usage: -c engine health get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns the health status.
Return
Returns dict: Health status
Optional
optional arguments:
-h, --help show this help message and exit
engine list¶
Usage
usage: -c engine 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}] [--full-details]
[--service-name SERVICE_NAME] [--include-all]
Description
Returns all engine objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--include-all (Optional) Whether to include unusable engines
engine profile get¶
Usage
usage: -c engine profile get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--render-values RENDER_VALUES]
profile_id
Description
Returns a profile based on a profile ID after rendering template with values.
Return
Returns dict: Profile with rendered values
Optional
optional arguments:
-h, --help show this help message and exit
--render-values RENDER_VALUES
Dictionary of values for profile template rendering
engine profile list¶
Usage
usage: -c engine profile 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}]
[--full-details] [--revision-id REVISION_ID]
Description
Returns List of deployment profiles.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--revision-id REVISION_ID
(Optional) Revision ID to filter on
engine revision create¶
Usage
usage: -c engine revision create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--storage-pool-id STORAGE_POOL_ID]
[--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID]
[--name NAME] [--description DESCRIPTION]
[--engine-name ENGINE_NAME]
[--engine-description ENGINE_DESCRIPTION]
[--version-name VERSION_NAME]
[--version-description VERSION_DESCRIPTION]
[--gcm-role-states GCM_ROLE_STATES]
[--gcm-state-file-details GCM_STATE_FILE_DETAILS]
[--file-details FILE_DETAILS]
[--service-info SERVICE_INFO]
[--vm-constraints VM_CONSTRAINTS]
[--service-constraints SERVICE_CONSTRAINTS]
[--service-capabilities SERVICE_CAPABILITIES]
[--gcm-info GCM_INFO]
[--engine-aliases ENGINE_ALIASES]
[--version-aliases VERSION_ALIASES]
[--profiles PROFILES] [--entitled]
[--parameter-group PARAMETER_GROUP]
[--engine-category ENGINE_CATEGORY]
service_name engine_family version_family
sequence logo_variant logo_contents
vm_image_details
Description
Creates new revision.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
--storage-pool-id STORAGE_POOL_ID
(Optional) The id of the storage pool on which to store the image
--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
--name NAME (Optional) The name of the revision
--description DESCRIPTION
(Optional) The description of the revision
--engine-name ENGINE_NAME
(Optional) The name of the engine
--engine-description ENGINE_DESCRIPTION
(Optional) The description of the engine
--version-name VERSION_NAME
(Optional) The name of the version
--version-description VERSION_DESCRIPTION
(Optional) The description of the version
--gcm-role-states GCM_ROLE_STATES
(Optional) GCM states to use in role
--gcm-state-file-details GCM_STATE_FILE_DETAILS
(Optional) GCM state files to register
--file-details FILE_DETAILS
(Optional) File information
--service-info SERVICE_INFO
(Optional) Service specific information
--vm-constraints VM_CONSTRAINTS
(Optional) Constraints for creating the VM
--service-constraints SERVICE_CONSTRAINTS
(Optional) Service specific constraints
--service-capabilities SERVICE_CAPABILITIES
(Optional) Service specific capabilities
--gcm-info GCM_INFO (Optional) GCM specific information
--engine-aliases ENGINE_ALIASES
(Optional) Engine family aliases
--version-aliases VERSION_ALIASES
(Optional) Version family aliases
--profiles PROFILES (Optional) Deployment profiles
--entitled (Optional) Should the revision set as entitled
--parameter-group PARAMETER_GROUP
(Optional) Parameter group details
--engine-category ENGINE_CATEGORY
(Optional) The engine category
engine revision delete¶
Usage
usage: -c engine revision delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
revision_id
Description
Deletes a single revision object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
engine revision get¶
Usage
usage: -c engine revision get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
revision_id
Description
Returns a revision based on a revision ID.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
engine revision list¶
Usage
usage: -c engine revision 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}]
[--full-details] [--service-name SERVICE_NAME]
[--engine-id ENGINE_ID]
[--version-id VERSION_ID] [--include-all]
Description
Returns all revision objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--engine-id ENGINE_ID
(Optional) Engine ID to filter on
--version-id VERSION_ID
(Optional) Version ID to filter on
--include-all (Optional) Whether to include unusable revisions
engine revision update¶
Usage
usage: -c engine revision 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]
[--enabled ENABLED]
[--storage-pool-id STORAGE_POOL_ID]
revision_id
Description
Modify an engine.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The version name
--description DESCRIPTION
(Optional) Description of the version
--enabled ENABLED (Optional) False if not to be presented for creation
--storage-pool-id STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
engine update¶
Usage
usage: -c engine 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]
[--enabled ENABLED]
[--default-version-id DEFAULT_VERSION_ID]
[--logo-variant LOGO_VARIANT]
[--logo-contents LOGO_CONTENTS]
engine_id
Description
Modify an engine.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The engine name
--description DESCRIPTION
(Optional) Description of the engine
--enabled ENABLED (Optional) False if not to be presented for creation
--default-version-id DEFAULT_VERSION_ID
(Optional) The default version ID
--logo-variant LOGO_VARIANT
'Version' of the logo
--logo-contents LOGO_CONTENTS
Contents of the logo in SVG format
engine version get¶
Usage
usage: -c engine version get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
version_id
Description
Returns a version based on a version ID.
Return
Returns dict: Version response
Optional
optional arguments:
-h, --help show this help message and exit
engine version list¶
Usage
usage: -c engine version 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}]
[--full-details] [--service-name SERVICE_NAME]
[--engine-id ENGINE_ID] [--include-all]
[--platform PLATFORM]
[--engine-alias ENGINE_ALIAS]
[--version-alias VERSION_ALIAS]
[--parameter-group-family PARAMETER_GROUP_FAMILY]
Description
Returns all version objects.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--full-details (Optional) Whether to return all information
--service-name SERVICE_NAME
(Optional) Service name to filter on
--engine-id ENGINE_ID
(Optional) Engine ID to filter on
--include-all (Optional) Whether to include unusable versions
--platform PLATFORM (Optional) Platform name to filter on
--engine-alias ENGINE_ALIAS
(Optional) Engine alias to filter on
--version-alias VERSION_ALIAS
(Optional) Version alias to filter on
--parameter-group-family PARAMETER_GROUP_FAMILY
(Optional) Parameter group family to filter on
engine version revisions¶
Usage
usage: -c engine version revisions [-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}]
[--include-all]
version_id
Description
List all revisions for a specified version.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--include-all (Optional) Whether to include unusable versions
engine version update¶
Usage
usage: -c engine version 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]
[--enabled ENABLED]
[--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID]
version_id
Description
Modify an engine.
Return
Returns dict: Version response
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME (Optional) The version name
--description DESCRIPTION
(Optional) Description of the version
--enabled ENABLED (Optional) False if not to be presented for creation
--default-vm-storage-pool-id DEFAULT_VM_STORAGE_POOL_ID
(Optional) The default storage pool ID for VMs
engine version validate-enabled-revision¶
Usage
usage: -c engine version validate-enabled-revision [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
version_id
Description
Validate and return the enabled_revision of the specified version.
Return
Returns dict: Revision response
Optional
optional arguments:
-h, --help show this help message and exit