Skip to main content
Pure1 Support Portal

purealert

Name

purealert, purealert-create, purealert-delete, purealert-disable, purealert-enable, purealert-list, purealert-listobj, purealert-test — manages alert history and the list of designated email addresses to which Purity sends alert messages when significant events occur in an array

Synopsis

purealert create ADDRESS...

purealert delete ADDRESS...

purealert disable ADDRESS...

purealert enable ADDRESS...

purealert list [ --cli | --csv | --nvp ] [--notitle] [--page] [--raw] [ADDRESS...]

purealert listobj [--csv] [--type address] [ADDRESS...]

purealert test [ADDRESS...]

Arguments

ADDRESS

Any valid electronic mail address.

Options

-h | --help

Can be used with any command or subcommand to display a brief syntax description.

--type {address} (purealert listobj)

Outputs a whitespace-separated list containing the specified email addresses. If no addresses are specified, contains all addresses designated to receive alert messages, whether enabled or not.

--type (purealert list)

Type of information to be displayed. If not specified, defaults to designated email recipients.

Options that control display format:

--cli

Displays output in the form of CLI commands that can be issued to reproduce the current configuration. The --cli output is not meaningful when combined with immutable attributes.

--csv

Lists information in comma-separated value (CSV) format. The --csv output can be used for scripting purposes and imported into spreadsheet programs.

--notitle

Lists information without column titles.

--nvp

Lists information in name-value pair (NVP) format, in the form ITEMNAME=VALUE. Argument names and information items are displayed flush left. The --nvp output is designed both for convenient viewing of what might otherwise be wide listings, and for parsing individual items for scripting purposes.

--page

Turns on interactive paging.

--raw

Displays the unformatted version of column titles and data. For example, in the purearray monitor output, the unformatted version of column title us/op (read) is usec_per_read_op. The --raw output is used to sort and filter list results.

Description

Purity generates log records called alerts when significant events occur within an array. Administrators can designate electronic mail addresses to which Purity will send electronic mail messages when alert-generating events occur.

The purealert create subcommand can designate any valid electronic mail address to receive Purity alert messages. Up to 20 addresses can be designated in an array (19 in addition to the built-in flasharray-alerts@purestorage.com). The purealert delete subcommand removes email addresses from the designated list.

FlashArray systems are delivered with the address flasharray-alerts@purestorage.com pre-designated to receive alerts. This address can be disabled (see below), temporarily suspending the transmission of alert messages to Pure Storage Technical Support, but cannot be deleted.

The purealert test subcommand tests an array's ability to send email to any email address (designated or not). If no email address arguments are specified, test messages are sent to all designated addresses. Verification of successful test message transmission is done at the destination. The only console response to the purealert test subcommand is the next Purity prompt.

The purealert list subcommand lists any or all designated email addresses and their states (enabled or disabled).

The purealert listobj subcommand creates whitespace-separated (no formatting option specified) or comma-separated (--csv specified) lists of designated email addresses for scripting. If no addresses are specified, produces a list of all designated addresses. The same output list is produced whether or not the --type address option is specified.

The purealert enable and purealert disable subcommands respectively enable and disable the sending of alert messages to one or more designated email addresses. They do not send alert messages themselves. If no email address arguments are specified, the subcommands enable and disable the sending of alert messages to all designated addresses, including the built-in flasharray-alerts@purestorage.com.

When sending alerts to a designated email address is no longer appropriate, the purealert delete subcommand removes it from the list of designated addresses.

The sending account name for Purity email alert messages is the array name. This name and the sender domain for alert messages can be viewed and altered by the purearray list and purearray setattr subcommands respectively.

The purealert list --cli subcommand displays the CLI command line that would produce the array's current list of designated email addresses in their current states. This list can, for example, be copied and pasted to create an identical email alert configuration in another array, or saved as a backup.

Examples

Example 1

purealert test admin1@mydomain.com
# verify at the destination that mail was received successfully
purealert create admin1@mydomain.com
purealert test
      

Sends a test message to admin1@mydomain.com. After receipt of the message at the destination has been verified by external means, designates admin1@mydomain.com to receive Purity alert messages. The second purealert test subcommand sends test messages to all designated addresses, whether they are enabled or disabled.

Example 2

purealert disable admin2@mydomain.com
purevol connect --host HOST1 VOL1 VOL2
purealert enable admin2@mydomain.com
      

Inhibits Purity from sending alert messages to admin2@mydomain.com, so that the account does not receive the messages generated when the private connections between HOST1 and VOL1 and HOST1 and VOL2 are established. Re-enables sending to the admin2@mydomain.com account after the connections are established, so that the account receives subsequent alert messages.

Author

Pure Storage Inc.