Skip to main content
Pure1 Support Portal

purehgroup-list

Name

purehgroup-list, purehgroup-listobj — display host groups' attributes and storage consumption

Synopsis

purehgroup list [ --cli | --csv | --nvp ] [ --connect | --protect | --space ] [--filter FILTER] [--limit LIMIT] [--notitle] [--page] [--raw] [--sort SORT] [HGROUP...]

purehgroup listobj [--csv] [ --type { hgroup | host | vol } ] [HGROUP...]

Arguments

HGROUP

Host group 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 in purehgroup list command)

Displays names and associated hosts for the specified host groups.

--connect (purehgroup list only)

Displays volumes associated with the specified host groups, and the LUNs used to address them.

--protect (purehgroup list only)

Displays all protected host groups and their associated protection groups.

--space (purehgroup list only)

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

--type (purehgroup listobj only)

Specifies the type of information about the specified host groups 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 purehgroup list command displays the information indicated by content options for the specified host groups. If no host groups are specified, the display includes the specified information for all host groups.

  • If no options are specified, the display lists the hosts associated with each specified host group.

  • If the --connect option is specified, the display lists volumes associated with the specified host groups, and the LUNs used to address them.

  • If the --protect option is specified, the display lists all protected host groups 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 group:

    Size

    Total provisioned size of all volumes connected to the host group. 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.

The purehgroup listobj command creates lists of certain attributes of specified host groups in either whitespace or comma-separated form, suitable for scripting. The command produces one of three types of lists:

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

Produces a list of the specified host group names. If no host group names are specified, the list contains the names of all host groups.

--type host

Produces a list of hosts associated with the specified host groups. If no host groups are specified, the list contains names of all hosts associated with host groups.

--type vol

Produces a list of volumes associated with the specified host groups. If no host group argument is specified, the list contains all volumes that are associated with any host group.

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

Exceptions

None.

Examples

Example 1

purehgroup list --connect
      

For all host groups, displays names of associated volumes, and the logical units used by associated hosts to address them.

Example 2

purehgroup list
      

Displays the names of all host groups and the volumes associated with them.

Example 3

purehgroup list --space --csv HGROUP1 HGROUP2 HGROUP3
      

Displays the abovementioned virtual and physical space consumption for volumes associated with each of HGROUP1, HGROUP2, and HGROUP3.

Example 4

purehgroup list --connect $(purevol listobj --type hgroup VOL1)
      

The inner purehgroup listobj command produces a list of all host groups with which VOL1 is associated. This list is input to the outer purehgroup list command to display a list of all volumes associated with host groups with which VOL1 has an association.

Example 5

purevol list --space --total $(purehgroup listobj --type vol HGROUP1)
      

The inner purehgroup listobj command produces a list of the volumes associated with HGROUP1. This list is input to the outer purevol list command to display the space occupied by each of these volumes, as well as the total space occupied by all volumes associated with HGROUP1.

Author

Pure Storage Inc.