environment update

Update a specific environment.

Syntax

cpd-cli environment update \
--environment-id=<environment-guid> \
--name=<environment-name> \
--profile=<cpd-profile-name> \
[--authorization-variables=<environment-authorization-variables>] \
[--compute-specification=<environment-compute-specification>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--description=<environment-description>] \
[--display-name=<environment-display-name>] \
[--environment-variables=<environment-variables>] \
[--hardware-specification=<hardware-sub-specification-pointer>] \
[--jmes-query=<jmespath-query>] \
[--location=<environment-runtime-location>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--runtime-idle-time=<runtime-idle-timeout-value>] \
[--software-specification=<software-sub-specification>] \
[--space-id=<space-identifier>] \
[--tools-specification=<environment-tools-specification>] \
[--verbose]

Arguments

The environment update command has no arguments.

Options

Table 1: Command options
Option Description
--authorization-variables Specify the environment authorization variables.
Status
Optional.
Syntax
--authorization-variables=<environment-authorization-variables>
Default value
No default. (unbounded)
Valid values
Valid authorization variables.
--compute-specification Specify the environment compute specification.
Status
Optional.
Syntax
--compute-specification=<environment-compute-specification>
Default value
No default.
Valid values
A valid environment compute specification.
--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.
--description Specify an environment description.
Status
Optional.
Syntax
--description=<environment-description>
Default value
No default.
Valid values
A valid environment description.
--display-name Specify the environment display name.
Status
Required.
Syntax
--display-name=<environment-display-name>
Default value
No default.
Valid values
A valid environment display name.
--environment-id Specify the environment GUID.
Status
Required.
Syntax
--environment-id=<environment-guid>
Default value
No default.
Valid values
A valid environment GUID.
--environment-variables Specify environment variables for the specified environment.
Status
Optional.
Syntax
--environment-variables=<environment-variables>
Default value
No default.
Valid values
Valid environment variables.
--hardware-specification Provide a pointer to a sub-specification that was defined somewhere else.
Status
Required.
Syntax
--hardware-specification=<hardware-sub-specification-pointer>
Default value
No default.
Valid values
A valid sub-specification pointer.

--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.
--location Specify the environment runtime location.
Status
Optional.
Syntax
--location=<environment-runtime-location>
Default value
No default.
Valid values
A valid environment runtime location.
--name Specify the environment name.
Status
Required.
Syntax
--name=<environment-name>
Default value
No default.
Valid values
A valid environment 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 Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify an IBM Software Hub project instance.
Status
Optional.
Syntax
--project-id=<project-id>
Default value
No default.
Valid values
A valid project identifier.
--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.
--runtime-idle-time Specify the runtime idle timeout value.
Status
Optional.
Syntax
--runtime-idle-time=<runtime-idle-timeout-value>
Default value
No default.
Valid values
Any valid runtime idle timeout value.
--software-specification Specify a sub-software specification that was defined somewhere else.
Status
Optional.
Syntax
--software-specification=<software-sub-specification>
Default value
No default.
Valid values
A valid sub-software specification.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--tools-specification Specify the environment's tools specification.
Status
Optional.
Syntax
--tools-specification=<environment-tools-specification>
Default value
No default.
Valid values
A valid environment tool specification.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.