notebook version get

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Retrieve a specific notebook version.

Syntax

cpd-cli notebook version get \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--jmes-query=<jmespath-query>] \
--notebook-id=<notebook-guid> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--quiet] \
[--raw-output=true|false] \
[--verbose] \
--version-id=<version-guid> \

Arguments

The notebook version get command has no arguments.

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 Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.

--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.
--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. 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
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-configuration-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 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 quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--version-id Specify the version GUID.
Status
Required.
Syntax
--version-id=<version-guid>
Default value
No default.
Valid values
A valid version GUID.

Table 1: Command options

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 install variables script. For more information, see Best practice: Setting up install variables.
Specify the environment variables in a script file.
notebook_id = <The notebook identifier>
version_id = <The notebook version identifier>
Get the path in the storage volume to the notebook version that you want to download.
cpd-cli notebook version get \
--jmes-query="entity.file_reference" \
--notebook-id=${notebook_id} \
--output=json \
--raw-output \
--version-id=${version_id}