alert command

Purpose

Sets, removes, and lists all the alerts for a cluster and storage pool.

Syntax

To set the alert:

alert -set [-clustername ClusterName] [-sp StoragePool] [-tier TierName] [-type {threshold | overcommit}] -value Value

To unset the alert:

alert -unset [-clustername ClusterName] [-sp StoragePool] [-tier TierName] [-type {threshold | overcommit}]

To list all the alerts:

alert -list [-clustername ClusterName] [-sp StoragePool] [-tier TierName] [-type {threshold | overcommit} | -field FieldName ...] [-fmt Delimiter [-header]]

Description

The alert command sets, removes, and lists all alerts for a cluster and storage pool. In a multi tier environment, alerts can be set on each individual tier. If the -type flag is included, this command performs the action based on the specified type of alert. The value of the -type flag can be either threshold for free space or overcommit for the overcommit space. On set or unset operations, the default value for the -type flag is threshold. If the -type flag is not specified, all the alerts are listed. The -value flag is specified in percentages.

Flags

Flag name	Description
-clustername	Specifies the cluster name.
-field	Specifies a list of fields to be displayed.
-fmt	Separates the output with a user-specified delimiter character.
-header	Specifies the display field names in the formatted listing output.
-list	Lists alerts.
-set	Sets an alert.
-sp	Specifies the storage pool name.
-tier	Specifies the tier name.
-type	Specifies the type of alert. The type of alert is either threshold for pool free space or overcommit for pool overcommit space. For set or unset operations, the default value is threshold. If the type of alert is not specified when you perform the list operation, all the alerts are listed.
-unset	Removes an alert.
-value	Specifies the value of the alert in percentage.

Examples

To list alerts within the storage pool, type the following command:

alert -list

The system displays the following output:

PoolName:sp
PoolId:00000000097E587C0000000055B09F9A
TierName:SYSTEM
ThresholdPercent:35
OverCommitPercent:N/A

PoolName:sp
PoolId:00000000097E587C0000000055B09F9A
TierName:prod_tier
ThresholdPercent:35
OverCommitPercent:N/A

To set an alert on free space within the storage pool, type the following command:
```
alert -set -type threshold -value 70
```
To set an alert on overcommit space within the storage pool, type the following command:
```
alert -set -type overcommit -value 20
```
To set an alert on free space for a tier within the storage pool, type the following command:
```
alert -set -tier prod_tier -type threshold -value 90
```
To set an alert on overcommit space for a tier within the storage pool, type the following command:
```
alert -set -tier prod_tier -type overcommit -value 20
```

To see updated alert values, type the following command:

alert -list -tier prod_tier

The system displays the following output:

PoolName:sp
PoolId:00000000097E587C0000000055B09F9A
TierName:prod_tier
ThresholdPercent:90
OverCommitPercent:20

To list specific fields of the alerts, type the following command:
```
alert -list -field ThresholdPercent
```
The system displays the following output:
```
ThresholdPercent: 70

ThresholdPercent: 90
```

Last updated: Wed, November 18, 2020