guardicore-set-asset-description-batch
Set the free text description of the assets from input records. This is the note shown in the Comments box of the console asset detail. Input records must contain the guid (string, asset UUID) and description (string) fields. An empty description clears the note.
guardicore-set-asset-description-batch profile=VALUE [description=VALUE] [asset-guid-field=VALUE] [description-field=VALUE] [batch=VALUE]
- profile=VALUE
- Required. The identifier of Akamai Guardicore connect profile.
- description=VALUE
- Optional. Fixed description for every record. Read from description-field when omitted.
- asset-guid-field=VALUE
- Optional. Input field holding the asset UUID. Default: guid.
- description-field=VALUE
- Optional. Input field holding the description. Default: description.
- batch=VALUE
- Optional. Rows buffered before each API call, 1 to 1000. Default: 1, which sends each row on its own so a failure is reported per row.
Output Fields
| Field | Type | Name | Description |
|---|---|---|---|
| profile | String | Connect profile | The identifier of Akamai Guardicore connect profile |
| _result | String | Result | e.g. success, fail, skip |
| _error | String | Error | Reason when the result is fail or skip |