Terse descriptions of commands, subcommands, and the effect of options are embedded in the CLI itself.
These can be displayed by typing:
COMMAND -h for commands, or
COMMAND SUBCOMMAND -h
for subcommands.
More extensive CLI help is available in these man pages in the form of a man page for each CLI command and subcommand. Man page help on commands is displayed by entering:
pureman COMMAND
or
pureman COMMAND-SUBCOMMAND
The command-level man pages are listed in the SEE ALSO section below. Individual subcommand man pages are listed in the commands' pages.
Related subcommands that act on the same object type (e.g., purevol create, purevol destroy, purevol eradicate, purevol recover) are described on the same man page.
Similarly, certain subcommands can be executed on different object types (e.g., purevol connect and purehost connect). These are described on the same man page.
Examples
See individual subcommand pages.
See Also
pureadmin(1), purealert(1), purearray(1), pureconfig(1), puredns(1), puredrive(1), pureds(1), pure-hgroup(1), purehost(1), purehw(1), purelicense(7), puremonitor(1), purenetwork(1), pureport(1), puresn-mp(1), purevol(1)
purecli
Author
Pure Storage Inc. <[email protected]>
Name
pureconfig — displays commands required to reproduce an array's current volume, host, host group, con-nection, network, alert, and array configuration
Synopsis
pureconfig list
Options
None
Description
Displays an array's current configuration of volumes, hosts, shared and private connections, administrative network parameters, alert email addresses, and array parameters in the form of CLI commands that would be required to reproduce the configuration on a newly-installed or otherwise unconfigured array. (The output does not contain delete or destroy subcommands).
The output of this command can be captured on the administrative workstation and used as a script to configure a previously unconfigured array identically to the array on which the command is executed.
Executing the pureconfig list command is roughly equivalent to executing the following commands in sequence:
purevol list --cli purehost list --cli purehgroup list --cli
purehost list --connect --cli purehgroup list --connect --cli purenetwork list --cli
purealert list --cli purearray list --cli
See Also
purealert(1), purearray(1), purehgroup-list(1), purehost-list(1), purenetwork(1), purevol-list(1)
Author
Pure Storage Inc. <[email protected]>
Name
puredns — manages an array's DNS attributes
Synopsis
puredns list [ --cli | --csv | --nvp ] [--notitle]
puredns setattr [--domain DOMAIN-NAME] [--nameserver DNS-SERVER-IP-ADDRESS-LIST]
Options
-h | --help
Can be used with any command or subcommand to display a brief syntax description.
--domain
Domain suffix to be appended by the array when doing DNS lookups.
--nameserver
A comma-separated list of up to three DNS server IP addresses. The order of the list is significant.
Purity queries DNS servers in the order in which their IP addresses are listed in this option.
--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
Manages DNS attributes for an array's administrative network. Displays and sets DNS parameters (DNS server addresses and the domain suffix for searches). The --domain option sets the domain suffix to be appended to DNS queries. For example,
puredns --domain mydomain.com --nameserver 192.168.0.25
specifies the IP address of the (single) DNS server and causes queries for IP addresses to be satisfied either by the specified hostname or by hostname.mydomain.com.
The list of DNS name server IP addresses specified in the --nameserver option replaces the list of name servers in effect prior to command execution.
puredns
The puredns list --cli command displays the CLI command line that would reproduces the array's current DNS configuration. This can, for example, be copied and pasted to create an identical DNS configuration in another array, or saved as a backup.
Examples
Example 1
puredns --domain mydomain.com --nameserver 192.168.0.125,192.168.2.125
Specifies the IP addresses of two DNS servers for Purity to use to resolve hostnames to IP addresses, and the domain suffix mydomain.com for DNS searches.
Example 2
puredns --domain ''
Removes the domain suffix from Purity DNS queries.
Example 3
puredns --nameserver 0.0.0.0
Unassigns DNS server IP addresses (Purity ceases to make DNS queries).
See Also
purearray(1), purenetwork(1)
Author
Pure Storage Inc. <[email protected]>
Name
puredrive — displays information about an array's solid-state drives and NVRAM modules
Synopsis
puredrive list [ --csv | --nvp ] [--notitle] [--total] [DRIVE...]
Arguments
DRIVE
Name of a drive about which information is to be displayed. Includes shelf identifier (e.g., SH0.DRV0 designates the drive in bay #0 of storage shelf #0, which is an NVRAM module).
Options
-h | --help
Can be used with any command or subcommand to display a brief syntax description.
--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.
--total
Follows output lines with a single line containing column totals in columns where they are meaningful.
Ignored when --nvp is specified (where permitted).
Description
Lists information about some or all of an array's solid-state drives (SSDs--used for persistent storage of user data) and NVRAM modules (used as non-volatile write cache). If no drives are specified, lists information about all of an array's SSDs and NVRAM modules.
The information listed for each specified drive includes:
Name
Name by which Purity identifies the drive in administrative operations. Drive names identify physical locations in terms of shelf and bay numbers.
From Bay
Location (in drive name format, indicating shelf and bay) at which a missing drive was installed prior to failure. This column is included in the output display only when there are missing drives for which evacuation has not completed, and contains values only for drives with a status of missing.
Type
SSD (data storage) or NVRAM (write cache).
puredrive
Status
One of the following:
healthy
Drive is functioning and belongs to the array foreign
Drive is a functioning FlashArray drive, but does not belong to the array reachable
Drive is functioning, but is not initialized as a FlashArray drive failed
Drive may be installed, but does not respond to I/O commands missing
Drive is a failed FlashArray drive that has been removed from its bay and whose contents have not yet been completely evacuated. The Name column is blank, and the Last Bay column indicates the shelf and bay in which the missing drive was formerly installed.
Capacity
Physical storage capacity of the drive.
Evac Remaining
For a missing drive, the amount of data that remains to be evacuated (reconstructed and stored on other drives).
Last Failure
Time at which a drive became non-responsive.
Last Evac Completed
Time at evacuation of data from a non-responsive drive completed.
The puredrive list output display shows information both for drives that are physically present in an array's storage shelves, and for missing drives whose data is being evacuated (reconstructed and stored at other locations within the array). Physically present drives are indicated by non-null values in the Name column of the display that indicate their locations. Missing drives are indicated by empty Name column entries, and non-null values indicating their former locations in the From Bay column. Missing drives are indicated in the display only as long as evacuation of their data is in progress.
Examples
Example 1
puredrive list sh0.drv0
Lists the abovementioned information about drive DRV0 in shelf SH0.
See Also
n/a
puredrive
Author
Pure Storage Inc. <[email protected]>
Name
pureds, pureds-disable, pureds-enable, pureds-list, pureds-setattr, pureds-test — manages FlashArray in-tegration with a directory service
Synopsis
pureds disable [--checkpeer]
pureds enable [--checkpeer]
pureds list [[--cli] | [--csv] | [--nvp] | [--notitle]] [--groups] [--certificate]
pureds setattr [--admingroup ADMIN-GROUP] [--basedn BASE-DN] [--bindpw] [--binduser BIND-USER] [--certificate] [--auto-fetch] [--groupbase groupbase] [--readonlygroup READONLY-GROUP]
[--uri URI-LIST] [--usergroup USER-GROUP]
pureds test
Options
-h | --help
Can be used with any command or subcommand to display a brief syntax description.
--admingroup ADMIN-GROUP
Common Name (CN) of the directory service group containing users with administrative privileges when managing the FlashArray. The name should be just the Common Name of the group without the "CN=" specifier. Common Names should not exceed 64 characters in length.
--basedn BASE-DN
The base of the Distinguished Name (DN) of the directory service groups. The base should consist of only Domain Components (DCs). This field will populate with a default value when a URI is entered by parsing domain components from the URI. The base DN should specify "DC=" for each domain component and multiple DCs should be separated by commas.
--bindpw
Displays a prompt from which the password of the binduser account is entered interactively.
--binduser BIND-USER
Username - often referred to as sAMAccountName or User Logon Name - that can be used to bind to and query the directory. sAMAccountNames must not contain the characters:
" [ ] : ; | = + * ? < > / \ , and should be not exceed 20 characters in length.
--certificate
Displays a prompt from which PEM formatted (base64 encoded) CA certificate data is entered inter-actively. This data should include the "---BEGIN CERTIFICATE---" and "---END CERTIFI-CATE---" lines and should not exceed 3000 total characters. The certificate can be cleared by en-tering blank lines at the prompt.
--checkpeer
Used with pureds enable or pureds disable, the checkpeer option toggles server authenticity en-forcement with the configured CA certificate. Therefore, this option can only be enabled if certificate data has been provided. If this option is enabled and certificate data is cleared, it will revert back to disabled.
pureds
--auto-fetch
Attempts to get CA certificate data from the configured URI or the first URI in the list if more than one URI is configured. This option is only used with the --certificate option.
--groupbase GROUP-BASE
Specifies where the configured groups are located in the directory tree. This field consists of Orga-nizational Units (OUs) that combine with the base DN attribute and the configured group CNs to complete the full Distinguished Name of the groups. The group base should specify "OU=" for each OU and multiple OUs should be separated by commas. The order of OUs is important and should get larger in scope from left to right. Each OU should not exceed 64 characters in length.
--readonlygroup READONLY-GROUP
Common Name (CN) of the configured directory service group containing users with read-only privi-leges on the FlashArray. This name should be just the Common Name of the group without the "CN="
specifier. Common Names should not exceed 64 characters in length.
--uri URI-LIST
A comma separated list of up to 30 URIs of the directory servers. These must be full URIs including the scheme: ldap:// or ldaps://. The domain names should be resolvable by configured DNS servers (see puredns(1)).
If the scheme of the URIs is ldaps://, SSL is enabled. SSL is either enabled or disabled globally, so the scheme of all supplied URIs must be the same. They must also all have the same domain. If base DN is not configured and a URI is provided, the base DN will automatically default to the Domain Components of the URIs.
Standard ports are assumed (389 for ldap, 636 for ldaps). Non-standard ports can be specified in the URI if they are in use.
--usergroup USER-GROUP
Common Name (CN) of the configured directory service group containing users with generic privi-leges on the FlashArray. This name should be just the Common Name of the group without the "CN="
specifier. Common Names should not exceed 64 characters in length.
--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.
--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.
--notitle
Suppresses generation of an initial line of output containing column titles.
Description
FlashArrays can integrate with an existing directory service to allow multiple users to log in and use the array and to provide role-based access control. Integrating with an existing directory service, such as
pureds
Microsoft Active Directory, leverages the directory to maintain credentials, group/password policy and handle authentication.