Indicates a request to change the password for the pureuser administrative account. Elicits a prompt for the "old" (current) password. If the current password is entered correctly, elicits two prompts for the new password (entry and confirmation).
Example 2
pureadmin setattr --publickey
Indicates a request to change the public key for the workstation account from which the session is being conducted. Elicits a prompt for a new public key, which would typically be copied from a key generation tool running in a local window on the administrative workstation.
See Also
n/a
Author
Pure Storage Inc. <[email protected]>
Name
purealert, purealert-create, purealert-delete, 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 ADDRESS...
purealert delete --alert ALERT-ID...
purealert disable ADDRESS...
purealert enable ADDRESS...
purealert list [--cli] [ --csv | --nvp ] [--notitle] [ --address | --alert ] [ADDRESS...]
purealert listobj [--csv] [--type address] [ADDRESS...]
purealert test [ADDRESS...]
Arguments
ADDRESS
Any valid electronic mail address.
ALERT-ID
Unique number that identifies an alert. Displayed in the first column of output form the purealert list --alert subcommand.
Options
-h | --help
Can be used with any command or subcommand to display a brief syntax description.
--address
Displays state information for specified email addresses (purealert list) or deletes specified email addresses from the list of those designated to receive alert email messages (purealert delete).
--alert
Displays information about alerts (purealert list) or deletes specified alerts from displayed history (purealert delete).
--type {address} (purealert listobj)
Outputs a whitespace-separated list containing the specified email addresses. If no addresses are spec-ified, contains all addresses designated to receive alert messages, whether enabled or not.
--type (purealert list)
Type of information to be displayed (alert history or designated recipients for email alert messages).
If not specified, defaults to designated email recipients.
purealert
--cli
Displays specified information in the form of CLI commands that could be issued to assign the current values to the specified attributes. Not meaningful when combined with non-settable attributes.
--csv
Lists information in comma-separated value format. This format is designed for importation into spreadsheets and for scripting.
--notitle
Suppresses generation of an initial line of output containing column titles.
--nvp
Lists each argument's name and specified information items, one to a line, in the form ITEM-NAME=VALUE. Argument names and information items are displayed flush left. This format is de-signed both for convenient viewing of what might otherwise be wide listings, and for parsing individ-ual items separated by whitespace for insertion into scripts.
Description
Purity generates log records called alerts when significant events occur within an array.
The purealert list --alert subcommand displays a history of the alerts generated by Purity. Each alert is numbered with an ALERT-ID, which is displayed in the first column of purealert list --alert output.
The purealert delete --alert subcommand deletes alerts from the history as they are dealt with or their impact is understood.
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 Puri-ty alert messages. Up to 20 addresses can be designated in an array (19 in addition to the built-in [email protected]). The purealert delete --address subcommand removes email addresses from the designated list.
FlashArray systems are delivered with the address [email protected] 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 com-ma-separated (--csv specified) lists of designated email addresses for scripting. If no addresses are spec-ified, 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 [email protected].
purealert
When sending alerts to a designated email address is no longer appropriate, the purealert delete subcom-mand 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 subcom-mands 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 [email protected]
# verify at the destination that mail was received successfully purealert create [email protected]
purealert test
Sends a test message to [email protected]. After receipt of the message at the destination has ben verified by external means, designates [email protected] to receive Purity alert messages. The sec-ond purealert test subcommand sends test messages to all designated addresses, whether they are enabled or disabled.
Example 2
purealert disable [email protected] purevol connect --host HOST1 VOL1 VOL2 purealert enable [email protected]
Inhibits Purity from sending alert messages to [email protected], 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 [email protected] account after the connections are established, so that the account receives subsequent alert messages.
Example 3
purealert list --alert
# view output alert history
purealert delete --alert 135 136 137 138
Displays the history of alerts generated by the array. After the display is viewed, deletes alerts with the IDs 135, 136, 137, and 138.
See Also
purearray(1)
purealert
Author
Pure Storage Inc. <[email protected]>
Name
purearray, purearray-list, purearray-monitor, purearray-rename, purearray-setattr — manages attributes that pertain to the array as a whole
purearray-disable, purearray-enable, purearray-logiostat, purearray-phonehome, purearray-remoteassist
— manages support-related functions
purearray-diagnose, purearray-test — performs array diagnostic functions
Synopsis
purearray diagnose [ --email | --log | --phonehome ] purearray disable {phonehome}
purearray enable {phonehome}
purearray list [ --banner | --controller | --ntpserver | --phonehome | --proxy | --relayhost | --senderdomain
| --space ] [--cli] [ --csv | --nvp ] [--notitle]
purearray logiostat [ --status | --stop ] [--interval SECONDS] [--nrep REPEAT-COUNT]
purearray monitor [--csv] [ --historical { 1h | 3h | 24h | 7d | 30d | 90d | 1y } | [--interval SECONDS] [--nrep REPEAT-COUNT] [--size] ] [--notitle]
purearray phonehome { --cancel | --sendall | --sendtoday | --sendyesterday | --status } purearray remoteassist { --connect | --disconnect | --status }
purearray rename NEW-NAME
purearray setattr { --banner | --ntpserver NTP-SERVER | --proxy HTTPS-PROXY | --relayhost RE-LAY-HOST | --senderdomain SENDER-DOMAIN }
purearray test {phonehome}
Options
--cancel
Cancels any in-progress transmission of event logs to Pure Storage Technical Support.
--connect
Enables Pure Storage Technical Support to initiate a remoteassist session.
--controller
Displays the current mode of the array's controllers (primary, secondary, or not present for controllers that are powered off). For arrays to which a second controller has never been connected, only a single controller mode is displayed. Once a second controller has been connected, two controllers' modes are always shown.
--csv
Lists information in comma-separated value format. This format is designed for importation into spreadsheets and for scripting.
--disconnect
Terminates an in-progress remoteassist session with Pure Storage Technical Support.
purearray
Sends subcommand output to addresses that are designated and enabled to receive email alerts.
-h | --help
Can be used with any command or subcommand to display a brief syntax description.
--historical {1h, 3h, 24h, 7d, 30d, 90d, 1y}
Display historical performance data at the specified resolution.
--interval SECONDS
Sets the interval (in seconds) to log I/O statistics or performance data. If omitted, the interval defaults to once every second for purearray logiostat or every 5 seconds for purearray monitor.
--log
Sends subcommand output to the array's log.
--notitle
Suppresses generation of an initial line of output containing column titles.
--nvp
Lists each argument's name and specified information items, one to a line, in the form ITEM-NAME=VALUE. Argument names and information items are displayed flush left. This format is de-signed both for convenient viewing of what might otherwise be wide listings, and for parsing individ-ual items separated by whitespace for insertion into scripts.
--nrep REPEAT-COUNT
Sets the number of times to log I/O statistics or performance data. For purearray logiostat, if omit-ted, logging continues until it is explicitly stopped with purearray logiostat --stop. For purearray monitor, if omitted, --nrep defaults to 1.
--banner
Displays or sets the content to be displayed during login.
--ntpserver [NTP-SERVER]
Displays or sets the hostnames or IP addresses of the NTP servers currently being used by the array to maintain reference time. Up to four NTP servers may be specified in the purearray setattr sub-command.
--phonehome
For purearray diagnose, sends subcommand output to Pure Storage Technical Support via the phone-home channel. For purevol list, displays the current state of the Purity phonephone-home automatic hourly log transmission facility (enabled or disabled).
--proxy [HTTPS-PROXY]
Displays or sets the proxy host for the phonehome facility when https is the phonehome protocol (the phonehome facility itself determines which protocol to use) The format for the option value in the purearray setattr subcommand is: HTTPS://HOSTNAME:PORT, where, HOSTNAME is the name of the proxy host, and PORT is the TCP/IP port number used by the proxy host.
--relayhost [RELAY-HOST]
Displays or sets the hostname or IP address of the electronic mail relay server currently being used as a forwarding point for email alerts generated by the array.
--sendall
Sends all log information stored in the array to Pure Storage Technical Support via the phonehome channel.
purearray
--senderdomain [SENDER-DOMAIN]
Displays or sets the domain name from which Purity sends email alert messages.
--sendtoday
Sends log information from the current day (in the array's time zone) to Pure Storage Technical Sup-port via the phonehome channel.
--sendyesterday
Sends log information from the previous day (in the array's time zone) to Pure Storage Technical Support via the phonehome channel.
--size
Displays the average I/O sizes per operation (read, write, and total).
--space
Displays amount of physical storage connected to the array and amount occupied by data.
--status
purearray logiostat --status displays the status of I/O statistics logging.
purearray remoteassist --status displays the status of in-progress log transmission jobs or remote assist session.
--stop
Stops logging I/O statistics.
Description
The purearray diagnose subcommand executes a series of CLI subcommands that capture a snapshot of an array's I/O performance, configuration, and hardware status. By default, the output is sent to the console; this can be changed with one of the following options:
Mail the output to all enabled alert message recipients.
--log
Write the output to the array's log.
--phonehome
Transmit the output to Pure Storage Technical Support via the secure channel.
The purearray enable phonehome and purearray disable phonehome commands respectively, enable and disable automatic hourly transmission of array logs to Pure Storage Technical Support.
The purearray list command with no option specified displays an array's name and the Purity version and revision numbers. Options can be specified to display controller name(s) and states, the NTP (Network Time Protocol) server name, the state of and proxy host for the phonehome facility, the relay host via which electronic mail is sent, and the sender domain for electronic mail alert messages.
The purearray list --space command displays physical storage capacity, both total configured and occu-pied by data.
The purearray logiostat command starts and stops logging of I/O statistics. By default, this feature is turned off. When it is turned on, I/O statistics are logged (at specified interval and number of repetitions;
these logs are periodically sent to Pure Storage Technical Support (see purearray phonehome.
purearray
The purearray monitor command can be used to display instantaneous performance data. The purearray monitor --historical command can be used to display historical performance data at one of the following resolutions: 1 hour, 3 hours, 24 hours, 7 days, 30 days, 90 days, or 1 year. These commands can used with the --csv and --notitle options to export historical data.
The purearray phonehome subcommand initiates immediate transmission of event logs stored in an array to Pure Storage support. Options determine whether the current day, previous day, or all log information in the array are transmitted. Only one transmission may be in progress at any instant. A transmission in progress can be cancelled by specifying the --cancel option in the subcommand. The phonehome facility automatically selects either the ssh or the https protocol for communicating with Pure Storage support. If a proxy host is required by https, use the purearray setattr --proxy command to specify its hostname and port. Specify the full URL string as described in the OPTIONS section above.
Purity can transmit an array's log contents to Pure Storage Technical Support (a) automatically once per hour, or (b) on demand. Pure Storage Technical Support stores log contents for immediate or later analysis.
On-demand log transmission may be complete (--sendall option) or selective (--sendtoday or --sendyes-terday options). On-demand transmissions may be status-checked (--status option) or cancelled (--cancel option).
Purity can collect samples of hardware status, monitored performance, and array configuration on demand, and either (a) mail them to enabled alert recipients, (b) write them into the array's log, or (c) transmit them immediately to Pure Storage Technical Support for analysis.
The purearray remoteassist subcommand enables or terminates a detached remote assistance session with Pure Storage Technical Support. When the purearray remoteassist --connect command enables a session, a port ID is displayed. The administrator relays this ID to a Pure Storage Technical Support representative, usually by phone, to enable the technician to connect to the array and perform diagnostic functions. The administrative session from which the purearray remoteassist --connect command is is-sued is unaffected, and can terminate the session at any time via the purearray remoteassist --disconnect subcommand.
One remote assistance session can be active at a time; executing the purearray remoteassist --connect command while a session is active results in an error message. The purearray remoteassist --status command displays remote assistance status (capability disabled, capability enabled, or session active).
An array's name can be changed by the purearray rename command. Other attributes can be changed by options in the purearray setattr command. To set a null value, use an empty string ("").
Purity can test certain array functionality on demand. The purearray test phonehome command tests an array's ability to communicate with Pure Storage Technical Support by establishing a secure shell or secure http connection and verifying that test messages can be exchanged.