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-scope>] \
[--description=<project-description>] \
[--jmes-query=<jmespath-query>] \
[--name=<project-name>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-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

Table 1: Command 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-scope>
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. This option has effect only when --output is set to json or yaml.
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.
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 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 are not surrounded by quotation marks in
 JSON output mode.
Status
Optional. This option has effect only when --output is set to json or yaml.
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.
--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.