Skip to main content
Pure1 Support Portal

purehost-list

Name

purehost-list, purehost-listobj — display information about Purity host objects, host-volume connections, and storage provisioning and consumption.

Synopsis

purehost list [ --all | --chap | --connect | --personality | --protect | --space ] [ --cli | --csv | --nvp ] [--filter FILTER] [--limit LIMIT] [--notitle] [--page] [ --private | --shared ] [--raw] [--sort SORT] [HOST...]

purehost listobj [--csv] [ --type { host | iqn | vol | wwn } ] [HOST...]

Arguments

HOST

Host object for which the information specified by options is to be displayed.

Options

Options that control information displayed:

-h | --help

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

default (no content option specified with purehost list)

Displays associated worldwide names and host groups for the specified hosts.

--all (purehost list only)

Displays all visible attributes of the specified hosts. See DESCRIPTION section below for a list of attributes displayed.

--chap (purehost list only)

Displays CHAP authentication settings.

--connect (purehost list only)

Displays volumes connected to the specified hosts and the LUNs used to address them.

--personality (purehost list only)

Displays host personality settings.

--private (purehost list connect only)

Restricts the list or display of volumes connected to specified hosts to those with private connections. Invalid when combined with other options.

--protect (purehost list only)

Displays all protected hosts and their associated protection groups.

--shared (purehost list connect only)

Restricts the display of volumes connected to specified hosts to those with shared connections. Invalid when combined with other options.

--space (purehost list only)

Displays size and space consumption information for the volumes connected to each host.

--type (purehost listobj only)

Specifies the type of information about specified hosts that is to be produced in whitespace-separated format suitable for scripting.

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.

Options that manage display results:

--filter

Displays only the rows that meet the filter criteria specified.

--limit

Limits the size of the list output to the specified maxmimum number of rows.

--sort

Sorts the list output in ascending or descending order by the column specified.

Description

The purehost list command displays a list of hosts on the array. The list includes host attributes such as host group association, interface, connected volumes (both shared and private), provisioned size, and storage consumption.

The information to be displayed is specified by including one of the following options:

  • If no options are specified, displays names, associated worldwide names, and host groups for specified hosts.

  • If the --all option is specified, displays all visible attributes of the specified hosts. Display includes associated worldwide names, host groups, connected volumes and the LUNs used to address them, array port worldwide names through which the volumes are visible.

  • If the --chap option is specified, displays host and target usernames. Also indicates whether host and target passwords have been set.

  • If the --connect option is specified, displays volumes associated with the specified hosts, and the LUNs used to address them.

  • If the --personality option is specified, displays the personality setting associated with the specified hosts.

  • If the --protect option is specified, displays all protected hosts and their associated protection groups.

  • If the --space option is specified, the display lists the following size and space consumption information for the volumes connected to each host:

    Size

    Total provisioned size of all volumes connected to the host. Represents storage capacity reported to hosts.

    Thin Provisioning

    Percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

    Data Reduction

    Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings.

    For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules.

    Total Reduction

    Ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings.

    For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules.

    Volumes

    Physical space occupied by volume data that is not shared between volumes, excluding array metadata and snapshots.

    Snapshots

    Physical space occupied by data unique to one or more snapshots.

    Total

    Total physical space occupied by system, shared space, volume, and snapshot data.

By default, space consumption for all connected volumes, both private and shared, is displayed. The display can be restricted to volumes with private or shared connections by specifying the --private or the --shared option.

The purehost listobj command produces lists of certain attributes of specified hosts in either whitespace or comma-separated form, suitable for scripting. The command produces one of four types of lists:

--type host (default if --type option not specified)

List contains the specified host names. If no host names are specified, contains the names of all host objects.

--type iqn

List contains the IQNs associated with each specified host. If no hosts are specified, list contains all IQNs (administratively assigned and discovered) known to the array.

--type vol

List contains the volumes connected to the specified hosts. If no hosts are specified, list contains names of all volumes connected to any host. List can be restricted to show only private connections by specifying the --private option.

--type wwn

List contains the worldwide names associated with each specified host. If no hosts are specified, list contains all worldwide names (administratively assigned and discovered) known to the array.

Lists are whitespace-separated by default. Specify the --csv option to produce a comma-separated list.

App Hosts

App hosts are used to connect FlashArray volumes to Pure apps. If an app is installed on the array, its app host will appear in the purehost list output.

App host names begin with a distinctive @ symbol. The naming convention for app hosts is @APP, where APP denotes the app name.

The following example displays the app host for the linux app.

$ purehost list @linux*
Name    WWN  IQN  Host Group
@linux  -    -    -

Include the --connect option to display all of the volumes associated with the app host, and thereby connected to the app. In the following example, five FlashArray volumes, along with the linux boot and data volumes, are associated with the @linux app host, and thereby connected to the @linux app.

$ purehost list --connect @linux*
Name    LUN  Vol          Host Group
@linux  1    @linux_boot  -
@linux  2    @linux_data  -
@linux  3    app_vol001   -
@linux  4    app_vol002   -
@linux  5    app_vol003   -
@linux  6    app_vol004   -
@linux  7    app_vol005   -
        

For more information about Pure apps and the pureapp command, refer to pureapp(1).

Exceptions

None.

Examples

Example 1

purehost list
      

Displays names, associated worldwide names, and associated host groups (if any) for all hosts.

Example 2

purehost list --connect
      

Displays names, connected volumes and logical units for all hosts. Both private and shared volume connections are displayed.

Example 3

purehost list --space --private --csv --notitle HOST1 HOST2 HOST3
      

Displays the above mentioned virtual and physical space consumption for volumes associated with each of HOST1, HOST2, and HOST3.

Example 4

purevol list --space $(purehost listobj --type vol HOST1 HOST2)
      

The inner purehost listobj command produces a whitespace-separated list of the volumes connected to HOST1 and HOST2. The outer purevol list command displays space consumption for the volumes specified in the inner command.

Example 5

purehost listobj --type vol --private HOST1 HOST2
      

Lists all volumes with private connections to HOST1 and HOST2.

Example 6

purevol list --connect --private $(purehost listobj --type vol HOST1)
      

The inner purehost listobj command produces a list of the volumes to which HOST1 is connected. The list is input to the purevol list command to display all hosts with private connections to those volumes.

Example 7

purehost list --connect @linux
      

Displays the names of all volumes associated with app host linux, and thereby connected to the linux app.

Author

Pure Storage Inc.