ml deployment list

Retrieve the list of deployments for the specified space.

Syntax

cpd-cli ml deployment list \
[--asset-id=<asset-id>] \
[--conflict] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--jmes-query=<jmespath-query>] \
[--name=<deployment-name>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<profile-name> \
[--quiet] \
[--raw-output=true|false] \
[--serving-name=<serving-name>] \
--space-id=<space-identifier> \
[--state=<state-filter-value>] \
[--stats=true|false] \
[--tag-value=<comma-separated-tag-value-list>] \
[--type=<resource-type-value>] \
[--verbose]

Arguments

The ml deployment list command has no arguments.

Options

Table 1: Command options
Option Description
--asset-id Specify an 'asset_id'. Only resources with the provided 'asset_id' are returned. 'asset_id' can be either 'model_id' or 'function_id'.
Status
Optional.
Syntax
--asset-id=<asset-id>
Default value
No default.
Valid values
A valid model_id or function_id.
--conflict Returns whether 'serving_name' is available for use. This option cannot be used with any other option except for 'serving_name'.
Status
Optional.
Syntax
--conflict
Default value
False.
Valid values
Boolean.
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.
--cpd-scope The IBM Software Hub space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid IBM Software Hub space, project, or catalog scope.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--name Specify a deployment name.
Status
Optional.
Syntax
--name=<deployment-name>
Default value
No default.
Valid values
A valid deployment name.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The name of the profile that you created to store information about an instance of IBM Software Hub and your credentials for the instance.
Status
Required.
Syntax
--profile=<profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--serving-name Specify a 'serving_name'. The deployment (if any) that contains the specified 'serving_name' is returned.
Status
Optional.
Syntax
--serving-name=<serving-name>
Default value
No default.
Valid values
Any valid serving_name.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--state Specify a state filter value to retrieve resources. Allowed values are 'initializing', 'updating', 'ready' and 'failed'.
Status
Optional.
Syntax
--state=<state-filter-value>
Default value
No default.
Valid values
initializing, updating, ready, and failed.
--stats When set to true, the option returns stats about deployments within a space or across spaces. This option cannot be combined with any other option except for 'space_id'.
Status
Optional.
Syntax
--stats=true|false
Default value
true
Valid values
true
The option returns stats about deployments within a space or across spaces.
false
The option does not return stats about deployments within a space or across spaces.
--tag-value Specify a comma-separated tag value list. Only resources with the specified tag values are returned.
Status
Optional.
Syntax
--tag-value=<comma-separated-tag-value-list>
Default value
No default.
Valid values
A valid comma-separated tag value list.
--type Specify a resource type value. Only resources that match the specified type are returned. Allowed type values are 'model', 'function', 'py_script', 'r_shiny', and 'do'.
Status
Optional.
Syntax
--type=<resource-type-value>
Default value
No default.
Valid values
A valid resource type value.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Specify the environment variables in a script file.
deployment_name = "script_batch_deployment"
space_id = <The deployment space identifier>
Update a script batch deployment in the production space.
cpd-cli ml deployment list \
--jmes-query="resources[0].metadata.id" \
--name=${deployment_name} \
--output=json \
--raw-output \
--space-id=${space_id}