notebook update

Update a specific notebook.

Syntax

cpd-cli notebook update \
--notebook-id=<notebook-guid> \
--profile=<cpd-profile-name> \
[--compute=<saas-identifier>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--environment=<environment-id>] \
[--jmes-query=<jmespath-query>] \
[--kernel=<notebook-kernel>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--quiet] \
[--raw-output=true|false] \
[--schedule=<notebook-schedule-identifier>] \
[--shares] \
[--spark-monitoring-enabled] \
[--verbose]

Arguments

The notebook update command has no arguments.

Options

Table 1: Command options
Option Description
--compute Specify the Spark-as-a-Service identifier that the notebook runs on.
Status
Optional.
Syntax
--compute=<saas-identifier>
Default value
No default.
Valid values
A valid Spark-as-a-Service identifier.
--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.
--environment Specify the environment ID that the notebook runs on.
Status
Optional.
Syntax
--environment=<environment-id>
Default value
No default.
Valid values
A valid environment ID upon which the notebook runs.

--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.
--kernel Specify the notebook kernel.
Status
Optional.
Syntax
--kernel=<notebook-kernel>
Default value
No default.
Valid values
A valid notebook kernel.
--notebook-id Specify the notebook GUID.
Status
Required.
Syntax
--notebook-id=<notebook-guid>
Default value
No default.
Valid values
A valid notebook GUID.
--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.
--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.
--schedule Specify the notebook schedule identifier.
Status
Optional.
Syntax
--schedule=<notebook-schedule-identifier>
Default value
No default.
Valid values
A valid notebook schedule identifier.
--shares When this option is specified, the notebook repository information is shared.
Status
Optional.
Syntax
--shares
Default value
Not applicable.
Valid values
Not applicable.
--spark-monitoring-enabled When this option is specified, Spark monitoring is enabled.
Status
Optional.
Syntax
--spark-monitoring-enabled
Default value
Not applicable.
Valid values
Not applicable.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.