https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
PowerShell Toolkit 3.x
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
Last synced: 4 months ago
JSON representation
PowerShell Toolkit 3.x
- Host: GitHub
- URL: https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
- Owner: PureStorage-OpenConnect
- License: apache-2.0
- Created: 2022-11-03T02:05:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T09:25:10.000Z (7 months ago)
- Last Synced: 2024-11-29T02:36:47.416Z (5 months ago)
- Language: PowerShell
- Size: 2.02 MB
- Stars: 6
- Watchers: 6
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - PureStorage-OpenConnect/powershell-toolkit-3 - PowerShell Toolkit 3.x (PowerShell)
README
# Pure Storage PowerShell Toolkit 3.0
 
[](https://github.com/PureStorage-OpenConnect/powershell-toolkit-3/actions/workflows/psanalyzer-toolkitcodecheck.yml)
The Pure Storage PowerShell Toolkit 3.0 is a new beginning for the Toolkit. The original version was released in 2016 and was based on older versions of the Pure Storage PowerShell SDK 1.x release. The Toolkit provides useful cmdlets for customers and the Pure Storage Field Support to use in troubleshooting, monitoring, reporting, best practices, and configuration. The PowerShell Toolkit leverages the Pure Storage PowerShell SDK 2 for some of the cmdlets. All references to the PowerShell SDK 1.x have been removed.
The new release includes:
- Separate modules for specific functionality: Database Tools, Windows Administration, FlashArray and Exchange
- Update from SDK 1.x --> 2.x
- Improved error handling
- Updated Get-Help
### Release History
- [PowerShell Toolkit 3.0.1](https://github.com/PureStorage-OpenConnect/powershell-toolkit-3/releases/latest)
### Release Compatibility
- This release requires PowerShell 5.1 or higher.
- This release requires .NET 4.5 minimum.
- This release is compatible with the PowerShell SDK 2.16.12.0 and later. You can install the latest using
```powershell
Install-Module PureStoragePowerShellSDK2 -force
```
- Database Tools module is compatible with dbatools 1.0.173 and later.
- This release requires a 64-bit operating system.
### Install and Uninstall
The very latest versions of the Toolkit are always available in this repository and in the PowerShell Gallery. There may be multiple branches that may contain alpha or beta code. The default "main" branch contains "stable" code. The Pure Storage PowerShell Toolkit is also distrbuted through the [PowerShell Gallery](https://www.powershellgallery.com/packages/PureStoragePowerShellToolkit).
The tookit requires the PureStoragePowerShellSDK2 module by default for any functions that connect to a FlashArray. Other modules are also used for further functionaility with SQL Server, Excel output, etc. A built-in global function will attempt to download and install them if they are not present when the cmdlet is launched.
- [Pure Storage PowerShell SDK 2](https://www.powershellgallery.com/packages/PureStoragePowerShellSDK2/) (Required)
- [dbatools](https://www.powershellgallery.com/packages/dbatools/) (Required to use Database Tools module. Module will be automatically installed.)
To install the Pure Storage PowerShell Toolkit, open up an elevated Windows PowerShell session and type:
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Install-Module -Name PureStoragePowerShellToolkit
```
To verify the installation:
```powershell
Get-Module -Name PureStoragePowerShellToolkit
```
To load the module:
```powershell
Import-Module -Name PureStoragePowerShellToolkit
```
To see the available cmdlets, you must either use a wildcard query or specify the module (flasharray, core, databasetools, exchange, windowsadministration:
```powershell
Get-Command -Module PureStoragePowerShellToolkit*
```
or
```powershell
Get-Command -Module PureStoragePowerShellToolkit.flasharray
```
To uninstall the module:
```powershell
Uninstall-Module -Module PureStoragePowerShellToolkit
```
### Issues
[PowerShell Toolkit 2.0 issues](https://github.com/PureStorage-OpenConnect/powershell-toolkit/issues) will be triaged and moved to the Toolkit 3.0 issues as appropriate.
### Please contribute!!
We welcome Pull Requests, issues, and open discussions around the toolkit. Help make the toolkit an invaluable tool!
### Pure/Code()
[Join the Pure Storage Code Slack team](https://codeinvite.purestorage.com)