crs

crs engine get

Usage

usage: -c crs 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

crs engine list

Usage

usage: -c crs 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

crs engine revision create

Usage

usage: -c crs 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]
                                  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

crs engine revision delete

Usage

usage: -c crs 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

crs engine revision get

Usage

usage: -c crs 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

crs engine revision list

Usage

usage: -c crs 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

crs engine revision update

Usage

usage: -c crs 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

crs engine update

Usage

usage: -c crs 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

crs engine version get

Usage

usage: -c crs 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

crs engine version list

Usage

usage: -c crs 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]

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

crs engine version revisions

Usage

usage: -c crs 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

crs engine version update

Usage

usage: -c crs 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

None

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

crs engine version validate-enabled-revision

Usage

usage: -c crs 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

crs registry create

Usage

usage: -c crs registry create [-h]
                           [-f {adaptive_table,json,shell,table,value,yaml}]
                           [-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
                           [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           [--engine-version-id ENGINE_VERSION_ID]
                           [--instance-type INSTANCE_TYPE]
                           [--allocated-storage ALLOCATED_STORAGE]
                           [--storage-pool-id STORAGE_POOL_ID]
                           [--port PORT] [--description DESCRIPTION]
                           [--certificate-id CERTIFICATE_ID]
                           [--is-external] [--elastic-ip-id ELASTIC_IP_ID]
                           registry_name network_id

Description

Creates a new registry object.

Return

Returns dict: Registry details

Optional

 optional arguments:
-h, --help            show this help message and exit
--engine-version-id ENGINE_VERSION_ID
                      (Optional) Engine version ID of the container registry to be created
--instance-type INSTANCE_TYPE
                      (Optional) Instance type of the container registry instance
--allocated-storage ALLOCATED_STORAGE
                      (Optional) The amount of storage (in gigabytes) to be initially allocated
--storage-pool-id STORAGE_POOL_ID
                      (Optional) The id of the storage pool on which to store the registry data
--port PORT           (Optional) The port for registry
--description DESCRIPTION
                      (Optional) Description of the registry
--certificate-id CERTIFICATE_ID
                      (Optional) The id of the certificate record
--is-external         (Optional) Attach a new external IP to the registry instance if no elastic IP (elastic_ip_id) is specified
--elastic-ip-id ELASTIC_IP_ID
                      (Optional) UUID of the elastic IP to be attached to the registry instance

crs registry delete

Usage

usage: -c crs registry delete [-h]
                           [-f {adaptive_table,json,shell,table,value,yaml}]
                           [-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
                           [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--force-delete]
                           registry_id

Description

Deletes a registry based on the ID supplied.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit
--force-delete        (Optional) Whether to force delete the registry

crs registry download-certificate

Usage

usage: -c crs registry download-certificate [-h]
                                         [-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         registry_id

Description

Get the registry certificate.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit

crs registry get

Usage

usage: -c crs registry get [-h]
                        [-f {adaptive_table,json,shell,table,value,yaml}]
                        [-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
                        [--max-width <integer>] [--noindent]
                        [--prefix PREFIX]
                        registry_id

Description

Returns registry detail based on a registry ID.

Return

Returns dict: Registry details

Optional

 optional arguments:
-h, --help            show this help message and exit

crs registry list

Usage

usage: -c crs registry 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 registry objects.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit

crs registry resize-volume

Usage

usage: -c crs registry resize-volume [-h]
                                  [-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--max-width <integer>] [--noindent]
                                  [--prefix PREFIX]
                                  registry_id allocated_storage

Description

Resize the data volume on a registry instance.

Return

Returns dict: The modified registry

Optional

 optional arguments:
-h, --help            show this help message and exit

crs registry update

Usage

usage: -c crs registry update [-h]
                           [-f {adaptive_table,json,shell,table,value,yaml}]
                           [-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
                           [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           [--registry-name REGISTRY_NAME]
                           [--description DESCRIPTION]
                           registry_id

Description

Update the name or description of a registry instance.

Return

Returns dict: Registry details

Optional

 optional arguments:
-h, --help            show this help message and exit
--registry-name REGISTRY_NAME
                      (Optional) The registry name
--description DESCRIPTION
                      (Optional) The registry description

crs registry update-certificate

Usage

usage: -c crs registry update-certificate [-h]
                                       [-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--max-width <integer>] [--noindent]
                                       [--prefix PREFIX]
                                       registry_id certificate_id

Description

Update the certificate and key on a registry instance.

Return

Returns dict: Registry details

Optional

 optional arguments:
-h, --help            show this help message and exit