asset update

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.

Edit existing asset properties if you have appropriate permissions.

Syntax

cpd-cli asset update \
--asset-id=<asset-guid> \
[--catalog-id=<catalog-id>] \
[--classification=<asset-classification>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--description=<description>] \
[--jmes-query=<jmespath-query>] \
--json-patch=<json-array> \
[--name=<update-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] \
[--resource-key=<resource-key>] \
[--source-system=<source-system-information>] \
[--space-id=<space-identifier>] \
[--tags=<tag1,tag2,...>] \
[--verbose] \
[--x-open-id-connect-id-token=<x-open-id-connect-id-token>]

Arguments

The asset update command has no arguments.

Options

Option Description
--asset-id Specify the asset GUID.
Status
Required.
Syntax
--asset-id=<asset-guid>
Default value
No default.
Valid values
Any valid asset GUID.
--catalog-id Specify either a catalog ID,
project ID, or space ID (specify only one).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project or space ID.
--classification Specify the asset
 classification.
Status
Optional.
Syntax
--classification=<asset-classification>
Default value
No default.
Valid values
A valid class 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
$HOME/.cpd-cli/config
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-scope>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--description Specify a data asset
description.
Status
Optional.
Syntax
--description=<description>
Default value
No default.
Valid values
A valid data asset description.

--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.
--json-patch Specify a JSON array of patch operations as defined in RFC 6902. For more information, see http://jsonpatch.com.
Status
Required.
Syntax
--json-patch=<json-array>
Default value
No default.
Valid values
A valid JSON array of patch operation as defined by RFC 6902.
--name Specify the updated asset
 name.
Status
Required.
Syntax
--name=<update-name>
Default value
No default.
Valid values
A valid update asset 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
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.
--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 quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--resource-key Specify an updated resource
 key.
Status
Optional.
Syntax
--resource-key=<resource-key>
Default value
No default.
Valid values
A valid resource key.
--source-system Specify custom data that is
 associated with an object.
Status
Optional.
Syntax
--source-system=<source-system-information>
Default value
No default.
Valid values
Any valid custom data.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--tags Specify the data asset tags. Multiple tags can be specified.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Default value
No default.
Valid values
A valid list of comma-separated data asset tags.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

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.
asset_id = <Specify the asset
GUID.>
project_id = <The Cloud Pak for Data project instance.>
space_id = <Specify the deployment space identifier.>
Edit existing asset properties if you have appropriate permissions.
cpd-cli asset update \
--asset-id=${asset_id} \
--json-patch=<Specify a JSON array of patch
operations as defined in RFC 6902. For more information, see
http://jsonpatch.com.> \
--project-id=${PROJECT_CPD_INST_OPERANDS} \
--space-id=${space_id}