PureStorage.Pure1.psm1
|
function New-PureOneCertificate { <# .SYNOPSIS Creates a new certificate for use in authentication with Pure1. .DESCRIPTION Creates a properly formatted RSA 256 certificate .INPUTS Certificate store (optional) .OUTPUTS Returns the certificate .EXAMPLE PS C:\ New-PureOneCertificate Creates a properly formatted self-signed certificate for Pure1 authentication. Defaults to certificate store of cert:\currentuser\my .EXAMPLE PS C:\ New-PureOneCertificate -certificateStore cert:\localmachine\my Creates a properly formatted self-signed certificate for Pure1 authentication. Uses the specifed certificate store. Non-default stores usually require running as administrator. .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 12/08/2019 Purpose/Change: Added 2012 r2 support *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding()] Param( [Parameter(Position=0)] [String]$certificateStore = "cert:\currentuser\my" ) if (([System.Environment]::OSVersion.Version).Major -eq 6) { #For Windows 2012 support--less specific but the default certificate still works. $CertObj = New-SelfSignedCertificate -certstorelocation $certificateStore -DnsName PureOneCert } else { $policies = [System.Security.Cryptography.CngExportPolicies]::AllowPlaintextExport,[System.Security.Cryptography.CngExportPolicies]::AllowExport $CertObj = New-SelfSignedCertificate -certstorelocation $certificateStore -HashAlgorithm "SHA256" -KeyLength 2048 -KeyAlgorithm RSA -KeyUsage DigitalSignature -KeyExportPolicy $policies -Subject "PureOneCert" -ErrorAction Stop } return $CertObj } function Get-PureOnePublicKey { <# .SYNOPSIS Retrives and formats a PEM based Public Key from a Windows-based certificate .DESCRIPTION Pulls out the public key and formats it in INT 64 PEM encoding for use in Pure1 .INPUTS Certificate .OUTPUTS Returns the PEM based public key .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ $cert | Get-PureOnePublicKey Returns the PEM formatted Public Key of the certificate passed in via piping so that it can be entered in Pure1. .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ Get-PureOnePublicKey -certificate $cert Returns the PEM formatted Public Key of the certificate passed in so that it can be entered in Pure1. .NOTES Version: 1.0 Author: Cody Hosterman https://codyhosterman.com Creation Date: 12/02/2019 Purpose/Change: Initial script development *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding()] Param( [Parameter(Position=0,ValueFromPipeline=$True,mandatory=$True)] [System.Security.Cryptography.X509Certificates.X509Certificate]$certificate ) $certRaw = ([System.Convert]::ToBase64String($certificate.PublicKey.EncodedKeyValue.RawData)).tostring() return ("-----BEGIN PUBLIC KEY-----`n" + "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A" + $certRaw + "`n-----END PUBLIC KEY-----") } function New-PureOneJwt { <# .SYNOPSIS Takes in a Pure1 Application ID and certificate to create a JSON Web Token. .DESCRIPTION Takes in a Pure1 Application ID and certificate to create a JSON Web Token that is valid for by default 30 days, but is extended if a custom expiration is passed in. Can also take in a private key in lieu of the full cert. Will reject if the private key is not properly formatted. .INPUTS Pure1 Application ID, an expiration, and a certificate or a private key. .OUTPUTS Returns the JSON Web Token as a string. .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ New-PureOneJwt -certificate $cert -pureAppID pure1:apikey:v4u3ZXXXXXXXXC6o Returns a JSON Web Token that can be used to create a Pure1 REST session. A JWT generated with no specificed expiration is valid for 30 days. .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ New-PureOneJwt -certificate $cert -pureAppID pure1:apikey:v4u3ZXXXXXXXXC6o -expiration ((get-date).addDays(2)) Returns a JSON Web Token that can be used to create a Pure1 REST session. An expiration was set for two days for now, so this JWT will be valid to create new REST sessions for 48 hours. .NOTES Version: 1.0 Author: Cody Hosterman https://codyhosterman.com Creation Date: 12/02/2019 Purpose/Change: Initial script development *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding()] Param( [Parameter(Position=0,ValueFromPipeline=$True)] [System.Security.Cryptography.X509Certificates.X509Certificate]$certificate, [Parameter(Position=1,mandatory=$True)] [string]$pureAppID, [Parameter(Position=2,ValueFromPipeline=$True)] [System.Security.Cryptography.RSA]$privateKey, [Parameter(Position=3,ValueFromPipeline=$True)] [System.DateTime]$expiration ) if (($null -eq $privateKey) -and ($null -eq $certificate)) { throw "You must pass in a x509 certificate or a RSA Private Key" } #checking for certificate accuracy if ($null -ne $certificate) { if ($certificate.HasPrivateKey -ne $true) { throw "There is no private key associated with this certificate. Please regenerate certificate with a private key." } if ($null -ne $certificate.PrivateKey) { $privateKey = $certificate.PrivateKey } else { try { $privateKey = [System.Security.Cryptography.X509Certificates.RSACertificateExtensions]::GetRSAPrivateKey($certificate) } catch { throw "Could not obtain the private key from the certificate. Please re-run this cmdlet from a PowerShell session started with administrative rights or ensure you have Read Only or higher rights to the certificate." } } } #checking for correct private key type. Must be SHA-256, 2048 bit. if ($null -ne $privateKey) { if ($privateKey.KeySize -ne 2048) { throw "The key must be 2048 bit. It is currently $($privateKey.KeySize)" } if ($privateKey.SignatureAlgorithm -ne "RSA") { throw "This key is not an RSA-based key." } } $pureHeader = '{"alg":"RS256","typ":"JWT"}' $curTime = (Get-Date).ToUniversalTime() $curTime = [Math]::Floor([decimal](Get-Date($curTime) -UFormat "%s")) if ($null -eq $expiration) { $expTime = $curTime + 2592000 } else { $expTime = $expiration.ToUniversalTime() $expTime = [Math]::Floor([decimal](Get-Date($expTime) -UFormat "%s")) } $payloadJson = '{"iss":"' + $pureAppID + '","iat":' + $curTime + ',"exp":' + $expTime + '}' $encodedHeader = [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($pureHeader)) -replace '\+','-' -replace '/','_' -replace '=' $encodedPayload = [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($payloadJson)) -replace '\+','-' -replace '/','_' -replace '=' $toSign = $encodedHeader + '.' + $encodedPayload $toSignEncoded = [System.Text.Encoding]::UTF8.GetBytes($toSign) $signature = [Convert]::ToBase64String($privateKey.SignData($toSignEncoded,[Security.Cryptography.HashAlgorithmName]::SHA256,[Security.Cryptography.RSASignaturePadding]::Pkcs1)) -replace '\+','-' -replace '/','_' -replace '=' $jwt = $toSign + '.' + $signature return $jwt } function New-PureOneRestConnection { <# .SYNOPSIS Takes in a Pure1 Application ID and certificate to create a 10 hour access token. .DESCRIPTION Takes in a Pure1 Application ID and certificate to create a 10 hour access token. Can also take in a private key in lieu of the full cert. Will reject if the private key is not properly formatted. .INPUTS Pure1 Application ID, a certificate or a private key. .OUTPUTS Does not return anything--it stores the Pure1 REST access token in a global variable called $global:pureOneRestHeader. Valid for 10 hours. .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ $cert | New-PureOneRestConnection -pureAppID pure1:apikey:PZogg67LcjImYTiI Create a Pure1 REST connection using a passed in certificate and the specified Pure1 App ID .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ $privateKey = [System.Security.Cryptography.X509Certificates.RSACertificateExtensions]::GetRSAPrivateKey($cert) PS C:\ $privateKey | New-PureOneRestConnection -pureAppID pure1:apikey:PZogg67LcjImYTiI Create a Pure1 REST connection using a passed in private key and the specified Pure1 App ID .NOTES Version: 1.2 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Parameter sets/examples *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='Certificate')] Param( [Parameter(Position=0,ValueFromPipeline=$True,mandatory=$True,ParameterSetName='Certificate')] [System.Security.Cryptography.X509Certificates.X509Certificate]$certificate, [Parameter(Position=1,mandatory=$True,ParameterSetName='Certificate')] [Parameter(Position=1,mandatory=$True,ParameterSetName='PrivateKey')] [string]$pureAppID, [Parameter(Position=2,ValueFromPipeline=$True,mandatory=$True,ParameterSetName='PrivateKey')] [System.Security.Cryptography.RSA]$privateKey ) if ($null -eq $certificate) { $jwt = New-PureOneJwt -privateKey $privateKey -pureAppID $pureAppID -expiration ((Get-Date).AddSeconds(60)) } else { $jwt = New-PureOneJwt -certificate $certificate -pureAppID $pureAppID -expiration ((Get-Date).AddSeconds(60)) } $apiendpoint = "https://api.pure1.purestorage.com/oauth2/1.0/token" $AuthAction = @{ grant_type = "urn:ietf:params:oauth:grant-type:token-exchange" subject_token = $jwt subject_token_type = "urn:ietf:params:oauth:token-type:jwt" } $pureOnetoken = Invoke-RestMethod -Method Post -Uri $apiendpoint -ContentType "application/x-www-form-urlencoded" -Body $AuthAction $Global:pureOneRestHeader = @{authorization="Bearer $($pureOnetoken.access_token)"} } function Get-PureOneArray { <# .SYNOPSIS Returns all Pure Storage arrays listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage arrays listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are array type, array name, and Pure1 access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneArray Returns all arrays in Pure1 organization .EXAMPLE PS C:\ Get-PureOneArray -arrayProduct FlashBlade Returns all FlashBlades in Pure1 organization .EXAMPLE PS C:\ Get-PureOneArray -arrayId ef9d6965-7e16-4d46-9425-d2fea48a8fe5 Returns array with specified ID .EXAMPLE PS C:\ Get-PureOneArray -arrayName sn1-m20r2-c05-36 Returns array with specified name .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Parameter sets *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='All')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='Name')] [string]$arrayName, [Parameter(Position=1,mandatory=$True,ParameterSetName='Product')] [ValidateSet('Purity//FA','Purity//FB','FlashArray','FlashBlade')] [string]$arrayProduct, [Parameter(Position=2,mandatory=$True,ParameterSetName='ID')] [string]$arrayId, [Parameter(Position=3,ParameterSetName='ID')] [Parameter(Position=3,ParameterSetName='Name')] [Parameter(Position=3,ParameterSetName='Product')] [Parameter(Position=3,ParameterSetName='All')] [string]$pureOneToken ) Begin{ if ($arrayProduct -ne "") { switch ($arrayProduct) { "FlashArray" {$arrayProduct = 'Purity//FA'; break} "FlashBlade" {$arrayProduct = 'Purity//FB'; break} } } if ($arrayName -ne "") { $restQuery = "?names=`'$($arrayName)`'" } if ($arrayProduct -ne "") { $restQuery = "?filter=os=`'$($arrayProduct)`'" } if ($arrayId -ne "") { $restQuery = "?ids=`'$($arrayId)`'" } $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/arrays" + $restQuery $pureArrays = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureArrays.items } } function New-PureOneRestOperation { <# .SYNOPSIS Allows you to run a Pure1 REST operation that has not yet been built into this module. .DESCRIPTION Runs a REST operation to Pure1 .INPUTS A filter/query, an resource, a REST body, and optionally an access token. .OUTPUTS Returns Pure1 REST response. .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ $cert | New-PureOneRestConnection -pureAppID pure1:apikey:PZogg67LcjImYTiI PS C:\ New-PureOneRestOperation -resourceType volumes -restOperationType GET Create a Pure1 REST connection and requests all volumes .EXAMPLE PS C:\ $cert = New-PureOneCertificate PS C:\ $cert | New-PureOneRestConnection -pureAppID pure1:apikey:PZogg67LcjImYTiI PS C:\ New-PureOneRestOperation -resourceType arrays -restOperationType GET Create a Pure1 REST connection and requests all arrays .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Added continuation token support *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding()] Param( [Parameter(Position=0,mandatory=$True)] [string]$resourceType, [Parameter(Position=1)] [string]$queryFilter, [Parameter(Position=2)] [string]$jsonBody, [Parameter(Position=3,mandatory=$True)] [ValidateSet('POST','GET','DELETE','PUT')] [string]$restOperationType, [Parameter(Position=4)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/" + $resourceType + $queryFilter if ($jsonBody -ne "") { $pureResponse = Invoke-RestMethod -Method $restOperationType -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader -Body $jsonBody $pureObjects = $pureResponse.items } else { $pureResponse = Invoke-RestMethod -Method $restOperationType -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader $pureObjects = $pureResponse.items while ($null -ne $pureResponse.continuation_token) { $continuationToken = $pureResponse.continuation_token if ($queryFilter -eq "") { $apiendpoint = $apiendpoint + "?" } $apiendpoint = $apiendpoint + "&continuation_token=`'$($continuationToken)`'" $pureResponse = Invoke-RestMethod -Method $restOperationType -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader $pureObjects += $pureResponse.items } } } End{ return $pureObjects } } function Get-PureOneArrayTag { <# .SYNOPSIS Gets a tag for a given array or arrays in Pure1 .DESCRIPTION Gets a tag for a given array or arrays in Pure1 .INPUTS Array name(s) or ID(s) and optionally a tag key name and/or an access token. .OUTPUTS Returns the Pure Storage array(s) key/value tag information in Pure1. .EXAMPLE PS C:\ Get-PureOneArrayTag Returns all tags .EXAMPLE PS C:\ Get-PureOneArrayTag -tagKey owner Returns all tags with the key of "owner" .EXAMPLE PS C:\ Get-PureOneArrayTag -arrayNames flasharray-m50-2 Returns all matching tags on array with specified name .EXAMPLE PS C:\ Get-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d Returns matching tags with key of "owner" on array with specified ID .EXAMPLE PS C:\ Get-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d,e8998e19-aa08-45db-8bd0-4ea9171277a3 Returns matching tags with key of "owner" on the arrays with specified IDs .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Parameter sets added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='TagKey')] Param( [Parameter(Position=0,ParameterSetName='ArrayNames')] [string[]]$arrayNames, [Parameter(Position=1,ParameterSetName='ArrayIDs')] [string[]]$arrayIds, [Parameter(Position=2,ParameterSetName='ArrayIDs')] [Parameter(Position=2,ParameterSetName='ArrayNames')] [Parameter(Position=2,ParameterSetName='TagKey')] [string]$tagKey, [Parameter(Position=3)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ if ($arrayNames.count -gt 0) { $objectQuery = "resource_names=" for ($i=0;$i -lt $arrayNames.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayNames[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayNames[$i])`'" } } } if ($arrayIds.Count -gt 0) { $objectQuery = "resource_ids=" for ($i=0;$i -lt $arrayIds.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayIds[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayIds[$i])`'" } } } if ($tagKey -ne "") { $keyQuery = "?keys=`'$($tagKey)`'" if (($arrayNames.count -gt 0) -or ($arrayIds.count -gt 0)) { $keyQuery = $keyQuery + "&" } } else { $keyQuery = "?" } write-host $apiendpoint $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/arrays/tags" + $keyQuery + $objectQuery $pureArrayTags = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureArrayTags.items } } function Set-PureOneArrayTag { <# .SYNOPSIS Sets/updates a tag for a given array or arrays in Pure1 .DESCRIPTION Sets/updates a tag for a given array or arrays in Pure1 .INPUTS Array name(s) or ID(s) and a tag key name/value and/or optionally an access token. .OUTPUTS Returns the Pure Storage array(s) key/value tag information in Pure1. .EXAMPLE PS C:\ Set-PureOneArrayTag -tagKey owner -tagValue cody -arrayNames flasharray-m50-2 Creates/updates tag on array with specified name .EXAMPLE PS C:\ Set-PureOneArrayTag -tagKey owner -tagValue cody -arrayNames flasharray-m50-2,flasharray-m50-1 Creates/updates tag on specified arrays .EXAMPLE PS C:\ Set-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d Creates/updates tag on array with specified ID .EXAMPLE PS C:\ Set-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d,e8998e19-aa08-45db-8bd0-4ea9171277a3 Creates/updates tag on the arrays with specified IDs .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Parameter sets added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ArrayNames')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='ArrayNames')] [string[]]$arrayNames, [Parameter(Position=1,mandatory=$True,ParameterSetName='ArrayIDs')] [string[]]$arrayIds, [Parameter(Position=2,mandatory=$True,ParameterSetName='ArrayIDs')] [Parameter(Position=2,mandatory=$True,ParameterSetName='ArrayNames')] [string]$tagKey, [Parameter(Position=3,mandatory=$True,ParameterSetName='ArrayIDs')] [Parameter(Position=3,mandatory=$True,ParameterSetName='ArrayNames')] [string]$tagValue, [Parameter(Position=4)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ if ($arrayNames.count -gt 0) { $objectQuery = "?resource_names=" for ($i=0;$i -lt $arrayNames.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayNames[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayNames[$i])`'" } } } if ($arrayIds.Count -gt 0) { $objectQuery = "?resource_ids=" for ($i=0;$i -lt $arrayIds.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayIds[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayIds[$i])`'" } } } $newTag = @{ key = ${tagKey} value = ${tagValue} } $newTagJson = $newTag |ConvertTo-Json $newTagJson = "[" + $newTagJson + "]" $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/arrays/tags/batch" + $objectQuery $pureArrayTags = Invoke-RestMethod -Method PUT -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader -Body $newTagJson } End{ return $pureArrayTags.items } } function Remove-PureOneArrayTag { <# .SYNOPSIS Removes one or more tags for a given array or arrays in Pure1 .DESCRIPTION Removes one or more tags for a given array or arrays in Pure1 .INPUTS Array name(s) or ID(s) and one or more tag key names and/or optionally an access token. If you do not enter a key name, all tags for the input arrays will be removed. .OUTPUTS Returns nothing. .EXAMPLE PS C:\ Remove-PureOneArrayTag -tagKey owner -arrayNames flasharray-m50-2 Removes all matching tags on array with specified name .EXAMPLE PS C:\ Remove-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d Removes matching tags with key of "owner" on array with specified ID .EXAMPLE PS C:\ Remove-PureOneArrayTag -tagKey owner -arrayIds aad42743-611e-45ac-8b93-a869c4728a1d,e8998e19-aa08-45db-8bd0-4ea9171277a3 Removes matching tags with key of "owner" on the arrays with specified IDs .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/26/2020 Purpose/Change: Parameter sets/example added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ArrayNames')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='ArrayNames')] [string[]]$arrayNames, [Parameter(Position=1,mandatory=$True,ParameterSetName='ArrayIDs')] [string[]]$arrayIds, [Parameter(Position=2,mandatory=$True,ParameterSetName='ArrayIDs')] [Parameter(Position=2,mandatory=$True,ParameterSetName='ArrayNames')] [string]$tagKeys, [Parameter(Position=3)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ if ($arrayNames.count -gt 0) { $objectQuery = "?resource_names=" for ($i=0;$i -lt $arrayNames.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayNames[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayNames[$i])`'" } } } if ($arrayIds.Count -gt 0) { $objectQuery = "?resource_ids=" for ($i=0;$i -lt $arrayIds.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($arrayIds[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($arrayIds[$i])`'" } } } if ($tagKeys.Count -gt 0) { $objectQuery = $objectQuery + "&keys=" for ($i=0;$i -lt $tagKeys.count; $i++) { if ($i-eq 0) { $objectQuery = $objectQuery + "`'$($tagKeys[$i])`'" } else { $objectQuery = $objectQuery + ",`'$($tagKeys[$i])`'" } } } $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/arrays/tags" + $objectQuery $pureArrayTags = Invoke-RestMethod -Method Delete -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureArrayTags } } function Get-PureOneArrayNetworking { <# .SYNOPSIS Returns the networking information for a given array in Pure1 .DESCRIPTION Returns the the networking information for a given array in Pure1 .INPUTS Array name or ID and optionally access token. .OUTPUTS Returns the Pure Storage array network information in Pure1. .EXAMPLE PS C:\ Get-PureOneArrayNetworking -arrayName sn1-m20-c08-17 Returns the networking information for all network interfaces .EXAMPLE PS C:\ Get-PureOneArrayNetworking -arrayName sn1-m20-c08-17 -virtualIP Returns the networking information for virtual IP interfaces .EXAMPLE PS C:\ Get-PureOneArrayNetworking -arrayName sn1-m20-c08-17 -service iscsi Returns the networking information for iscsi interfaces .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/27/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ArrayName')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='ArrayName')] [string]$arrayName, [Parameter(Position=1,mandatory=$True,ParameterSetName='ArrayID')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='ArrayID')] [Parameter(Position=2,ParameterSetName='ArrayName')] [Switch]$virtualIP, [Parameter(Position=3,ParameterSetName='ArrayID')] [Parameter(Position=3,ParameterSetName='ArrayName')] [string]$service, [Parameter(Position=4)] [string]$pureOneToken ) Begin{ if (($virtualIP -eq $true) -and (($service -ne "management") -and ($service -ne "") )) { throw "Virtual IPs are only management-based services, so you cannot request virtual IPs with $($service) as the service" } $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $restQuery = "?" if ($virtualIP -eq $true) { $restQuery = $restQuery + "names=`'vir1`',`'vir0`'&" } if ($arrayName -ne "") { #URL encoding the square brackets as some network do not pass them properly $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayId)`'" } if ($service -ne "") { $restQuery = $restQuery + ([System.Web.HttpUtility]::Urlencode(" and services[any]")) + "=`'$($service)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/network-interfaces" + $restQuery $pureArrayNetwork = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader if ($pureArrayNetwork.items.count -lt 1) { throw "No networking information found. The specificied service: [$($service)] might not exist on this array or it might be misspelled" } } End{ return $pureArrayNetwork.items } } function Get-PureOneMetricDetail { <# .SYNOPSIS Returns the available metrics in Pure1 .DESCRIPTION Returns the available metrics in Pure1 and their specifics .INPUTS Resource type or metric name and/or access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneMetricDetail Returns the details for all available metrics .EXAMPLE PS C:\ Get-PureOneMetricDetail -resourceType volumes Returns the details for all available volume-based metrics .EXAMPLE PS C:\ Get-PureOneMetricDetail -metricName pod_write_qos_rate_limit_time_us Returns the details for the metric named pod_write_qos_rate_limit_time_us .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/27/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ResourceType')] Param( [Parameter(Position=0,ParameterSetName='MetricName')] [string]$metricName, [Parameter(Position=1,ParameterSetName='ResourceType')] [string]$resourceType, [Parameter(Position=2)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $restQuery = "?" if ($resourceType -ne "") { $restQuery = $restQuery + "resource_types=`'$($resourceType)`'&" } if ($metricName -ne "") { $restQuery = $restQuery +"names=`'$($metricName)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/metrics" + $restQuery $pureOneMetrics = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureOneMetrics.items } } function Get-PureOneMetric { <# .SYNOPSIS Returns the metrics for a given array in Pure1 .DESCRIPTION Returns the metrics for a given array in Pure1, either an average or a maximum of a given time period. Default behavior is to return the average. .INPUTS Required: resource name or ID and metric name. Optional: timeframe, granularity, and aggregation type (if none entered defaults will be used based on metric entered). Also optionally an access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneMetric -metricName array_read_iops -objectName sn1-x70-c05-33 Returns all data points available for the specified metric on the target object (in this case read IOPs for the array) .EXAMPLE PS C:\ Get-PureOneMetric -metricName array_read_iops -objectName sn1-x70-c05-33 -maximum Returns all maximum data points (no average taken, the highest value instead is used) available for the specified metric on the target object (in this case read IOPs for the array) .EXAMPLE PS C:\ Get-PureOneMetric -metricName array_read_iops -objectName sn1-x70-c05-33 -startTime (get-date).AddDays(-10) Returns all data points for the last 10 days for the specified metric on the target object (in this case read IOPs for the array) .EXAMPLE PS C:\ Get-PureOneMetric -metricName array_read_iops -objectName sn1-x70-c05-33 -startTime (get-date).AddDays(-7) -endTime (get-date).AddDays(-6) Returns all data points for the the one day a week prior for the specified metric on the target object (in this case read IOPs for the array) .EXAMPLE PS C:\ Get-PureOneMetric -metricName array_read_iops -objectName sn1-x70-c05-33 -startTime (get-date).AddDays(-7) -endTime (get-date).AddDays(-6) -granularity 3600000 -maximum Returns the highest valued data point per hour (every 3,600,000 milliseconds) for the the one day a week prior for the specified metric on the target object (in this case read IOPs for the array) .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/27/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ObjectNameAvg')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='ObjectNameAvg')] [Parameter(Position=0,mandatory=$True,ParameterSetName='ObjectNameMax')] [string]$objectName, [Parameter(Position=1,mandatory=$True,ParameterSetName='ObjectIDAvg')] [Parameter(Position=1,mandatory=$True,ParameterSetName='ObjectIDMax')] [string]$objectId, [Parameter(Position=2,ParameterSetName='ObjectIDAvg')] [Parameter(Position=2,ParameterSetName='ObjectNameAvg')] [switch]$average, [Parameter(Position=3,ParameterSetName='ObjectIDMax')] [Parameter(Position=3,ParameterSetName='ObjectNameMax')] [switch]$maximum, [Parameter(Position=4,mandatory=$True)] [string]$metricName, [Parameter(Position=5)] [System.DateTime]$startTime, [Parameter(Position=6)] [System.DateTime]$endTime, [Parameter(Position=7)] [Int64]$granularity, [Parameter(Position=8)] [string]$pureOneToken ) Begin{ if (($average -eq $false) -and ($maximum -eq $false)) { #defaulting to average if neither option is entered $average = $true } $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ #get metric rules $metricDetails = Get-PureOneMetricDetail -metricName $metricName #set granularity if not set if ($granularity -eq 0) { $granularity = $metricDetails.availabilities.resolution } #set end time to start time minus retention for that stat (if not entered) and convert to epoch time if ($endTime -eq $null) { $endTime = Get-Date $endTime = $endTime.ToUniversalTime() } else { $endTime = $endTime.ToUniversalTime() } [datetime]$epoch = '1970-01-01 00:00:00' $endEpoch = (New-TimeSpan -Start $epoch -End $endTime).TotalMilliSeconds $endEpoch = [math]::Round($endEpoch) #set start time to current time (if not entered) and convert to epoch time if ($startTime -eq $null) { $startTime = $epoch.AddMilliseconds($metricDetails._as_of - $metricDetails.availabilities.retention) } else { $startTime = $startTime.ToUniversalTime() } $startEpoch = (New-TimeSpan -Start $epoch -End $startTime).TotalMilliSeconds $startEpoch = [math]::Round($startEpoch) #building query if ($average -eq $true) { $restQuery = "?aggregation='avg'&end_time=$($endEpoch)&names=`'$($metricName)`'&resolution=$($granularity)&start_time=$($startEpoch)&" } else { $restQuery = "?aggregation='max'&end_time=$($endEpoch)&names=`'$($metricName)`'&resolution=$($granularity)&start_time=$($startEpoch)&" } if ($objectName -ne "") { $restQuery = $restQuery + "resource_names=`'$($objectName)`'" } else { $restQuery = $restQuery + "ids=`'$($objectId)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/metrics/history" + $restQuery $pureOneMetrics = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureOneMetrics.items } } function Get-PureOneVolume { <# .SYNOPSIS Returns all Pure Storage volumes listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage volumes listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are array type, array name, and Pure1 access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneVolume Get all volumes on all FlashArrays. .EXAMPLE PS C:\ Get-PureOneVolume -arrayName sn1-x70-b05-33 Get all volumes on specified FlashArray. .EXAMPLE PS C:\ Get-PureOneVolume -volumeName myVolume-01 Get all volumes with the specified name. If the same name exists on two more more arrays, all objects will be returned. .EXAMPLE PS C:\ Get-PureOneVolume -volumeName myVolume-01 -arrayName sn1-x70-b05-33 Get the volume with the specified name if it exists on that array. .EXAMPLE PS C:\ Get-PureOneVolume -volumeSerial 1037B35FD0EF40A500C65559 Get the volume with the specified serial number. .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/27/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='ArrayNameVolName')] Param( [Parameter(Position=0,ParameterSetName='ArrayNameVolName')] [Parameter(Position=0,ParameterSetName='ArrayNameVolSerial')] [string]$arrayName, [Parameter(Position=1,ParameterSetName='ArrayIDVolName')] [Parameter(Position=1,mandatory=$True,ParameterSetName='ArrayIDVolSerial')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='ArrayIDVolName')] [Parameter(Position=2,ParameterSetName='ArrayNameVolName')] [string]$volumeName, [Parameter(Position=3,ParameterSetName='ArrayIDVolSerial')] [Parameter(Position=3,ParameterSetName='ArrayNameVolSerial')] [string]$volumeSerial, [Parameter(Position=4)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ if ($null -ne $global:pureOneRateLimit) { if ($Global:pureOneRateLimit -in 1..1000) { $restQuery = "?limit=$($global:pureOneRateLimit)&" } else { throw "Pure1 Rate limit set to invalid amount. Must be between 1-1000. Currently set to $($global:pureOneRateLimit)" } } else { $restQuery = "?" } if ($volumeName -ne "") { $restQuery = $restQuery + "names=`'$($volumeName)`'" if (($arrayName -ne "") -or ($arrayId -ne "")) { $restQuery = $restQuery + "&" } } elseif ($volumeSerial -ne "") { $volumeSerial = $volumeSerial.ToUpper() $restQuery = $restQuery +"filter=serial=`'$($volumeSerial)`'" if ($arrayName -ne "") { $restQuery = $restQuery + ([System.Web.HttpUtility]::Urlencode(" and arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + ([System.Web.HttpUtility]::Urlencode(" and arrays[any].id")) + "=`'$($arrayId)`'" } } if ($volumeSerial -eq "") { if ($arrayName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].id")) + "=`'$($arrayId)`'" } } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/volumes" + $restQuery write-debug $apiendpoint $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader write-debug $pureResponse $pureVolumes = $pureResponse.items while ($null -ne $pureResponse.continuation_token) { $continuationToken = $pureResponse.continuation_token $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/volumes" + $restQuery + "&continuation_token=`'$($continuationToken)`'" write-debug $apiendpoint try { $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader -ErrorAction stop write-debug $pureResponse $pureVolumes += $pureResponse.items } catch { if ($_.Exception -like "*The remote server returned an error: (504) Gateway Timeout.*") { Write-Warning -Message "The remote server returned an error: (504) Gateway Timeout. Pausing briefly and re-trying." start-sleep 5 } elseif ((convertfrom-json -inputobject $_.ErrorDetails.Message).Message -eq "API org rate limit exceeded") { Write-Warning -Message "Pure1 API rate limit exceeded. Sleeping briefly to reset counter." start-sleep 5 } continue } } } End{ return $pureVolumes } } function Get-PureOnePod { <# .SYNOPSIS Returns all Pure Storage pods listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage pods listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are pod name, array name or ID, and Pure1 access token. .OUTPUTS Returns the Pure Storage pod information in Pure1. .EXAMPLE PS C:\ Get-PureOnePod Returns all pods on all FlashArrays .EXAMPLE PS C:\ Get-PureOnePod -arrayId 2dcf29ad-6aca-4913-b62e-a15875c6635f Returns all pods on FlashArray with specified ID .EXAMPLE PS C:\ Get-PureOnePod -podName newpod Returns all pods with the specified name .EXAMPLE PS C:\ Get-PureOnePod -podName newpod -arrayName sn1-m20-c12-25 Returns the pod with the specified name on the specified FlashArray .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/27/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='Pod')] Param( [Parameter(Position=0,ParameterSetName='ArrayName')] [Parameter(Position=0,ParameterSetName='Pod')] [string]$arrayName, [Parameter(Position=1,ParameterSetName='ArrayId')] [Parameter(Position=1,ParameterSetName='Pod')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='Pod')] [string]$podName, [Parameter(Position=3)] [string]$pureOneToken ) Begin{ if (($null -eq $Global:pureOneRestHeader) -and ($pureOneToken -eq "")) { throw "No access token found in the global variable or passed in. Run the cmdlet New-PureOneRestConnection to authenticate." } if ($null -eq $Global:pureOneRestHeader) { $pureOneHeader = @{authorization="Bearer $($pureOnetoken)"} } elseif (($null -ne $pureOneToken) -and ($pureOneToken -ne "")) { $pureOneHeader = @{authorization="Bearer $($pureOnetoken)"} } else { $pureOneHeader = $Global:pureOneRestHeader } } Process{ $restQuery = "?" if ($podName -ne "") { $restQuery = $restQuery + "names=`'$($podName)`'" if (($arrayName -ne "") -or ($arrayId -ne "")) { $restQuery = $restQuery + "&" } } if ($arrayName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].id")) + "=`'$($arrayId)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/1.0/pods" + $restQuery $purePods = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $purePods.items } } function Get-PureOneVolumeSnapshot { <# .SYNOPSIS Returns all Pure Storage volume snapshots listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage volume snapshots listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are array type, array name, volume name, snapshot name or snapshot serial, or Pure1 access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneVolumeSnapshot Returns all snapshots on all FlashArrays .EXAMPLE PS C:\ Get-PureOneVolumeSnapshot -arrayName flasharray-m50-2 Returns all snapshots on the specified array .EXAMPLE PS C:\ Get-PureOneVolumeSnapshot -snapshotName db-001.test Returns the snapshots with the specified name .EXAMPLE PS C:\ Get-PureOneVolumeSnapshot -volumeName sql00-Backup02 Returns all snapshots for the specified volume .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/29/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='SnapshotName')] Param( [Parameter(Position=0,ParameterSetName='ArrayName')] [string]$arrayName, [Parameter(Position=1,ParameterSetName='ArrayID')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='SnapshotName')] [string]$snapshotName, [Parameter(Position=3,ParameterSetName='SnapshotSerial')] [string]$snapshotSerial, [Parameter(Position=4,ParameterSetName='VolumeName')] [string]$volumeName, [Parameter(Position=5)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ if ($null -ne $global:pureOneRateLimit) { if ($Global:pureOneRateLimit -in 1..1000) { $restQuery = "?limit=$($global:pureOneRateLimit)&" } else { throw "Pure1 Rate limit set to invalid amount. Must be between 1-1000. Currently set to $($global:pureOneRateLimit)" } } else { $restQuery = "?limit=500&" } if ($snapshotName -ne "") { $restQuery = $restQuery + "names=`'$($snapshotName)`'" if (($arrayName -ne "") -or ($arrayId -ne "")) { $restQuery = $restQuery + "&" } } elseif ($snapshotSerial -ne "") { $snapshotSerial = $snapshotSerial.ToUpper() $restQuery = $restQuery +"filter=serial=`'$($snapshotSerial)`'" if ($arrayName -ne "") { $restQuery = $restQuery + ([System.Web.HttpUtility]::Urlencode(" and arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + ([System.Web.HttpUtility]::Urlencode(" and arrays[any].id")) + "=`'$($arrayId)`'" } } if ($snapshotSerial -eq "") { if ($arrayName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].id")) + "=`'$($arrayId)`'" } } if ($volumeName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("source.name")) + "=`'$($volumeName)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/volume-snapshots" + $restQuery Write-Debug $apiendpoint $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader -ErrorAction Stop Write-Debug $pureResponse $pureSnaps = $pureResponse.items while ($null -ne $pureResponse.continuation_token) { $continuationToken = $pureResponse.continuation_token $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/volume-snapshots" + $restQuery + "&continuation_token=`'$($continuationToken)`'" Write-Debug $apiendpoint try { $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader -ErrorAction stop Write-Debug $pureResponse $pureSnaps += $pureResponse.items } catch { if ($_.Exception -like "*The remote server returned an error: (504) Gateway Timeout.*") { Write-Warning -Message "The remote server returned an error: (504) Gateway Timeout. Pausing briefly and re-trying." start-sleep 5 } elseif ((convertfrom-json -inputobject $_.ErrorDetails.Message).Message -eq "API org rate limit exceeded") { Write-Warning -Message "Pure1 API rate limit exceeded. Sleeping briefly to reset counter." start-sleep 5 } continue } } } End{ return $pureSnaps } } function Get-PureOneFileSystem { <# .SYNOPSIS Returns all Pure Storage file systems listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage file systems listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are array type, array name, file system name, or Pure1 access token. .OUTPUTS Returns the Pure Storage array information in Pure1. .EXAMPLE PS C:\ Get-PureOneFileSystem Return all FlashBlade file systems (NFS, SMB, S3) .EXAMPLE PS C:\ Get-PureOneFileSystem Return all FlashBlade file systems (NFS, SMB, S3) .EXAMPLE PS C:\ Get-PureOneFileSystem -fsName fs20 Return the specified FlashBlade file system (NFS, SMB, S3) .EXAMPLE PS C:\ Get-PureOneFileSystem -arrayName sn1-fb-c02-33 Return all FlashBlade file systems on specified array (NFS, SMB, S3) .EXAMPLE PS C:\ Get-PureOneFileSystem -arrayId 0e30e967-d749-4e03-9d32-701eeff14376 Return all FlashBlade file systems on specified array(NFS, SMB, S3) .NOTES Version: 1.0 Author: Cody Hosterman https://codyhosterman.com Creation Date: 01/21/2019 Purpose/Change: Initial script development *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='FileSystem')] Param( [Parameter(Position=0,ParameterSetName='ArrayName')] [string]$arrayName, [Parameter(Position=1,ParameterSetName='ArrayID')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='FileSystem')] [string]$fsName, [Parameter(Position=3)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $restQuery = "?" if ($fsName -ne "") { $restQuery = $restQuery + "names=`'$($fsName)`'" if (($arrayName -ne "") -or ($arrayId -ne "")) { $restQuery = $restQuery + "&" } } if ($arrayName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].id")) + "=`'$($arrayId)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/file-systems" + $restQuery write-debug $apiendpoint $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader write-debug $pureResponse $pureFileSystems = $pureResponse.items while ($null -ne $pureResponse.continuation_token) { $continuationToken = $pureResponse.continuation_token try { $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/file-systems" + $restQuery + "&continuation_token=`'$($continuationToken)`'" write-debug $apiendpoint $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader write-debug $pureResponse $pureFileSystems += $pureResponse.items } catch { if ($_.Exception -like "*The remote server returned an error: (504) Gateway Timeout.*") { Write-Warning -Message "The remote server returned an error: (504) Gateway Timeout. Pausing briefly and re-trying." start-sleep 5 } elseif ((convertfrom-json -inputobject $_.ErrorDetails.Message).Message -eq "API org rate limit exceeded") { Write-Warning -Message "Pure1 API rate limit exceeded. Sleeping briefly to reset counter." start-sleep 5 } continue } } } End{ return $pureFileSystems } } function Get-PureOneFileSystemSnapshot { <# .SYNOPSIS Returns all Pure Storage file system snapshots listed in your Pure1 account. .DESCRIPTION Returns all Pure Storage file system snapshots listed in your Pure1 account. Allows for some filters. .INPUTS None required. Optional inputs are array name, file system name, snapshot name, or Pure1 access token. .OUTPUTS Returns the Pure Storage file system(s) information in Pure1. .EXAMPLE PS C:\ Get-PureOneFileSystemSnapshot Returns all file system snapshots on all FlashBlades .EXAMPLE PS C:\ Get-PureOneFileSystemSnapshot -arrayName sn1-fb-c02-33 Returns all file system snapshots on specified FlashBlade .EXAMPLE PS C:\ Get-PureOneFileSystemSnapshot -snapshotName nbu-msdp-metadata.2020_04_30_00_00 Returns the specified file system snapshot .EXAMPLE PS C:\ Get-PureOneFileSystemSnapshot -fsName nbu-msdp-metadata Returns all snapshots for the specified file system .NOTES Version: 1.1 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/30/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='FileSystemName')] Param( [Parameter(Position=0,ParameterSetName='ArrayName')] [string]$arrayName, [Parameter(Position=1,ParameterSetName='ArrayID')] [string]$arrayId, [Parameter(Position=2,ParameterSetName='SnapshotName')] [string]$snapshotName, [Parameter(Position=3,ParameterSetName='FileSystemName')] [string]$fsName, [Parameter(Position=4)] [string]$pureOneToken ) Begin{ $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ $restQuery = "?" if ($snapshotName -ne "") { $restQuery = $restQuery + "names=`'$($snapshotName)`'" if (($arrayName -ne "") -or ($arrayId -ne "")) { $restQuery = $restQuery + "&" } } if ($arrayName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].name")) + "=`'$($arrayName)`'" } if ($arrayId -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("arrays[any].id")) + "=`'$($arrayId)`'" } if ($fsName -ne "") { $restQuery = $restQuery + "filter=" + ([System.Web.HttpUtility]::Urlencode("source.name")) + "=`'$($fsName)`'" } $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/file-system-snapshots" + $restQuery $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader $pureSnapshots = $pureResponse.items while ($null -ne $pureResponse.continuation_token) { $continuationToken = $pureResponse.continuation_token $apiendpoint = "https://api.pure1.purestorage.com/api/$($global:pureOneRestVersion)/file-system-snapshots" + $restQuery + "&continuation_token=`'$($continuationToken)`'" $pureResponse = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader $pureSnapshots += $pureResponse.items } } End{ return $pureSnapshots } } function Get-PureOneArrayBusyMeter { <# .SYNOPSIS Returns the busy meter for a given array in Pure1 .DESCRIPTION Returns the busy meter for a given array (or arrays) in Pure1, either an average or a maximum of a given time period. Default behavior is to return the average. .INPUTS Required: resource names or IDs--must be an array. Optional: timeframe, granularity, and aggregation type (if none entered defaults will be used based on metric entered). Also optionally an access token. .OUTPUTS Returns the Pure Storage busy meter metric information in Pure1. .EXAMPLE PS C:\ Get-PureOneArrayBusyMeter -objectName flasharray-m50-1 Returns the busy meter at default resolution for all available time, for the specified array. .EXAMPLE PS C:\ Get-PureOneArrayBusyMeter -objectName flasharray-m50-1 -startTime (get-date).AddDays(-10) Returns the busy meter at default resolution for the past ten days, for the specified array. .EXAMPLE PS C:\ Get-PureOneArrayBusyMeter -objectName flasharray-m50-1 -startTime (get-date).AddDays(-2) -endTime (get-date).AddDays(-1) Returns the busy meter at default resolution for one day ending 24 hours ago, for the specified array. .EXAMPLE PS C:\ Get-PureOneArrayBusyMeter -objectName flasharray-m50-1 -startTime (get-date).AddDays(-1) -startTime (get-date).AddDays(-1) -granularity 86400000 -maximum Returns one value for the previous 24 hours, representing the maximum busyness value for the specified array in that window. .NOTES Version: 1.2 Author: Cody Hosterman https://codyhosterman.com Creation Date: 04/30/2020 Purpose/Change: Parameter sets and examples added *******Disclaimer:****************************************************** This scripts are offered "as is" with no warranty. While this scripts is tested and working in my environment, it is recommended that you test this script in a test lab before using in a production environment. Everyone can use the scripts/commands provided here without any written permission but I will not be liable for any damage or loss to the system. ************************************************************************ #> [CmdletBinding(DefaultParameterSetName='objectName')] Param( [Parameter(Position=0,mandatory=$True,ParameterSetName='objectName')] [Parameter(Position=0,mandatory=$True,ParameterSetName='objectNameAVG')] [Parameter(Position=0,mandatory=$True,ParameterSetName='objectNameMAX')] [string[]]$objectName, [Parameter(Position=1,mandatory=$True,ParameterSetName='objectID')] [Parameter(Position=1,mandatory=$True,ParameterSetName='objectIDAVG')] [Parameter(Position=1,mandatory=$True,ParameterSetName='objectIDMAX')] [string[]]$objectId, [Parameter(Position=2,mandatory=$True,ParameterSetName='objectNameAVG')] [Parameter(Position=2,mandatory=$True,ParameterSetName='objectIDAVG')] [switch]$average, [Parameter(Position=2,mandatory=$True,ParameterSetName='objectNameMAX')] [Parameter(Position=2,mandatory=$True,ParameterSetName='objectIDMAX')] [switch]$maximum, [Parameter(Position=5)] [System.DateTime]$startTime, [Parameter(Position=6)] [System.DateTime]$endTime, [Parameter(Position=7)] [Int64]$granularity, [Parameter(Position=8)] [string]$pureOneToken ) Begin{ $metricName = "array_total_load" if (($average -eq $false) -and ($maximum -eq $false)) { #defaulting to average if neither option is entered $average = $true } if (($null -ne $startTime) -and ($null -ne $endTime)) { if ($startTime -ge $endTime) { throw "The specified start time $($startTime) cannot be the same or later than the specified end time $($endTime)" } } $pureOneHeader = Set-PureOneHeader -pureOneToken $pureOneToken -ErrorAction Stop } Process{ #get metric rules $metricDetails = Get-PureOneMetricDetail -metricName $metricName #set granularity if not set if ($granularity -eq 0) { $granularity = $metricDetails.availabilities.resolution } #set end time to start time minus retention for that stat (if not entered) and convert to epoch time if ($endTime -eq $null) { $endTime = Get-Date $endTime = $endTime.ToUniversalTime() } else { $endTime = $endTime.ToUniversalTime() } [datetime]$epoch = '1970-01-01 00:00:00' $endEpoch = (New-TimeSpan -Start $epoch -End $endTime).TotalMilliSeconds $endEpoch = [math]::Round($endEpoch) #set start time to current time (if not entered) and convert to epoch time if ($startTime -eq $null) { $startTime = $epoch.AddMilliseconds($metricDetails._as_of - $metricDetails.availabilities.retention) } else { $startTime = $startTime.ToUniversalTime() } $startEpoch = (New-TimeSpan -Start $epoch -End $startTime).TotalMilliSeconds $startEpoch = [math]::Round($startEpoch) #building query if ($average -eq $true) { $restQuery = "?aggregation='avg'&end_time=$($endEpoch)&names=`'$($metricName)`'&resolution=$($granularity)&start_time=$($startEpoch)&" } else { $restQuery = "?aggregation='max'&end_time=$($endEpoch)&names=`'$($metricName)`'&resolution=$($granularity)&start_time=$($startEpoch)&" } if ($objectName -ne "") { if ($objectName.count -gt 1) { foreach ($arrayName in $objectName) { $pureArrays = $pureArrays + "`'$($arrayName)`'" if ($arrayName -ne ($objectName |Select-Object -Last 1)) { $pureArrays = $pureArrays + "," } } $restQuery = $restQuery + "resource_names=" + $pureArrays } else { $restQuery = $restQuery + "resource_names=`'$($objectName)`'" } } else { if ($objectId.count -gt 1) { foreach ($arrayName in $objectId) { $pureArrays = $pureArrays + "`'$($arrayName)`'" if ($arrayName -ne ($objectId |Select-Object -Last 1)) { $pureArrays = $pureArrays + "," } } $restQuery = $restQuery + "resource_ids=" + $pureArrays } else { $restQuery = $restQuery + "resource_ids=`'$($objectId)`'" } } $apiendpoint = "https://api.pure1.purestorage.com/api/1.latest/metrics/history" + $restQuery $pureOneMetrics = Invoke-RestMethod -Method Get -Uri $apiendpoint -ContentType "application/json" -Headers $pureOneHeader } End{ return $pureOneMetrics.items } } #internal functions function Set-PureOneHeader { [CmdletBinding()] Param( [Parameter(Position=0)] [string]$pureOneToken ) if (($null -eq $Global:pureOneRestHeader) -and ($pureOneToken -eq "")) { throw "No access token found in the global variable or passed in. Run the cmdlet New-PureOneRestConnection to authenticate." } if ($null -eq $Global:pureOneRestHeader) { $pureOneHeader = @{authorization="Bearer $($pureOnetoken)"} } elseif (($null -ne $pureOneToken) -and ($pureOneToken -ne "")) { $pureOneHeader = @{authorization="Bearer $($pureOnetoken)"} } else { $pureOneHeader = $Global:pureOneRestHeader } return $pureOneHeader } #Global variables $global:pureOneRateLimit = $null $global:pureOneRestVersion = "1.latest" |