Public/Get-PfaChartData.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
function Get-PfaChartData { <# .SYNOPSIS Retrieves all necessary data and preformats for New-PfaChart. .DESCRIPTION Uses Invoke-PfaApiRequest to retrieve data from Array that is preformatted for New-PfaChart. .PARAMETER Array FlashArray object to query. .PARAMETER Credential Username and Password needed for authentication. .PARAMETER Type Specifies the type of chart. Acceptable values are: Dashboard Performance Capacity Replication .PARAMETER ChartName Dynamic Parameter: Specifies the chart name. Only available if Type is Dashboard. Acceptable values are: Overview Capacity .PARAMETER Group Dynamic Parameter: Specifies the chart group. Acceptable values are dependent on which Type is specified. Type: Performance Group can be Array, Volume, Volumes, Volume Groups, and File System, Pods, Directories Type: Capacity Group can be Array, Volumes, Volume Groups, Pods, and Directories Type: Replication Group can be Array or Volume .PARAMETER Historical Specify a different timespan for chart. Acceptable values are 5m, 1h, 3h, 24h, 7d, 30d, 90d, and 1y. Only valid on Performance, Capacity, and Replication Charts. .PARAMETER Filter This parameter is here for future usage (hopefully). Not all API queries support this option. Currently, none used by Get-PfaChartData qualify. .PARAMETER Name This parameter is used to limit queries to specific names. .PARAMETER ApiVersion Optional parameter to specify the REST API version to interact with. .EXAMPLE Retrieve data to create a chart that resembles the "Dashboard -> Capacity" in the Purity//FA UI $DashboardMetrics = Get-PfaChartData -Array $FlashArray -Type Dashboard -ChartName Capacity .EXAMPLE Retrieve data to create a chart that resembles the "Storage -> ArrayName" in the Purity//FA UI $DashboardMetrics = Get-PfaChartData -Array $FlashArray -Type Dashboard -ChartName Overview .NOTES Author: brandon said #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, Position = 0)] [ValidateNotNullOrEmpty()] [PureStorageRestApi]$Array, [Parameter(Mandatory = $false)] [ValidateNotNull()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential, [Parameter(Mandatory = $true, Position = 1)] [ValidateNotNullOrEmpty()] [ValidateSet('Dashboard', 'Performance', 'Capacity', 'Replication')] [String]$Type, [Parameter(Mandatory = $false, Position = 2)] [ValidateNotNullOrEmpty()] [String]$ApiVersion = "2.7" ) DynamicParam { $DynamicParameters = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary if ($Type -eq 'Dashboard') { New-DynamicParameter -Name 'ChartName' -Type ([string]) -Position 0 -Mandatory -ValidateSet @('Health', 'Overview', 'Capacity') -Dictionary $DynamicParameters } elseif ($Type -eq 'Performance') { New-DynamicParameter -Name 'Group' -ValidateSet @('Array', 'Volume', 'Volumes', 'Volume Groups', 'File System', 'Pods', 'Directories') -Type ([string]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Historical' -ValidateSet @('5m', '1h', '3h', '24h', '7d', '30d', '90d', '1y') -Type ([string]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Filter' -Type ([String]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Name' -Type ([String]) -Position 0 -Dictionary $DynamicParameters } elseif ($Type -eq 'Capacity') { New-DynamicParameter -Name 'Group' -ValidateSet @('Array', 'Volumes', 'Volume Groups', 'Pods', 'Directories') -Type ([string]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Historical' -ValidateSet @('5m', '1h', '3h', '24h', '7d', '30d', '90d', '1y') -Type ([string]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Filter' -Type ([String]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Name' -Type ([String]) -Position 0 -Dictionary $DynamicParameters } elseif ($Type -eq 'Replication') { New-DynamicParameter -Name 'Group' -ValidateSet @('Array', 'Volume') -Type ([string]) -Position 0 -Dictionary $DynamicParameters New-DynamicParameter -Name 'Historical' -ValidateSet @('5m', '1h', '3h', '24h', '7d', '30d', '90d', '1y') -Type ([string]) -Position 0 -Dictionary $DynamicParameters } $DynamicParameters } begin { New-DynamicParameter -CreateVariables -BoundParameters $PSBoundParameters if ($null -eq $Name) { $Name = "*" } switch ($Historical) { '5m' { $Resolution = 1000 $StartTime = $([DateTimeOffset]$(Get-Date).AddMinutes(-5)).ToUnixTimeMilliseconds() } '1h' { $Resolution = 30000 $StartTime = $([DateTimeOffset]$(Get-Date).AddHours(-1)).ToUnixTimeMilliseconds() } '3h' { $Resolution = 30000 $StartTime = $([DateTimeOffset]$(Get-Date).AddHours(-3)).ToUnixTimeMilliseconds() } '24h' { $Resolution = 300000 $StartTime = $([DateTimeOffset]$(Get-Date).AddHours(-24)).ToUnixTimeMilliseconds() } '7d' { $Resolution = 1800000 $StartTime = $([DateTimeOffset]$(Get-Date).AddDays(-7)).ToUnixTimeMilliseconds() } '30d' { $Resolution = 7200000 $StartTime = $([DateTimeOffset]$(Get-Date).AddDays(-30)).ToUnixTimeMilliseconds() } '90d' { $Resolution = 28800000 $StartTime = $([DateTimeOffset]$(Get-Date).AddDays(-90)).ToUnixTimeMilliseconds() } '1y' { $Resolution = 86400000 $StartTime = $([DateTimeOffset]$(Get-Date).AddYears(-1)).ToUnixTimeMilliseconds() } '' { $Resolution = 300000 $StartTime = $([DateTimeOffset]$(Get-Date).AddHours(-24)).ToUnixTimeMilliseconds() } } } process { if ($Type -eq 'Dashboard') { if ($ChartName -eq 'Capacity') { try { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/array?space=true" -ApiVersion 1.18 -SkipCertificateCheck -ErrorAction Stop [PSCustomObject]@{ Unique = $RestResponse.Volumes Snapshots = $RestResponse.Snapshots Shared = $RestResponse.Shared_Space System = $RestResponse.System Empty = $RestResponse.Capacity - $RestResponse.Total DataReduction = $RestResponse.Data_Reduction Used = $RestResponse.Total Total = $RestResponse.Capacity TotalReduction = $RestResponse.Total_Reduction ProvisionedSize = $RestResponse.Provisioned #Replication = } } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/arrays" -SkipCertificateCheck -ErrorAction Stop [PSCustomObject]@{ Unique = $RestResponse.Space.Unique Snapshots = $RestResponse.Space.Snapshots Shared = $RestResponse.Space.Shared System = $RestResponse.Space.System Empty = $RestResponse.Capacity - $RestResponse.Space.Total_Physical DataReduction = $RestResponse.Space.Data_Reduction Used = $RestResponse.Space.Total_Physical Total = $RestResponse.Capacity TotalReduction = $RestResponse.Space.Total_Reduction ProvisionedSize = $RestResponse.Space.Total_Provisioned Replication = $RestResponse.Space.Replication } } } catch { Write-Error $_ } } if ($ChartName -eq 'Overview') { try { [PSCustomObject]@{ Hosts = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/hosts" -SkipCertificateCheck -ErrorAction Stop).Count HostGroups = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/host-groups" -SkipCertificateCheck -ErrorAction Stop).Count Volumes = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volumes?destroyed=False&filter=SubType='Regular'" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volumes?destroyed=True&filter=SubType='Regular'" -SkipCertificateCheck -ErrorAction Stop).Count VolumeSnapshots = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volume-snapshots?destroyed=False" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volume-snapshots?destroyed=True" -SkipCertificateCheck -ErrorAction Stop).Count VolumeGroups = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volume-groups?destroyed=False" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/volume-groups?destroyed=True" -SkipCertificateCheck -ErrorAction Stop).Count ProtectionGroups = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/protection-groups?destroyed=False" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/protection-groups?destroyed=True" -SkipCertificateCheck -ErrorAction Stop).Count ProtectionGroupSnapshots = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/protection-group-snapshots?destroyed=False" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/protection-group-snapshots?destroyed=True" -SkipCertificateCheck -ErrorAction Stop).Count Pods = @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/pods?destroyed=False" -SkipCertificateCheck -ErrorAction Stop).Count + @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/pods?destroyed=True" -SkipCertificateCheck -ErrorAction Stop).Count FileSystems = Invoke-Command -Command { try { @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/file-systems" -SkipCertificateCheck -ErrorAction Stop).Count } catch { $null } } Directories = Invoke-Command -Command { try { @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/directories" -SkipCertificateCheck -ErrorAction Stop).Count } catch { $null } } DirectorySnapshots = Invoke-Command -Command { try { @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/directory-snapshots" -SkipCertificateCheck -ErrorAction Stop).Count } catch { } } Policies = Invoke-Command -Command { try { @(Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/policies" -SkipCertificateCheck -ErrorAction Stop).Count } catch { $null } } } } catch { Write-Error $_.Exception.Message } } if ($ChartName -eq 'Health') { try { $Drives = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/drive" -SkipCertificateCheck -ApiVersion 1 -ErrorAction SilentlyContinue Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method GET -Path "/hardware" -SkipCertificateCheck -ApiVersion 1 | ForEach-Object { $PipelineVariable = $_ if ($null -ne $Drives) { if ($_.Name.StartsWith("CH0.BAY")) { $Drive = $Drives | Where-Object {$_.name -eq $PipelineVariable.name} $_ | Add-Member -MemberType NoteProperty -Name status -Value $Drive.status -Force -PassThru } else { $_ } } else { $_ } } } catch { Write-Error $_.Exception.Message } } } elseif ($Type -eq 'Performance') { if ($Group -eq 'Array') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { if ($null -eq $Historical) { $Historical = '24h' } $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/array?action=monitor&historical=$Historical&mirrored=true" -ApiVersion 1.18 -SkipCertificateCheck -ErrorAction Stop | Select-Object local_queue_usec_per_op, @{Name = "mirrored_write_bytes_per_sec";Expression = {$_.mirrored_input_per_sec}}, mirrored_writes_per_sec, usec_per_mirrored_write_op, @{Name = "time";Expression = {([DateTime]$_.Time).ToLocalTime()}}, @{Name = "read_bytes_per_sec";Expression = {$_.output_per_sec}}, @{Name = "write_bytes_per_sec";Expression = {$_.input_per_sec}}, usec_per_read_op, usec_per_write_op, reads_per_sec, writes_per_sec } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/arrays/performance?resolution=$Resolution&start_time=$StartTime&protocol_group=all" -SkipCertificateCheck -ErrorAction Stop } } elseif ($Group -eq 'Volume') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { Write-Error "Volume Charts require Purity OS 6.0 or greater" -ErrorAction Stop } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/arrays/performance?resolution=$Resolution&start_time=$StartTime&protocol_group=block" -SkipCertificateCheck -ErrorAction Stop } } elseif ($Group -eq 'Volumes') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/volumes/performance?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'Volume Groups') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/volume-groups/performance?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'File System') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { Write-Error "File System Charts require Purity OS 6.0 or greater" -ErrorAction Stop } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/arrays/performance?resolution=$Resolution&start_time=$StartTime&protocol_group=file" -SkipCertificateCheck -ErrorAction Stop } } elseif ($Group -eq 'Pods') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/pods/performance?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'Directories') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { Write-Error "Directory Charts require Purity OS 6.0 or greater" -ErrorAction Stop } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/directories/performance?resolution=$Resolution&start_time=$StartTime&protocol_group=all&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } } } elseif ($Type -eq 'Capacity') { if ($Group -eq 'Array') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { if ($null -eq $Historical) { $Historical = '24h' } $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/array?space=true&historical=$Historical" -ApiVersion 1.18 -SkipCertificateCheck -ErrorAction Stop | ForEach-Object { [PSCustomObject]@{ Time = ([DateTime]$_.Time).ToLocalTime() Name = $_.Hostname Id = "[1]" Space = [PSCustomObject]@{ Data_Reduction = $_.Data_Reduction Shared = $_.Shared_Space Snapshots = $_.Snapshots System = $_.System Thin_Provisioning = $_.Thin_Provisioning Total_Physical = $_.Total Total_Provisioned = $_.Provisioned Total_Reduction = $_.Total_Reduction Unique = $_.Volumes #Virtual = #Replication = } Capacity = $_.Capacity Parity = $_.Parity } } } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/arrays/space?resolution=$Resolution&start_time=$StartTime&filter=$Filter" -SkipCertificateCheck -ErrorAction Stop } } elseif ($Group -eq 'Volumes') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/volumes/space?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'Volume Groups') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/volume-groups/space?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'Pods') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/pods/space?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } elseif ($Group -eq 'Directories') { if (-not (($Array.ApiVersion[2].Minor | Select-Object -Last 1) -gt 1)) { Write-Error "Directory Charts require Purity OS 6.0 or greater" -ErrorAction Stop } else { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/directories/space?resolution=$Resolution&start_time=$StartTime&filter=$Filter&names=$Name" -SkipCertificateCheck -ErrorAction Stop } } } elseif ($Type -eq 'Replication') { if ($Group -eq 'Array') { $RestResponse = Invoke-PfaApiRequest -Array $Array -Request RestMethod -Method Get -Path "/protection-groups/performance/replication?resolution=$Resolution&start_time=$StartTime" -SkipCertificateCheck -ErrorAction Stop } } if ($Type -ne 'Dashboard') { $RestResponse | ForEach-Object { if ($_.Time.GetType() -eq [Int64]) { $_.Time = [DateTimeOffset]::FromUnixTimeMilliseconds($_.Time).DateTime.ToLocalTime() } } $RestResponse } } end { } } |