environment update

Update a specific environment.

Syntax

cpd-cli environment update \
[--authorization-variables=<environment-authorization-variables>] \
[--compute-specification=<environment-compute-specification>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--description=<environment-description>] \
[--display-name=<environment-display-name>] \
--environment-id=<environment-guid> \
[--environment-variables=<environment-variables>] \
[--hardware-specification=<hardware-sub-specification-pointer>] \
[--jmes-query=<jmespath-query>] \
[--location=<environment-runtime-location>] \
--name=<environment-name> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-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

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 Cloud Pak for Data
configuration location (for example, $HOME/.cpd-cli/config).
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope (for example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135).
Status
Optional.
Syntax
--cpd-scope=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data 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 elsewhere.
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 The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid lucene 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. Valid formats include json, yaml, or text (the default format).
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
json|yaml|text
--output-file Specify a file path where all output is redirected.
Status
Required.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-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 in
 JSON output mode are not surrounded by quotes.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotes.
true
Single values in JSON output mode are not surrounded by quotes.
--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 elsewhere.
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
Required.
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.