PowerShell module for managing Pure Storage FlashBlade arrays via the REST API 2.x. Provides 526 cmdlets covering all FlashBlade REST 2.x endpoints with a Connect-PfbArray experience that mirrors the FlashArray PureStoragePowerShellSDK2 module.
- PowerShell 5.1 or later (Windows PowerShell or PowerShell 7+)
- Posh-SSH (optional) — only needed for
-Username/-Password/-Credentialauth against arrays running REST API below 2.26 (Purity//FB < 4.8.1). See Authentication below.
Install-Module -Name PureStorageFlashBladePowerShell -Scope CurrentUser
Import-Module PureStorageFlashBladePowerShellThe repo uses a flat layout (.psd1/.psm1 at the root, alongside Public//Private/);
./scripts/build.ps1 assembles the installable module folder:
# Clone the repository
git clone https://github.com/PureStorage-OpenConnect/flashblade-powershell.git
cd flashblade-powershell
# Build the module folder
./scripts/build.ps1
# Copy the built module to a PSModulePath location
Copy-Item -Recurse .\build\PureStorageFlashBladePowerShell `
"$env:USERPROFILE\Documents\WindowsPowerShell\Modules\PureStorageFlashBladePowerShell"
# Import
Import-Module PureStorageFlashBladePowerShellThe simplest way to connect. Generate a token from the FlashBlade GUI (Settings → Access → API Tokens) or CLI (pureadmin create --api-token).
$array = Connect-PfbArray -Endpoint 10.0.0.1 -ApiToken "T-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -IgnoreCertificateErrorConnect using a local FlashBlade username and password — the same way you'd log into the GUI:
$password = ConvertTo-SecureString "MyPassword" -AsPlainText -Force
$array = Connect-PfbArray -Endpoint 10.0.0.1 -Username "pureuser" -Password $password -IgnoreCertificateErrorHow it works under the hood:
When you provide -Username and -Password, the module checks whether the connected array supports native REST 2.x username/password login (FlashBlade REST API 2.26 / Purity//FB 4.8.1 and later). If so, it POSTs to the /api/login endpoint with { username, password } as a JSON body; the array returns a session token (x-auth-token) used for subsequent calls.
After successful login, the module attempts to retrieve a long-lived API token from /api/<ver>/admins/api-tokens?expose_api_token=true for the connected user. If none exists and the user has admin privileges, the module mints one with a POST to the same endpoint. The cached API token enables automatic reconnection if the session expires mid-run. This mirrors Connect-Pfa2Array from the FlashArray SDK.
SSH fallback for older arrays (< REST API 2.26 / Purity//FB 4.8.1):
FlashBlade has never had a REST-based way to exchange a username/password for a token below that version, so on older arrays -Username/-Password (and -Credential) instead fall back to SSH: the module connects over SSH and runs the pureadmin CLI to retrieve or mint an API token. This path requires the optional Posh-SSH module:
Install-Module -Name Posh-SSH -Scope CurrentUserPosh-SSH is not a hard dependency of this module — it's only imported when the SSH fallback actually runs (i.e., only against arrays below REST API 2.26). If it isn't installed and the fallback is needed, Connect-PfbArray throws an error naming the exact install command, plus non-SSH alternatives (-ApiToken, or certificate/OAuth2 auth). Arrays on REST API 2.26+ never touch this path at all.
Same as username/password, but using a standard PowerShell credential object.
$cred = Get-Credential
$array = Connect-PfbArray -Endpoint 10.0.0.1 -Credential $cred -IgnoreCertificateErrorYou can also pre-cache credentials for reuse across multiple connections:
Set-PfbCredential -Credential (Get-Credential)
$array = Connect-PfbArray -Endpoint 10.0.0.1 -Credential (Get-PfbCredential) -IgnoreCertificateErrorFor automated/service-account workflows using certificate-based authentication:
$array = Connect-PfbArray -Endpoint 10.0.0.1 -Username "pureuser" `
-ClientId "9472190-f792-712e-a639-0839fa830922" `
-Issuer "myapp" -KeyId "e50c1a8f-..." `
-PrivateKeyFile "C:\keys\fb-private.pem" -IgnoreCertificateErrorNote:
-PrivateKeyPassword(encrypted private keys) requires PowerShell 7+. Windows PowerShell 5.1 can only use unencrypted (plain) private key files with this flow; supplying-PrivateKeyPasswordunder Windows PowerShell 5.1 throws a clear error rather than connecting.
Most FlashBlade arrays use self-signed SSL certificates. Pass -IgnoreCertificateError to bypass certificate validation. This is standard for lab and on-prem environments.
# Connect to the array
$array = Connect-PfbArray -Endpoint 10.0.0.1 -ApiToken $token -IgnoreCertificateError
# All subsequent cmdlets use the connection automatically
Get-PfbArray # Array name, model, Purity version
Get-PfbArraySpace # Capacity and usage
Get-PfbHardware # Blades, drives, chassis
# Disconnect when done
Disconnect-PfbArray# List all file systems
Get-PfbFileSystem
# Create a file system (1 TB provisioned)
New-PfbFileSystem -Name "project-data" -Attributes @{ provisioned = 1TB }
# Update properties
Update-PfbFileSystem -Name "project-data" -Attributes @{ provisioned = 2TB }
# Take a snapshot
New-PfbFileSystemSnapshot -SourceName "project-data" -Suffix "daily-backup"
# List snapshots
Get-PfbFileSystemSnapshot
# Clean up
Remove-PfbFileSystemSnapshot -Name "project-data.daily-backup"
Remove-PfbFileSystem -Name "project-data"# List accounts, users, and buckets
Get-PfbObjectStoreAccount
Get-PfbObjectStoreUser
Get-PfbBucket
# Create a bucket
New-PfbBucket -Name "logs-bucket" -Attributes @{ account = "myaccount" }# Filter by name
Get-PfbFileSystem -Filter "name='project-data'"
# Pagination is automatic — all results are returned by default
Get-PfbFileSystemSnapshot # Returns all snapshots, even if >1000# Connect to two arrays
$fb1 = Connect-PfbArray -Endpoint 10.0.0.1 -ApiToken $token1 -IgnoreCertificateError
$fb2 = Connect-PfbArray -Endpoint 10.0.0.2 -ApiToken $token2 -IgnoreCertificateError
# Target a specific array with -Array
Get-PfbFileSystem -Array $fb1
Get-PfbFileSystem -Array $fb2All state-changing cmdlets (New, Update, Remove) support -WhatIf and -Confirm:
# Preview what would happen without making changes
Remove-PfbFileSystem -Name "test-fs" -WhatIf
# Prompt for confirmation before each action
Remove-PfbFileSystem -Name "test-fs" -Confirm| Category | Verbs | Examples |
|---|---|---|
| Array | Get | Get-PfbArray, Get-PfbArraySpace, Get-PfbArrayPerformance |
| File Systems | Get, New, Update, Remove | Get-PfbFileSystem, New-PfbFileSystem |
| Snapshots | Get, New, Remove | Get-PfbFileSystemSnapshot |
| Buckets | Get, New, Update, Remove | Get-PfbBucket, New-PfbBucket |
| Policies | Get, New, Update, Remove | Get-PfbPolicy, New-PfbPolicyFileSystem |
| Network | Get, New, Update, Remove | Get-PfbSubnet, Get-PfbNetworkInterface |
| Hardware | Get | Get-PfbHardware, Get-PfbBlade |
| Admin | Get, New, Update, Remove | Get-PfbAdmin, Get-PfbAdminSetting |
| Replication | Get, New, Update, Remove | Get-PfbBucketReplicaLink, Get-PfbTarget |
| Certificates | Get, New, Update, Remove | Get-PfbCertificate, New-PfbCertificate |
| Support | Get, New, Test, Update | Get-PfbSupport, Test-PfbSupport |
All cmdlets follow the Verb-PfbNoun naming convention. Run Get-Command -Module PureStorageFlashBladePowerShell for the full list.
Connect-PfbArray returns a connection object with these properties (aligned with PureStoragePowerShellSDK2):
| Property | Description |
|---|---|
Endpoint |
Hostname or IP of the connected FlashBlade |
HttpEndpoint |
Full base URL (https://endpoint) |
Username |
Authenticated username |
ApiToken |
API token used for the session |
ApiVersion |
Negotiated REST API version (e.g., 2.12) |
RestApiVersion |
Alias for ApiVersion (Pfa2 compat) |
Every cmdlet has built-in help with examples:
# Detailed help for a specific cmdlet
Get-Help Connect-PfbArray -Full
Get-Help New-PfbFileSystem -Examples
# List all available cmdlets
Get-Command -Module PureStorageFlashBladePowerShell
# List cmdlets for a specific area
Get-Command -Module PureStorageFlashBladePowerShell -Noun PfbFileSystem*
Get-Command -Module PureStorageFlashBladePowerShell -Noun PfbBucket*v2.1.0 was validated on PowerShell 7 (the module runtime supports Windows PowerShell 5.1+).
| Test Area | Result |
|---|---|
| Pester tests | 145 passed, 0 failed, 2 skipped (22 suites, pwsh 7); 143 passed, 0 failed, 4 skipped on Windows PowerShell 5.1 |
| Module loads and exports | 526 cmdlets confirmed |
| Help coverage | 526/526 cmdlets have a Synopsis |
| Naming conventions | 526/526 follow Verb-PfbNoun pattern, all approved verbs |
| ShouldProcess (WhatIf/Confirm) | 304/304 array-mutating cmdlets (the 2 client-side credential cmdlets are exempt) |
| Live verification (PRs #4-8) | Auth flows and affected cmdlets validated against real FlashBlade arrays on both sides of the REST API 2.26 threshold |
- FlashBlade: Purity//FB 3.x and later (REST API 2.x)
- PowerShell: 5.1, 7.0+ (Windows, Linux, macOS)
- Verified against: real FlashBlade arrays on both sides of the REST API 2.26 threshold
This is a complete rewrite. Key changes:
- Module name:
PureStorageFlashBladePowerShell(wasPureFBModule) - API: REST 2.x only (v1.x targeted REST 1.x)
- Authentication: Session-based via
Connect-PfbArray/Disconnect-PfbArray - Cmdlet naming:
Verb-PfbNounpattern withGet,New,Update,Removeverbs
See CHANGELOG.md for the full version history.
Apache License 2.0 — see LICENSE.