Skip to main content
Contact Us
Register
Pure Technical Services

Pure Storage PowerShell SDK

  1. Last updated
  2. Save as PDF
Install Module

Module

Release

Notes
PowerShell SDK 1.17.3.0

New Features

Release 1.17.3.0 adds the following changes to Release 1.16

  • Added support for Maintenance Window.
        New-PfaMaintenanceWindow
        Get-PfaMaintenanceWindow
        Remove-PfaMaintenanceWindow
  • Added CaCertificate to New-PfaKMIP command-let.
  • Added support for Azure Offload.
        Connect-PfaOffloadAzureTarget
        Get-PfaOffloadAzureTarget
        Get-PfaAllOffloadAzureTarget
        Disconnect-PfaOffloadAzureTarget
  • Added support for EULA.
        Get-PfaArrayEula
        Set-PfaArrayEulaAccept
  • Added support for Network Interface metrics.
        Get-PfaNetworkInterfaceMetrics
        Get-PfaNetworkInterfaceMetricsError
        Get-PfaAllNetworkInterfaceMetrics
        Get-PfaAllNetworkInterfaceMetricsError
        Get-PfaAllNetworkInterfaceMetricsErrorTotal
        Get-PfaAllNetworkInterfaceMetricsTotal
  • Added support for POD metrics.
        Get-PfaAllPodSpaceMetricsTotal
  • Added support for Protection Group replication bandwidth
        Get-PfaAllProtectionGroupReplicationBandwidth
        Get-PfaAllProtectionGroupReplicationBandwidthByTimeRange
        Get-PfaProtectionGroupReplicationBandwidth
        Get-PfaProtectionGroupReplicationBandwidthByTimeRange
  • Added support for reading volume host encryption key status
        Get-PfaVolumeHostEncryptionKeyStatus
        Get-PfaAllVolumeHostEncryptionKeyStatus
  • Added support for reading volume space metrics.
        Get-PfaAllVolumeSpaceMetricsTotal
        Get-PfaAllVolumeTotal
  • Added support for reading volume group bandwidth
        Set-PfaVolumeGroupBandwidthLimit
  • Added support for volume and volume group IOPS limit
        Set-PfaVolumeGroupIOPSLimit
        Set-PfaVolumeIOPSLimit
  • Added support for VNC support for software app 
        Disable-PfaSoftwareVNC
        Enable-PfaSoftwareVNC
  • Added support for reading the software app nodes.
        Get-PfaAllSoftwareNode
        Get-PfaSoftwareNode
PowerShell SDK 1.16.6.0

New Features

Release 1.16.6.0 adds the following changes to Release 1.13

  • Added support for REST 1.14, 1.15 and 1.16. The following features are implemented.
  • Added support for NFS and S3 snapshot offload 
       Connect-PfaOffloadNFSTarget
       Connect-PfaOffloadS3Target
       Disconnect-PfaOffloadNFSTarget
       Disconnect-PfaOffloadS3Target
       Get-PfaAllProtectionGroupOffloadSnapshot
       Get-PfaAllVolumeOffloadSnapshot
       Get-PfaOffloadNFSTarget
       Get-PfaOffloadS3Target
       Get-PfaOffloadSnapshot
       Get-PfaOffloadTarget
       Get-PfaProtectionGroupOffloadSnapshot
       Restore-PfaAllVolumeOffloadSnapshot
  • Added support for how directory service roles are modified
       Get-PfaDirectoryServiceRole
       New-PfaDirectoryServiceRole
  • Added support for maximum login attempts and user lockout
       Get-PfaAdminSetting
       Get-PfaAllLockedUser
       Get-PfaLockedUser
       Set-PfaAdminSetting
       Unlock-PfaUser
  • Added support for host NQN's
       Add-PfaHostNqn
       Remove-PfaHostNqn
       Set-PfaHostNqn
  • Added support for creating and deleting local user
       New-PfaLocalUser
       Remove-PfaLocalUser
  • Added support to view and manage software applications on Purity Array
       New-PfaSoftware
       Get-PfaSoftware
       Disable-PfaSoftware
       Enable-PfaSoftware
       Remove-PfaSoftware
       Get-PfaSoftwareAttribute
  • Added ability to view pods on remote array
       Get-PfaAllRemotePod
       Get-PfaRemotePod
  • Added the ability to list latency values when viewing performance data.
       Get-PfaAllHostGroupIOLatencyMetrics
       Get-PfaAllHostGroupIOLatencyMetricsMirrored
       Get-PfaAllHostGroupIOLatencyMetricsTotal
       Get-PfaAllHostIOLatencyMetrics
       Get-PfaAllHostIOLatencyMetricsMirrored
       Get-PfaAllHostIOLatencyMetricsTotal
       Get-PfaAllPodIOLatencyMetricsMirrored
       Get-PfaAllVolumeGroupIOLatencyMetrics
       Get-PfaAllVolumeGroupIOLatencyMetricsByTimeRange
       Get-PfaAllVolumeGroupsIOLatencyMetricsTotal
       Get-PfaAllVolumeIOLatencyMetrics
       Get-PfaAllVolumeIOLatencyMetricsByTimeRange
       Get-PfaAllVolumeIOLatencyMetricsTotal
       Get-PfaArrayIOLatencyMetrics
       Get-PfaHostGroupIOLatencyMetrics
       Get-PfaHostGroupIOLatencyMetricsMirrored
       Get-PfaHostIOLatencyMetrics
       Get-PfaHostIOLatencyMetricsMirrored
       Get-PfaNamedVolumeGroupsIOLatencyMetricsByTimeRange
       Get-PfaNamedVolumesIOLatencyMetricsByTimeRange
       Get-PfaPodIOLatencyMetricsMirrored
       Get-PfaVolumeGroupIOLatencyMetrics
       Get-PfaVolumeGroupIOLatencyMetricsByTimeRange
       Get-PfaVolumeIOLatencyMetrics
       Get-PfaVolumeIOLatencyMetricsByTimeRange
  • Added the following new cmdlets:
       Set-PfaHost
       Set-PfaPod
       Set-PfaVolumeBandwidthLimit
       Set-PfaSmtpManagerAttribute
       Get-PfaSmtpManagerAttribute
  • Updated the following cmdlets:
       Get-PfaHost
       Get-PfaHosts
       Get-PfaPod
       Get-PfaPods
       Get-PfaVolume
       Get-PfaVolumes
       New-PfaHost
       New-PfaPod
       New-PfaVolume
       Remove-PfaProtectionGroupOrSnapshot
       Restore-PfaDestroyedProtectionGroup
  • The following cmdlets starting REST 1.16 do not return "san_usec_per_read_op", "san_usec_per_write_op". These values are part of new cmdlet mentioned above *IOLatency*.
       Get-PfaAllHostIOMetrics
       Get-PfaHostIOMetricsAverage
       Get-PfaAllHostIOMetricsTotal
       Get-PfaArrayIOMetrics
       Get-PfaArrayIOMetricsAverage
       Get-PfaAllVolumeIOMetricsByTimeRange
       Get-PfaNamedVolumesIOMetricsByTimeRange
       Get-PfaVolumeIOMetrics
       Get-PfaVolumeIOMetricsByTimeRange
       Get-PfaAllVolumeIOMetric

PowerShell SDK

1.13.1.12

The Pure Storage PowerShell SDK leverages the REST API and wraps those APIs as PowerShell cmdlets.

New Features

Release 1.13.0 adds the following changes to Release 1.7

  • Support for REST 1.12 and REST 1.13, bug fixes.
  • TMAN-3817: Added notification property to SNMPManager object. New cmdlet:
    Set-PfaSnmpManagerNotification
  • Added -Filter parameter to cmdlets that return multiple objects to enable server side filtering. See new help topic about_Purity_Filtering.
  • Added the following new cmdlets related to Pod and sync-rep management
    Add-PfaArrayToPod
    Copy-PfaPod
    Get-PfaAllPodFootprint
    Get-PfaAllPodMediator
    Get-PfaAllPodSpaceHistory
    Get-PfaAllPodSpaces
    Get-PfaNamedPodFootprint
    Get-PfaNamedPodMediator
    Get-PfaNamedPodSpace
    Get-PfaNamedPodSpaceHistory
    Get-PfaNamedPods
    Get-PfaPendingDeletePods
    Get-PfaPendingPodFootprint
    Get-PfaPendingPodMediator
    Get-PfaPendingPodSpace
    Get-PfaPod
    Get-PfaPods
    New-PfaPod
    Remove-PfaArrayFromPod
    Remove-PfaPod
    Rename-PfaPod
    Restore-PfaPod
  • Added the following cmdlets to support named certificate management.
    Get-PfaNamedCertificate
    Get-PfaNamedCertificateAttribute
    Get-PfaNamedCertificateAttributes
    Import-PfaNamedCertificate
    Remove-PfaNamedCertificate
    New-PfaNamedCertificateImport
    New-PfaNamedSelfSignedCertificate
  • Added the following cmdlets to support reading mirrored IO statistics.
    Get-PfaAllHostGroupIOMetricsMirrored
    Get-PfaAllHostIOMetricsMirrored
    Get-PfaAllPodIOMetricsMirrored
    Get-PfaAllVolumeIOMetricsMirrored
    Get-PfaArrayIOMetricsMirrored
    Get-PfaHostGroupIOMetricsMirrored
    Get-PfaHostIOMetricsMirrored
    Get-PfaPodIOMetricsMirrored
    Get-PfaVolumeIOMetricsMirrored
  • Added the following cmdlets to support KMIP.
    Get-PfaKmip
    Get-PfaKmips
    New-PfaKmip
    Remove-PfaKmip
    Test-PfaKmip
    Update-PfaKmip
  • Added the following cmdlets to support Purity //Run apps
    Get-PfaPureAppAttributes
    Get-PfaPureAppsAttributes
  • Added the following cmdlets to support volume groups and vvols.
    Get-PfaAllVolumeGroupIOMetrics
    Get-PfaAllVolumeGroupIOMetricsByTimeRange
    Get-PfaAllVolumeGroupsIOMetricsAverage
    Get-PfaAllVolumeGroupsIOMetricsTotal
    Get-PfaVolumeGroupIOMetrics
    Get-PfaVolumeGroupIOMetricsAverage
    Get-PfaVolumeGroupIOMetricsByTimeRange
    Get-PfaVolumeGroupSpaceMetrics
    Get-PfaVolumeGroupSpaceMetrics
    Get-PfaNamedVolumeGroupsIOMetricsByTimeRange
    Get-PfaNamedVolumeGroups
    Get-PfaPendingDeleteVolumeGroups
    Get-PfaProtocolEndpointVolumes
    Get-PfaProtocolEndpointVolume
    Get-PfaVolumeGroups
    Get-PfaVolumeGroup
    New-PfaHostGroupProtocolEndpointVolumeConnection
    New-PfaHostProtocolEndpointVolumeConnection
    New-PfaProtocolEndpointVolume
    New-PfaVolumeGroup
    Remove-PfaVolumeGroup
    Restore-PfaVolumeGroup
  • Added the following cmdlets to support remote host/hostgroup/volume operations
    Get-PfaRemoteHost
    Get-PfaRemoteHostGroup
    Get-PfaRemoteHostGroupVolumeConnections
    Get-PfaRemoteHostGroups
    Get-PfaRemoteHosts
    Get-PfaRemoteVolumeHostConnections
    Get-PfaRemoteVolumeHostGroupConnections
    Get-PfaVolumeConnection
    Added the following cmdlets:
    Get-PfaArrayTCPConnection

Requirements

  • Windows PowerShell 3.0 or higher.
  • .NET Framework 4.5.
  • Purity Operating Environments that support REST API 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6 and 1.7.
  • 64-bit Windows Server or Client operating system.
  • This release requires an operating system that supports the TLS 1.1/1.2 protocols such as Windows 7 or higher and Windows Server 2008 R2 or higher.
Install Module
 


With the release of PowerShell SDK 1.5.x we have adopted the use of the PowerShell Gallery for installing the module. We will continue to provide the installer package (MSI) via GitHub but we encourage the use of the gallery for ease of deployment.