space create

Create a space that will scope other assets. Authorized user must have the following roles: Platform management role - Administrator; Service access role - Manager.

Syntax

cpd-cli space create \
[--async] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--description=<space-description>] \
[--generator=<generator-label>] \
[--jmes-query=<jmespath-query>] \
--name=<space-name> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--quiet] \
[--raw-output=true|false] \
[--stage=<space-production-and-stage-name>] \
[--storage=<object-storage-properties>] \
[--tags=<tag1,tag2,...>] \
[--verbose]

Arguments

The space create command has no arguments.

Options

Option Description
--async Run the command asynchronously. By default, processing finishes before the command runs.
Status
Optional.
Syntax
--async
Default value
Not applicable.
Valid values
Not
 applicable.
--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
No default.
Valid values
A valid Cloud Pak for Data configuration location.
--description Specify a space description.
Status
Optional.
Syntax
--description=<space-description>
Default value
No default.
Valid values
A valid space description.
--generator Specify a label that is used to identify a client that created a space. A generator label must be comprised of the following characters: alphanumeric, dash, underscore, and space.
Status
Optional.
Syntax
--generator=<generator-label>
Default value
No default.
Valid values
A valid generator label.

--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 the space 
name.
Status
Required.
Syntax
--name=<space-name>
Default value
No default.
Valid values
A valid space 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.
--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 quotes.
true
Single values in JSON output mode are not surrounded by quotes.
--stage Specify the space production and stage name.
Status
Optional.
Syntax
--stage=<space-production-and-stage-name>
Default value
No default.
Valid values
A valid space production and stage name.
--storage Specify the Cloud Object Storage instance that is required for spaces created on the public cloud. On private Cloud Pak for Data installations, the default storage is used.
Status
Optional.
Syntax
--storage=<cloud-object-storage-instance>
Default value
No default.
Valid values
Valid cloud object storage instance.
--tags Specify a list of tags that are associated with a space.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Default value
No default.
Valid values
A valid list of comma-separated tags that are associated with a space.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can optionally add the listed environment variables to the install variables script. For more information, see Best practice: Setting up install variables.
Define the environment variables.
Replace the following properties with your data.
export SPACE_NAME='space-for-scripts'
Create a space.
cpd-cli space create \
--jmes-query="metadata.id" \
--name=${SPACE_NAME} \
--output=json \
--raw-output