environment software-specification create

Create a software specification.

Syntax

cpd-cli environment software-specification create \
[--base-software-specification=<base-software-specification>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--description=<software-specification-description>] \
[--jmes-query=<jmespath-query>] \
--name=<software-specification-name> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--package-extensions=<software-specification-package-extensions>] \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
--software-configuration=<software-configuration> \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The environment software-specification create command has no arguments.

Options

Table 1: Command options
Option Description
--base-software-specification Specify a reference to a base software specification.
Status
Optional.
Syntax
--base-software-specification=<base-software-specification>
Default value
No default.
Valid values
A valid base software 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 software specification description.
Status
Optional.
Syntax
--description=<software-specification-description>
Default value
No default.
Valid values
A valid software specification 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.
--name Specify the software specification name.
Status
Required.
Syntax
--name=<software-specification-name>
Default value
No default.
Valid values
A valid software specification 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.
--package-extensions Specify the software specification package extensions.
Status
Optional.
Syntax
--package-extensions=<software-specification-package-extensions>
Default value
No default.
Valid values
Valid software specification package extensions.
--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 to create the software specification in.
Status
Optional.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
Any valid project ID.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
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.
--software-configuration Specify a software configuration.
Status
Required.
Syntax
--software-configuration=<software-configuration>
Default value
No default.
Valid values
A valid software configuration.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--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 add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Specify the environment variables in a script file.
custom_sw_spec_name = "my_sw_spec"

base_sw_spec = {
    'guid': base_sw_spec_id
}
base_sw_spec_json = json.dumps(base_sw_spec)

sw_conf = {}
sw_conf_json = json.dumps(sw_conf)
Create a custom software specification.
cpd-cli environment software-specification create \
--base-software-specification=${base_sw_spec_json} \
--jmes-query="metadata.asset_id" \
--name=${custom_sw_spec_name} \
--output=json \
--project-id=${PROJECT_CPD_INST_OPERANDS} \
--software-configuration=${sw_conf_json} \
--raw-output