environment hardware-specification update

Update a specific hardware specification.

Syntax

cpd-cli environment hardware-specification update \
--hardware-specification-id=<hardware-specification-guid> \
--profile=<cpd-profile-name> \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--cpu-model<cpu-model-name>] \
[--cpu-units=<number-of-cpus>] \
[--description=<hardware-specification-description>] \
[--gpu-name=<gpu-name>] \
[--gpu-num=<number-of-gpus>] \
[--jmes-query=<jmespath-query>] \
[--mem-size=<memory-size-value>] \
[--name=<hardware-specification-name>] \
[--nodes-num=<compute-nodes-value>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--spark-driver-cpu-model=<spark-driver-cpu-name>] \
[--spark-driver-cpu-units=<number-of-spark-driver-cpus>] \
[--spark-driver-mem-size=<spark-driver-memory-value>] \
[--spark-drivers-num=--spark-drivers-num] \
[--spark-executor-cpu-model=<spark-executor-cpu-model-name>] \
[--spark-executor-cpu-units=<number-of-spark-executor-cpus>] \
[--spark-executor-mem-size=<spark-executor-memory-size>] \
[--spark-executors-num=<number-of-spark-executors>] \
[--verbose]

Arguments

The environment hardware-specification update command has no arguments.

Options

Table 1: Command options
Option Description
--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.
--cpu-model Specify the CPU model name.
Status
Optional.
Syntax
--cpu-model=<cpu-model-name>
Default value
No default.
Valid values
A valid CPU model name.
--cpu-units Specify the number of CPUs.
Status
Optional.
Syntax
--cpu-units=<number-of-cpus>
Default value
No default.
Valid values
A valid number of CPUs value.
--description Specify a hardware specification description.
Status
Optional.
Syntax
--description=<hardware-specification-description>
Default value
No default.
Valid values
A valid hardware specification description.
--gpu-name Specify the GPU name.
Status
Optional.
Syntax
--gpu-name=<gpu-name>
Default value
No default.
Valid values
A valid GPU name.
--gpu-num Specify the number of GPUs.
Status
Optional.
Syntax
--gpu-num=<number-of-gpus>
Default value
No default.
Valid values
A valid number of GPUs value.
--hardware-specification-id Specify the hardware specification GUID.
Status
Required.
Syntax
--hardware-specification-id=<hardware-specification-guid>
Default value
No default.
Valid values
A valid hardware specification GUID.

--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.
--mem-size Specify the memory size (in Kubernetes size strings).
Status
Optional.
Syntax
--mem-size=<memory-size-value>
Default value
No default.
Valid values
A valid memory size value.
--name Specify the hardware specification name.
Status
Optional.
Syntax
--name=<hardware-specification-name>
Default value
No default.
Valid values
A valid hardware specification name.
--nodes-num Specify the number of compute nodes.
Status
Optional.
Syntax
--nodes-num=<compute-nodes-value>
Default value
No default.
Valid values
A valid number of compute nodes.
--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.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--spark-driver-cpu-model Specify the Spark driver CPU model name.
Status
Optional.
Syntax
--spark-driver-cpu-model=<spark-driver-cpu-name>
Default value
No default.
Valid values
A valid Spark driver CPU model name.
--spark-driver-cpu-units Specify the number of Spark driver CPUs.
Status
Optional.
Syntax
--spark-driver-cpu-units=<number-of-spark-driver-cpus>
Default value
No default.
Valid values
A valid number of Spark driver CPUs.
--spark-driver-mem-size Specify the Spark driver memory size value.
Status
Optional.
Syntax
--spark-driver-mem-size=<spark-driver-memory-value>
Default value
No default.
Valid values
A valid Spark driver memory size value.
--spark-drivers-num Specify the number of Spark drivers.
Status
Optional.
Syntax
--spark-drivers-num=<number-of-spark-drivers>
Default value
No default.
Valid values
A valid number of Spark drivers.
--spark-executor-cpu-model Specify the Spark executor CPU model name.
Status
Optional.
Syntax
--spark-executor-cpu-model=<spark-executor-cpu-model-name>
Default value
No default.
Valid values
A valid Spark executor CPU model name.
--spark-executor-cpu-units Specify the number of Spark executor CPUs.
Status
Optional.
Syntax
--spark-executor-cpu-units=<number-of-spark-executor-cpus>
Default value
No default.
Valid values
A valid number of Spark executor CPUs.
--spark-executor-mem-size Specify the Spark executor memory size.
Status
Optional.
Syntax
--spark-executor-mem-size=<spark-executor-memory-size>
Default value
No default.
Valid values
A valid Spark executor memory size value.
--spark-executors-num Specify the number of Spark executors.
Status
Optional.
Syntax
--spark-executors-num=<number-of-spark-executors>
Default value
No default.
Valid values
A valid number of Spark executors.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.