`asset attachment create`

Create an attachment.

Syntax

cpd-cli asset attachment create \
--asset-id=<asset-guid> \
--asset-type=<asset-type> \
--profile=<profile-name> \
[--catalog-id=<catalog-id>] \
[--connection-id=<connection-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--data-partitions=<num-data-partitions>] \
[--description=<description>] \
[--is-partitioned=true|false] \
[--jmes-query=<jmespath-query>] \
[--mime=<mime-type>] \
[--name=<attachment-name>] \
[--object-key=<object-key>] \
[--object-key-is-read-only=true|false] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--private-url=true|false] \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--url=<cpd-web-url>] \
[--user-data=<user-data>] \
[--verbose]

Arguments

The asset attachment create command has no arguments.

Options

Table 1: Command 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.
`--asset-type`	Specify the asset type to use when resolving paths that include only an asset ID. Status Required. Syntax `--asset-type=<asset-type>` Default value No default. Valid values Any valid asset type.
`--catalog-id`	Specify either a catalog ID,  project ID, or space ID (specify one only). Status Optional. Syntax `--catalog-id=<catalog-id>` Default value No default. Valid values A valid catalog, project, or space ID.
`--connection-id`	Specify the connection ID. Status Required. Syntax `--connection-id=<connection-id>` Default value No default. Valid values A valid connection ID.
`--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 IBM Software Hub  configuration location. For example, $HOME/.cpd-cli/config. Status Optional. Syntax `--cpd-config=<cpd-config-location>` Default value $HOME/.cpd-cli/config Valid values A valid IBM® Software Hub configuration location.
`--cpd-scope`	The IBM Software Hub 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 IBM Software Hub space, project, or catalog scope.
`--data-partitions`	The number of data partitions in the data source. Status Optional. Syntax `--data-partitions=<num-data-partitions>` Default value No default.
`--description`	Specify an attachment description. Status Optional. Syntax `--description=<description>` Default value No default. Valid values A valid attachment description.
`--help` `-h`	Display command help. Status Optional. Syntax `--help` Default value No default. Valid values Not applicable.
`--is-partitioned`	Whether the data source contains data partitions. Status Optional. Syntax `--is-partitioned=true\|false` Default value `false` Valid values `true\|false`
`--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.
`--mime`	Specify the file content mime  type. Status Optional. Syntax `--mime=<mime-type>` Default value Determined by the file content. Valid values A valid file content mime type.
`--name`	Specify the attachment name. Status Required. Syntax `--name=<attachment-name>` Default value No default. Valid values A valid attachment name.
`--object-key`	Specify the attachment object key. Status Optional. Syntax `--object-key=<object-key>` Default value No default. Valid values A valid attachment object key.
`--object-key-is-read-only`	When set to true, the attachment object key is read-only. Status Optional. Syntax `--object-key-is-read-only=true\|false` Default value `false` Valid values `false` The attachment key is not read-only. `true` The attachment key is read-only.
`--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 IBM Software Hub and your credentials for the instance. Status Required. Syntax `--profile=<profile-name>` Default value No default. Valid values The name of the profile that you created.
`--private-url`	Whether the URL that is specified by the `--url` option is private. Status Optional. Syntax `--private-url=true\|false` Default value `false` Valid values `true\|false`
`--project-id`	Specify an IBM Software Hub project instance. Status Optional. Syntax `--project-id=<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 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.
`--space-id`	Specify a space identifier. Status Optional. Syntax `--space-id=<space-identifier>` Default value No default. Valid values A valid space identifier.
`--url`	Specify the IBM Software Hub web URL. You can determine the IBM Software Hub web URL by running the 'oc get routes' command. You must add HTTPS protocol to the IBM Software Hub web URL (for example, 'https://<cpd-web-url>'). Status Optional. Syntax `--url=<cpd-web-url>` Default value No default. Valid values A valid profile URL.
`--user-data`	Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with an `@` symbol. For example, `--user-data=@path/to/file.json`. Status Optional. Syntax `--user-data=<user-data>` Default value No default.
`--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.

asset_id = <The asset GUID>
asset_type = <The asset type>
space_id = <The deployment space identifier>

Create an attachment. You must specify either project_id or space_id.

cpd-cli asset attachment create \
--asset-id=${asset_id} \
--asset-type=${asset_type} \
--project-id=zen \
--space-id=${space_id}