This new release of the Pure Storage PowerShell SDK provides easier access to IO and Space reporting metrics. For those customers that are interested in creating reports this is must upgrade. In previous releases gaining access to the IO and Space metrics proved to be a bit challenging and with this release we are providing Totals, Averages and ByTimeRange for easier access to the data. The updates for REST 1.5, 1.6 and 1.7 regarding IO and Space metrics is listed below.

PowerShell Cmdlet Additions

The following cmdlets have been added since the last release to support REST 1.5

  • Update-PfaArrayConnectionsThrottlingInformation
  • Get-PfaArrayConnectionsThrottlingInformation
  • Get-PfaAllHostIOMetrics
  • Get-PfaHostIOMetrics
  • Get-PfaAllHostGroupIOMetrics
  • Get-PfaHostGroupIOMetrics


The following cmdlets have been added since the last release to support REST 1.6

  • Get-PfaArraySpaceMetricsByTimeRange
  • Get-PfaAllVolumeSpaceMetricsByTimeRange
  • Get-PfaVolumeSpaceMetricsByTimeRange


The following cmdlets have been added since the last release to support REST 1.7

  • Get-PfaArrayIOMetricsAverage
  • Get-PfaAllHostIOMetricsTotal
  • Get-PfaAllHostIOMetricsAverage
  • Get-PfaHostIOMetricsAverage
  • Get-PfaAllHostGroupIOMetricsTotal
  • Get-PfaAllHostGroupIOMetricsAverage
  • Get-PfaHostGroupIOMetricsAverage
  • Get-PfaAllVolumeIOMetricsAverage
  • Get-PfaAllVolumeIOMetricsTotal
  • Get-PfaVolumeIOMetricsAverage


In addition to introducing the IO and Space metric cmdlets we have created a New-PfaCLICommand cmdlet. This cmdlet can be used to pass any Purity CLI command to an EndPoint (aka FlashArray). Here is an example of how to use the cmdlet:

We implemented this cmdlet to ensure customers and partners have access to commands that may have either not made it into the REST API or the SDK.

Other Additions & Changes to SDK

  • Get-PfaVolumeIOMetricsByTimeRange — Old name was Get-PfaVolumeIOMetrics.
  • Get-PfaProtectionGroupSchedules
  • Get-PfaSourceProtectionGroupSchedules
  • Set-PfaDirectoryServiceStatus — Enable/disable Active Directory integration.
  • Set-PfaDirectoryServiceAuthenticationStatus — Enable/disable server authenticity enforcement using configured CA certificate.
  • Set-PfaDirectoryServiceGroupBase  — Set base OU for ArrayAdmin/StorageAdmin/Readonly security groups.
  • Removed CheckPeer and Enabled switch parameters from Set-PfaDirectoryServiceConfiguration – the functionality is provided by new cmdlets Set-PfaDirectoryServviceAuthenticationStatus and Set-PfaDirectoryServiceStatus.
  • In 1.5 version of the SDK, Get-PfaVolumeIOMetrics would get historical performance data for the specified volume. This has been renamed to Get-PfaVolumeIOMetricsByTimeRange.
  • A new cmdlet with the same name (Get-PfaVolumeIOMetrics) is added to list IO metrics attributes for the specified volume.
  • In 1.5 version of the SDK, Get-PfaAllVolumeIOMetrics would get IO metrics for a specific volume – this has been renamed to Get-PfaVolumeIOmetrics.
  • Fixed bug with Get-PfaInitiatorPorts where it was only returning array ports.
  • Added the ability to connect to an array using API token. Use Get-Help New-PfaArray for full details.


The PowerShell SDK can be installed using the following:


If you need help installing from the PowerShell Gallery see this article, PowerShell SDK & Toolkit available via the PowerShell Gallery.