project update

Partially update the project with a subset of properties.

Syntax

cpd-cli project update \
[--catalog=<catalog-identifier>] \
[--compute=<list-of-project-computes>] \
[--cpd-scope=<cpd-config-location>] \
[--description=<project-description>] \
[--jmes-query=<jmespath-query>] \
[--name=<project-name>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
--project-id=<cpd-project-id> \
[--public=true|false] \
[--raw-output=true|false] \
[--tools=<list-of-project-tools>]

Arguments

The project update command has no arguments.

Options

Option Description
--catalog Specify a catalog identifier that is associated with the specified project.
Status
Optional.
Syntax
--catalog=<catalog-identifier>
Default value
No default.
Valid values
A valid catalog identifier.
--compute Specify a list of computes that are associated with the project.
Status
Optional.
Syntax
--compute=<list-of-project-computes>
Default value
No default.
Valid values
A valid list of project computes.
--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 a project 
description. The description cannot contain any of the following characters: left angle bracket (<), right angle bracket (>), backslash (\\), or double quote (").
Status
Optional.
Syntax
--description=<project-description>
Default value
No default.
Valid values
A valid project description.

--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.
--name Specify a project name. The project name cannot contain any of the following characters: left angle bracket (<), right angle bracket (>), backslash (\\), double quote ("), or percentage sign (%).
Status
Optional.
Syntax
--name=<project-name>
Default value
No default.
Valid values
A valid project 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.
--public When set to true, the project is public.
Status
Optional.
Syntax
--public=true|false
Default value
true
Valid values
true
The project is public.
false
The project is not public.
--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.
--tools Specify a list of tools that are associated with the project.
Status
Optional.
Syntax
--tools=<list-of-project-tools>
Default value
No default.
Valid values
A valid list of project tools.