Releases: PureStorage-Connect/PowerShellSDK
Pure Storage® FlashArray PowerShell SDK v1.19.49.0
This is the MSI installer for the Pure Storage® FlashArray PowerShell SDK version 1.19.49.0. It is intended for scenarios that still require a standalone installer.
We highly encourage the installation of the SDK by using the Install-Module cmdlet that will pull the latest version form the PowerShell Gallery.
Install-Module -Name PureStoragePowerShellSDK
Please visit this article on our support site in the Microsoft Program Guide for more information on this release.
Pure Storage® FlashArray PowerShell SDK v1.19.37.0
This is the MSI installer for the Pure Storage® FlashArray PowerShell SDK version 1.19.37.0. It is intended for scenarios that still require a standalone installer.
We highly encourage the installation of the SDK by using the Install-Module cmdlet that will pull the latest version form the PowerShell Gallery.
Install-Module -Name PureStoragePowerShellSDK
Please visit this article on our support site in the Microsoft Program Guide for more information on this release.
Pure Storage PowerShell SDK 1.17.16.0
PURE STORAGE POWERSHELL SDK 1.17 RELEASE NOTES
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
There are currently two releases of the SDK, version 1 for Purity REST API version 1.0 to 1.17, and version 2, for Purity REST API version 2.0 and later.
// RELEASE COMPATIBILITY
- This release requires PowerShell versions 3.0 to 5.1.
- This release requires .NET Framework 4.5.
- This release is compatible with FlashArrays that support Pure Storage REST API 1.0 to 1.17 inclusive. You can determine what API versions are supported on an array by using a web browser to go to this URL - https:///api/api_version.
- This release requires a 64-bit Windows operating system that is compatible with the required PowerShell versions noted previously.
// INSTALLATION AND UNINSTALLATION
-
Full installation instructions are available from this link - https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell/Pure_Storage_PowerShell_SDK
-
An Administrator privilege is required to install.
-
To install the PowerShell SDK, there are two options for the method of installation. The recommened method is to use the PowerShell Gallery by using the Install-Module cmdlet. You can also install via a Windows MSI installer, where you
extract and run the PurePowerShellSDKInstaller.msi and follow the instructions. -
To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt and verify the release version.
-
If you used the PowerShell Gallery installation, you uninstall the SDK by using the Uninstall-Module cmdlet. For MSI installations, you can use the "Programs and Features" of the Control Panel.
// KNOWN ISSUES
- Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
- The following Cmdlets remove the "-CaCertificate" parameter. See the new "New-PfaKMIP" cmdlet.
Import-PfaNamedCertificate
New-PfaNamedCertificate - Get-PfaNamedCertificate no longer accepts the -ExportCaCertificate parameter.
// RESOURCES
- Join the Pure Storage Code Slack Team and talk allthings APIs and SDKs by using this self-invitation link - https://codeinvite.purestorage.com
- Our https://code.purestorage.com site links to all available API and SDK information on Github and Support.
// RELEASE INFORMATION
RELEASE 1.17.16.0
Release 1.17.16.0 adds the following changes to Release 1.17.11.0
- Fix for possible race condition when using specific cmdlets.
Pure Storage PowerShell SDK 1.17.11.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
There are currently two releases of the SDK, version 1 for Purity REST API version 1.0 to 1.17, and version 2, for Purity REST API version 2.0 and later.
// RELEASE COMPATIBILITY
- This release requires PowerShell versions 3.0 to 5.1.
- This release requires .NET Framework 4.5.
- This release is compatible with FlashArrays that support Pure Storage REST API 1.0 to 1.17 inclusive. You can determine what API versions are supported on an array by using a web browser to go to this URL - https:///api/api_version.
- This release requires a 64-bit Windows operating system that is compatible with the required PowerShell versions noted previously.
// INSTALLATION AND UNINSTALLATION
-
Full installation instructions are available from this link - https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell/Pure_Storage_PowerShell_SDK
-
An Administrator privilege is required to install.
-
To install the PowerShell SDK, there are two options for the method of installation. The recommened method is to use the PowerShell Gallery by using the Install-Module cmdlet. You can also install via a Windows MSI installer, where you
extract and run the PurePowerShellSDKInstaller.msi and follow the instructions. -
To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt and verify the release version.
-
If you used the PowerShell Gallery installation, you uninstall the SDK by using the Uninstall-Module cmdlet. For MSI installations, you can use the "Programs and Features" of the Control Panel.
// KNOWN ISSUES
- Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
- The following Cmdlets remove the "-CaCertificate" parameter. See the new "New-PfaKMIP" cmdlet.
Import-PfaNamedCertificate
New-PfaNamedCertificate - Get-PfaNamedCertificate no longer accepts the -ExportCaCertificate parameter.
// RESOURCES
- Join the Pure Storage Code Slack Team and talk allthings APIs and SDKs by using this self-invitation link - https://codeinvite.purestorage.com
- Our https://code.purestorage.com site links to all available API and SDK information on Github and Support.
// RELEASE INFORMATION
RELEASE 1.17.11
Release 1.17.11 adds the following changes to Release 1.17.0
- Added DisableLoggingToArray to New-PfaArray and New-PfaCLICommand to disabled phone home logging to the array (and the associated thread) for this connection.
- Fixed resource consumption issue in a New-PfaCLICommand connection that could cause the number of threads in a process to continually increase.
Pure Storage PowerShell SDK 1.17.3.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
This release requires PowerShell 3.0 or higher.
This release requires .NET 4.5.
This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0 to 1.17 inclusive.
This release requires a 64-bit operating system.
INSTALLATION AND UNINSTALLATION
To install the PowerShell SDK, extract and run PurePowerShellSDKInstaller.msi, and follow the instructions. Administrator privilege is required to install. To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell session. The newly installed cmdlets should be listed. The PowerShell SDK can be uninstalled from "Programs and Features" via the Control Panel.
The PowerShell SDK can also be installed using the PowerShell Gallery. See https://www.powershellgallery.com/ for details on how to discover resources on the PowerShell Gallery. If installed using the PowerShell Gallery the PowerShell SDK can be removed using Remove-Module -Name PureStoragePowerShellSDK.
KNOWN ISSUES
Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
RELEASE 1.17.3.0
Release 1.17.3.0 adds the following changes to Release 1.16.6.0
Added support for REST 1.17. The following features are implemented.
Added support for Maintenance Window.
- New-PfaMaintenanceWindow
- Get-PfaMaintenanceWindow
- Remove-PfaMaintenanceWindow
Added CaCertificate to New-PfaKMIP cmdlet.
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
PERFORMANCE TESTING
No performance testing was done for this release.
OPEN SOURCE LICENSES
Json.NET:
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SSH.NET:
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Pure Storage PowerShell SDK 1.16.6.0
Pure Storage PowerShell SDK 1.16.6.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
This release requires PowerShell 3.0 or higher.
This release requires .NET 4.5.
This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0 to 1.16 inclusive.
This release requires a 64-bit operating system.
INSTALLATION AND UNINSTALLATION
To install the PowerShell SDK, extract and run PurePowerShellSDKInstaller.msi, and follow the instructions. Administrator privilege is required to install. To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt. The newly installed cmdlets should be listed. The PowerShell SDK can be uninstalled from "Programs and Features" of the Control Panel.
The PowerShell SDK can also be installed using the PowerShell Gallery. See https://www.powershellgallery.com/ for details on how to discover resources on the PowerShell Gallery.
KNOWN ISSUES
Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
RELEASE 1.16.0
Release 1.16.0 adds the following changes to Release 1.13.1.12
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
PERFORMANCE TESTING
No performance testing was done for this release.
OPEN SOURCE LICENSES
Json.NET:
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SSH.NET:
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Pure Storage PowerShell SDK 1.13
Pure Storage PowerShell SDK 1.13.0 Release Notes
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
This release requires PowerShell 3.0 or higher.
This release requires .NET 4.5.
This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0 to 1.13 inclusive.
This release requires a 64-bit operating system.
INSTALLATION AND UNINSTALLATION
To install the PowerShell SDK, extract and run PurePowerShellSDKInstaller.msi, and follow the instructions. Administrator privilege is required to install. To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt. The newly installed cmdlets should be listed. The PowerShell SDK can be uninstalled from "Programs and Features" of the Control Panel.
The PowerShell SDK can also be installed using the PowerShell Gallery. See https://www.powershellgallery.com/ for details on how to discover resources on the PowerShell Gallery.
KNOWN ISSUES
Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
RELEASE 1.13.0
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
RELEASE 1.7
ADDITIONS
Support for Pure Storage arrays with IPv6 addresses
Bug fixes and cmdlets to support REST 1.7
- Fixed Get-PfaProtectiongGroupVolumeSnapshot to work with REST 1.2 - REST 1.7. It still doesn't work with REST 1.4 (see KNOWN ISSUES above.)
- Fixed bug where cmdlets were ignoring -ErrorAction.
- Added mode (primary/secondary) property on the controller object returned by Get-PfaControllers.
- Added cmdlets Get-PfaAllVolumeIOMetricsByTimeRange (Lists historical IO metrics for all volumes for a specified range) and Get-PfaNamedVolumesIOMetricsByTimeRange (Lists historical IO metrics for specified volumes for a specified range.)
- Add Get-PfaProtectionGroupRetentions (retrieve snapshot replication retention policy for all protection groups.)
- Add Get-PfaVolumeSnapshot (retrieve a particular snapshot by name.)
- Set-PfaProtectionGroupRetention should have optional params, so that the user can change one property at a time and doesn't have to specify all properties.
- Added Get cmdlets that support filtering by names. The names parameter accepts a single name or a comma-separated list for multiple values. The names parameter also accepts an asterisk ( * ) as a wildcard character.
Get-PfaNamedVolumes
Get-PfaNamedProtectionGroups
Get-PfaNamedHosts
Get-PfaNamedHostGroups
RELEASE 1.6
ADDITIONS
The last release for the Pure Storage PowerShell SDK was 1.5
The following cmdlets have been added since the last release to support REST 1.5
- Added Update-PfaArrayConnectionsThrottlingInformation.
- Added Get-PfaArrayConnectionsThrottlingInformation.
- Added Get-PfaAllHostIOMetrics.
- Added Get-PfaHostIOMetrics.
- Added Get-PfaAllHostGroupIOMetrics.
- Added Get-PfaHostGroupIOMetrics.
The following cmdlets have been added since the last release to support REST 1.6
- Added Get-PfaArraySpaceMetricsByTimeRange.
- Added Get-PfaAllVolumeSpaceMetricsByTimeRange.
- Added Get-PfaVolumeSpaceMetricsByTimeRange.
The following cmdlets have been added since the last release to support REST 1.7
- Added Get-PfaArrayIOMetricsAverage.
- Added Get-PfaAllHostIOMetricsTotal.
- Added Get-PfaAllHostIOMetricsAverage.
- Added Get-PfaHostIOMetricsAverage.
- Added Get-PfaAllHostGroupIOMetricsTotal.
- Added Get-PfaAllHostGroupIOMetricsAverage.
- Added Get-PfaHostGroupIOMetricsAverage.
- Added Get-PfaAllVolumeIOMetricsAverage.
- Added Get-PfaAllVolumeIOMetricsTotal.
- Added Get-PfaVolumeIOMetricsAverage.
Other additions:
- Added New-PfaCLICommand to be able to run any CLI command on the FlashArray
- Added Get-PfaVolumeIOMetricsByTimeRange (old name was Get-PfaVolumeIOMetrics - see section CHANGES)
- Added Get-PfaProtectionGroupSchedules.
- Added Get-PfaSourceProtectionGroupSchedules.
The following cmdlets related to Purity's integration with Active Directory to provide authentication. - Added Set-PfaDirectoryServiceStatus to enable/disable Active Directory integration.
- Added Set-PfaDirectoryServiceAuthenticationStatus to enable/disable server authenticity enforcement using configured CA certificate.
- Added Set-PfaDirectoryServiceGroupBase to set base OU for ArrayAdmin/StorageAdmin/Readonly security groups.
CHANGES
- 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 (see change#2 above)
- Fixed bug with Get-PfaInitiatorPorts where it was only returning array ports.
- Added the ability to connect to an array using API token (see help for New-PfaArray)
PERFORMANCE TESTING
No performance testing was done for this release.
OPEN SOURCE LICENSES
Json.NET:
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SSH.NET:
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this...
Pure Storage PowerShell SDK 1.7.4.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
- This release requires PowerShell 3.0 or higher.
- This release requires .NET 4.5.
- This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7.
- This release requires a 64-bit operating system.
INSTALLATION AND UNINSTALLATION
To install the PowerShell SDK, extract and run PurePowerShellSDKInstaller.msi, and follow the instructions. Administrator privilege is required to install. To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt. The newly installed cmdlets should be listed. The PowerShell SDK can be uninstalled from "Programs and Features" of the Control Panel.
KNOWN ISSUES
Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
Get-PfaVolumeSpaceMetrics does not return the "size" property of a volume if the array is connected using REST API 1.0 or 1.1.
RELEASE 1.7
- Support for Pure Storage FlahArrays for IPv6.
- Added Get-PfaArrayIOMetricsAverage.
- Added Get-PfaAllHostIOMetricsTotal.
- Added Get-PfaAllHostIOMetricsAverage.
- Added Get-PfaHostIOMetricsAverage.
- Added Get-PfaAllHostGroupIOMetricsTotal.
- Added Get-PfaAllHostGroupIOMetricsAverage.
- Added Get-PfaHostGroupIOMetricsAverage.
- Added Get-PfaAllVolumeIOMetricsAverage.
- Added Get-PfaAllVolumeIOMetricsTotal.
- Added Get-PfaVolumeIOMetricsAverage.
RELEASE 1.6
- Added Get-PfaArraySpaceMetricsByTimeRange.
- Added Get-PfaAllVolumeSpaceMetricsByTimeRange.
- Added Get-PfaVolumeSpaceMetricsByTimeRange.
- Added New-PfaCLICommand to be able to run any CLI command on the FlashArray
- Added Get-PfaVolumeIOMetricsByTimeRange (old name was Get-PfaVolumeIOMetrics - see section CHANGES)
- Added Get-PfaProtectionGroupSchedules.
- Added Get-PfaSourceProtectionGroupSchedules.
The following cmdlets related to Purity's integration with Active Directory to provide authentication. - Added Set-PfaDirectoryServiceStatus to enable/disable Active Directory integration.
- Added Set-PfaDirectoryServiceAuthenticationStatus to enable/disable server authenticity enforcement using configured CA certificate.
- Added Set-PfaDirectoryServiceGroupBase to set base OU for ArrayAdmin/StorageAdmin/Readonly security groups.
RELEASE 1.5
- Added Update-PfaArrayConnectionsThrottlingInformation.
- Added Get-PfaArrayConnectionsThrottlingInformation.
- Added Get-PfaAllHostIOMetrics.
- Added Get-PfaHostIOMetrics.
- Added Get-PfaAllHostGroupIOMetrics.
- Added Get-PfaHostGroupIOMetrics.
CHANGES
- 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 (see change#2 above)
- Fixed bug with Get-PfaInitiatorPorts where it was only returning array ports.
- Added the ability to connect to an array using API token (see help for New-PfaArray)
OPEN SOURCE LICENSES
Json.NET:
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SSH.NET:
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Pure Storage PowerShell SDK 1.6.6.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
- This release requires PowerShell 3.0 or higher.
- This release requires .NET 4.5.
- This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7.
- This release requires a 64-bit operating system.
INSTALLATION AND UNINSTALLATION
To install the PowerShell SDK, extract and run PurePowerShellSDKInstaller.msi, and follow the instructions. Administrator privilege is required to install. To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt. The newly installed cmdlets should be listed. The PowerShell SDK can be uninstalled from "Programs and Features" of the Control Panel.
KNOWN ISSUES
- Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
- Get-PfaVolumeSpaceMetrics does not return the "size" property of a volume if the array is connected using REST API 1.0 or 1.1.
ADDITIONS
The last release for the Pure Storage PowerShell SDK was 1.5
The following cmdlets have been added since the last release to support REST 1.5
- Added Update-PfaArrayConnectionsThrottlingInformation
- Added Get-PfaArrayConnectionsThrottlingInformation
- Added Get-PfaAllHostIOMetrics
- Added Get-PfaHostIOMetrics
- Added Get-PfaAllHostGroupIOMetrics
- Added Get-PfaHostGroupIOMetrics
The following cmdlets have been added since the last release to support REST 1.6
- Added Get-PfaArraySpaceMetricsByTimeRange
- Added Get-PfaAllVolumeSpaceMetricsByTimeRange
- Added Get-PfaVolumeSpaceMetricsByTimeRange
The following cmdlets have been added since the last release to support REST 1.7
- Added Get-PfaArrayIOMetricsAverage
- Added Get-PfaAllHostIOMetricsTotal
- Added Get-PfaAllHostIOMetricsAverage
- Added Get-PfaHostIOMetricsAverage
- Added Get-PfaAllHostGroupIOMetricsTotal
- Added Get-PfaAllHostGroupIOMetricsAverage
- Added Get-PfaHostGroupIOMetricsAverage
- Added Get-PfaAllVolumeIOMetricsAverage
- Added Get-PfaAllVolumeIOMetricsTotal
- Added Get-PfaVolumeIOMetricsAverage
OTHER ADDITIONS
- Added New-PfaCLICommand to be able to run any CLI command on the FlashArray
- Added Get-PfaVolumeIOMetricsByTimeRange (old name was Get-PfaVolumeIOMetrics - see section CHANGES)
- Added Get-PfaProtectionGroupSchedules.
- Added Get-PfaSourceProtectionGroupSchedules.
The following cmdlets related to Purity's integration with Active Directory to provide authentication.
- Added Set-PfaDirectoryServiceStatus to enable/disable Active Directory integration.
- Added Set-PfaDirectoryServiceAuthenticationStatus to enable/disable server authenticity enforcement using configured CA certificate.
- Added Set-PfaDirectoryServiceGroupBase to set base OU for ArrayAdmin/StorageAdmin/Readonly security groups.
CHANGES
- 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 (see change#2 above)
- Fixed bug with Get-PfaInitiatorPorts where it was only returning array ports.
- Added the ability to connect to an array using API token (see help for New-PfaArray)
Pure Storage PowerShell SDK 1.5.5.0
The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
RELEASE COMPATIBILITY
- This release requires PowerShell 3.0 or higher.
- This release requires .NET 4.5.
- This release is compatible with Purity FlashArrays that support Pure Storage REST API 1.0, 1.1, 1.2, 1.3, or 1.4.
- This release requires a 64-bit operating system.
- This release requires an operating system that supports the TLS 1.1/1.2 protocols such as Windows 7 & up or Windows Server 2008 R2 or higher.
FIXES
- Fixed issue with Get-PfaInitiatorPorts and Get-PfaArrayPorts returning the same details.