PowerShell SDK v2 Cmdlet To Purity API 2.x Version Matrix
SDK v2 Cmdlet to API Version Matrix
The FlashArray PowerShell SDK version 2.2 is built from the FlashArray Purity API specifications version 2.0 and later. Due to the progressive nature of the API, there are certain cmdlets and parameters that may not be available for use with API versions 2.0 and 2.1 that are available in later versions. The table below will outline the differences between the API versions and the SDK cmdlet compatibility.
FlashArray Purity API Specifications can be found in this article.
To determine which API versions are available on your arrays, open a browser to this URL - https://<FQDN or IP Address of array>/api/api_version.
An updated PDF that includes all cmdlet parameters is available in the PowerShell SDK 2 GitHub repository.
| SDK v2 Cmdlet | API Version |
|---|---|
| Connect-Pfa2Array | 2.0 |
| Disconnect-Pfa2Array | 2.0 |
| Get-Pfa2Admin | 2.2 |
| Get-Pfa2AdminApiToken | 2.2 |
| Get-Pfa2AdminCache | 2.2 |
| Get-Pfa2AdminSetting | 2.2 |
| Get-Pfa2Alert | 2.2 |
| Get-Pfa2AlertEvent | 2.2 |
| Get-Pfa2ApiVersion | 2.0 |
| Get-Pfa2ApiClient | 2.1 |
| Get-Pfa2App | 2.2 |
| Get-Pfa2AppNode | 2.2 |
| Get-Pfa2Array | 2.2 |
| Get-Pfa2ArrayEula | 2.2 |
| Get-Pfa2ArrayNtpTest | 2.2 |
| Get-Pfa2ArrayPerformance | 2.2 |
| Get-Pfa2ArraySpace | 2.2 |
| Get-Pfa2Audit | 2.2 |
| Get-Pfa2Connection | 2.0 |
| Get-Pfa2Controller | 2.2 |
| Get-Pfa2DirectoryService | 2.2 |
| Get-Pfa2DirectoryServiceRole | 2.2 |
| Get-Pfa2DirectoryServiceTest | 2.2 |
| Get-Pfa2Dns | 2.2 |
| Get-Pfa2Hardware | 2.2 |
| Get-Pfa2HostGroupProtectionGroup | 2.1 |
| Get-Pfa2HostGroupSpace | 2.1 |
| Get-Pfa2HostProtectionGroup | 2.1 |
| Get-Pfa2HostSpace | 2.1 |
| Get-Pfa2Kmip | 2.2 |
| Get-Pfa2KmipTest | 2.2 |
| Get-Pfa2MaintenanceWindow | 2.2 |
| Get-Pfa2Offload | 2.1 |
| Get-Pfa2Pod | 2.1 |
| Get-Pfa2PodArray | 2.1 |
| Get-Pfa2PodPerformance | 2.1 |
| Get-Pfa2PodPerformanceByArray | 2.1 |
| Get-Pfa2PodPerformanceReplication | 2.2 |
| Get-Pfa2PodPerformanceReplicationByArray | 2.2 |
| Get-Pfa2PodReplicaLink | 2.2 |
| Get-Pfa2PodReplicaLinkLag | 2.2 |
| Get-Pfa2PodReplicaLinkPerformanceReplication | 2.2 |
| Get-Pfa2PodSpace | 2.1 |
| Get-Pfa2Port | 2.2 |
| Get-Pfa2PortInitiator | 2.2 |
| Get-Pfa2ProtectionGroup | 2.1 |
| Get-Pfa2ProtectionGroupHost | 2.1 |
| Get-Pfa2ProtectionGroupHostGroup | 2.1 |
| Get-Pfa2ProtectionGroupPerformanceReplication | 2.1 |
| Get-Pfa2ProtectionGroupPerformanceReplicationByArray | 2.1 |
| Get-Pfa2ProtectionGroupSnapshot | 2.1 |
| Get-Pfa2ProtectionGroupSnapshotTransfer | 2.1 |
| Get-Pfa2ProtectionGroupSpace | 2.1 |
| Get-Pfa2ProtectionGroupTarget | 2.1 |
| Get-Pfa2ProtectionGroupVolume | 2.1 |
| Get-Pfa2RemotePod | 2.1 |
| Get-Pfa2RemoteProtectionGroup | 2.1 |
| Get-Pfa2RemoteProtectionGroupSnapshot | 2.1 |
| Get-Pfa2RemoteProtectionGroupSnapshotTransfer | 2.1 |
| Get-Pfa2RemoteVolumeSnapshot | 2.1 |
| Get-Pfa2RemoteVolumeSnapshotTransfer | 2.1 |
| Get-Pfa2SmiS | 2.2 |
| Get-Pfa2Software | 2.2 |
| Get-Pfa2SoftwareInstallation | 2.2 |
| Get-Pfa2SoftwareInstallationStep | 2.2 |
| Get-Pfa2Subnet | 2.2 |
| Get-Pfa2Support | 2.2 |
| Get-Pfa2SupportTest | 2.2 |
| Get-Pfa2VolumeGroup | 2.1 |
| Get-Pfa2VolumeGroupPerformance | 2.1 |
| Get-Pfa2VolumeGroupSpace | 2.1 |
| Get-Pfa2VolumeGroupVolume | 2.1 |
| Get-Pfa2VolumeProtectionGroup | 2.1 |
| Get-Pfa2VolumeSnapshotTags | 2.2 |
| Get-Pfa2VolumeTag | 2.2 |
| Get-Pfa2VolumeVolumeGroup | 2.1 |
| Invoke-Pfa2CliCommand | 2.0 |
| New-Pfa2Admin | 2.2 |
| New-Pfa2AdminApiToken | 2.2 |
| New-Pfa2AdminRoleObject | 2.2 |
| New-Pfa2ApiClient | 2.1 |
| New-Pfa2ArrayAuth | 2.0 |
| New-Pfa2ChapObject | 2.0 |
| New-Pfa2EulaSignatureObject | 2.2 |
| New-Pfa2FixedReferenceObject | 2.2 |
| New-Pfa2HostGroupHost | 2.1 |
| New-Pfa2HostGroupProtectionGroup | 2.1 |
| New-Pfa2HostHostGroup | 2.1 |
| New-Pfa2HostProtectionGroup | 2.1 |
| New-Pfa2Kmip | 2.2 |
| New-Pfa2MaintenanceWindow | 2.2 |
| New-Pfa2Offload | 2.1 |
| New-Pfa2OffloadAmazons3Object | 2.1 |
| New-Pfa2OffloadAzureObject | 2.1 |
| New-Pfa2OffloadGoogleCloudObject | 2.2 |
| New-Pfa2OffloadNfsObject | 2.1 |
| New-Pfa2QosObject | 2.0 |
| New-Pfa2Pod | 2.1 |
| New-Pfa2PodArray | 2.1 |
| New-Pfa2PodReplicaLink | 2.2 |
| New-Pfa2ProtectionGroup | 2.1 |
| New-Pfa2ProtectionGroupHost | 2.1 |
| New-Pfa2ProtectionGroupHostGroup | 2.1 |
| New-Pfa2ProtectionGroupSnapshot | 2.1 |
| New-Pfa2ProtectionGroupTarget | 2.1 |
| New-Pfa2ProtectionGroupVolume | 2.1 |
| New-Pfa2ReferenceNoIdObject | 2.0 |
| New-Pfa2ReferenceObject | 2.0 |
| New-Pfa2ReplicationScheduleObject | 2.1 |
| New-Pfa2RetentionPolicyObject | 2.1 |
| New-Pfa2SnapshotScheduleObject | 2.1 |
| New-Pfa2Subnet | 2.2 |
| New-Pfa2TagObject | 2.2 |
| New-Pfa2TimeWindowObject | 2.1 |
| New-Pfa2VolumeGroup | 2.1 |
| New-Pfa2VolumeProtectionGroup | 2.1 |
| Remove-Pfa2Admin | 2.2 |
| Remove-Pfa2AdminApiToken | 2.2 |
| Remove-Pfa2AdminCache | 2.2 |
| Remove-Pfa2ApiClient | 2.1 |
| Remove-Pfa2HostGroupHost | 2.1 |
| Remove-Pfa2HostGroupProtectionGroup | 2.1 |
| Remove-Pfa2HostHostGroup | 2.1 |
| Remove-Pfa2HostProtectionGroup | 2.1 |
| Remove-Pfa2Kmip | 2.2 |
| Remove-Pfa2MaintenanceWindow | 2.2 |
| Remove-Pfa2Offload | 2.1 |
| Remove-Pfa2Pod | 2.1 |
| Remove-Pfa2PodArray | 2.1 |
| Remove-Pfa2PodReplicaLink | 2.2 |
| Remove-Pfa2ProtectionGroup | 2.1 |
| Remove-Pfa2ProtectionGroupHost | 2.1 |
| Remove-Pfa2ProtectionGroupHostGroup | 2.1 |
| Remove-Pfa2ProtectionGroupSnapshot | 2.1 |
| Remove-Pfa2ProtectionGroupTarget | 2.1 |
| Remove-Pfa2ProtectionGroupVolume | 2.1 |
| Remove-Pfa2RemoteProtectionGroup | 2.1 |
| Remove-Pfa2RemoteProtectionGroupSnapshot | 2.1 |
| Remove-Pfa2Subnet | 2.2 |
| Remove-Pfa2VolumeGroup | 2.1 |
| Remove-Pfa2VolumeProtectionGroup | 2.1 |
| Remove-Pfa2VolumeSnapshotTags | 2.2 |
| Remove-Pfa2VolumeTag | 2.2 |
| Set-Pfa2AdminCache | 2.2 |
| Set-Pfa2Logging | 2.0 |
| Set-Pfa2VolumeSnapshotTagsBatch | 2.2 |
| Set-Pfa2VolumeTagBatch | 2.2 |
| Update-Pfa2Admin | 2.2 |
| Update-Pfa2AdminSetting | 2.2 |
| Update-Pfa2Alert | 2.2 |
| Update-Pfa2ApiClient | 2.1 |
| Update-Pfa2App | 2.2 |
| Update-Pfa2Array | 2.2 |
| Update-Pfa2ArrayEula | 2.2 |
| Update-Pfa2DirectoryService | 2.2 |
| Update-Pfa2DirectoryServiceRole | 2.2 |
| Update-Pfa2Dns |
2.2 |
| Update-Pfa2Hardware | 2.2 |
| Update-Pfa2Kmip | 2.2 |
| Update-Pfa2Pod | 2.1 |
| Update-Pfa2PodReplicaLink | 2.2 |
| Update-Pfa2ProtectionGroup | 2.1 |
| Update-Pfa2ProtectionGroupSnapshot | 2.1 |
| Update-Pfa2ProtectionGroupTarget | 2.1 |
| Update-Pfa2RemoteProtectionGroup | 2.1 |
| Update-Pfa2RemoteProtectionGroupSnapshot | 2.1 |
| Update-Pfa2SmiS | 2.2 |
| Update-Pfa2Subnet | 2.2 |
| Update-Pfa2Support | 2.2 |
| Update-Pfa2VolumeGroup | 2.1 |
| Get-Pfa2Connection | 2.0 |
| Get-Pfa2Host | 2.0 |
| Get-Pfa2HostGroup | 2.0 |
| Get-Pfa2HostGroupHost | 2.0 |
| Get-Pfa2HostGroupPerformance | 2.0 |
| Get-Pfa2HostGroupPerformanceByArray | 2.0 |
| Get-Pfa2HostHostGroup | 2.0 |
| Get-Pfa2HostPerformance | 2.0 |
| Get-Pfa2HostPerformanceByArray | 2.0 |
| Get-Pfa2Volume | 2.0 |
| Get-Pfa2VolumePerformance | 2.0 |
| Get-Pfa2VolumePerformanceByArray | 2.0 |
| Get-Pfa2VolumeSnapshot | 2.0 |
| Get-Pfa2VolumeSnapshotTransfer | 2.0 |
| Get-Pfa2VolumeSpace | 2.0 |
| New-Pfa2Connection | 2.0 |
| New-Pfa2Host | 2.0 |
| New-Pfa2HostGroup | 2.0 |
| New-Pfa2Login | 2.0 |
| New-Pfa2Logout | 2.0 |
| New-Pfa2Volume | 2.0 |
| New-Pfa2VolumeSnapshot | 2.0 |
| Remove-Pfa2Connection | 2.0 |
| Remove-Pfa2Host | 2.0 |
| Remove-Pfa2HostGroup | 2.0 |
| Remove-Pfa2Volume | 2.0 |
| Remove-Pfa2VolumeSnapshot | 2.0 |
| Update-Pfa2Host | 2.0 |
| Update-Pfa2HostGroup | 2.0 |
| Update-Pfa2Volume | 2.0 |
| Update-Pfa2VolumeSnapshot | 2.0 |