Public/Get-DMLunPerformance.ps1
|
function Get-DMLunPerformance { <# .SYNOPSIS Retrieves realtime performance samples for OceanStor LUNs. .DESCRIPTION Thin wrapper around Get-DMPerformance for object type LUN. Accepts one or more LUN objects via pipeline (e.g. from Get-DMlun; OceanstorLunv3 or OceanstorLunv6 depending on the connected array's firmware), batches all piped IDs into a single performance_data call per sample -- required because the endpoint cannot be invoked concurrently. .PARAMETER WebSession Optional parameter to define the session to be use on the REST call. If not defined, the module's cached $script:CurrentOceanstorSession session will be used .PARAMETER InputObject One or more LUN objects (OceanstorLunv3 or OceanstorLunv6), pipeline-able. .PARAMETER Metric One or more friendly metric names (see Get-DMPerformanceIndicatorMap). Defaults to Get-DMPerformance's own default set when omitted. .PARAMETER SampleCount Number of samples to take. Defaults to 1. .PARAMETER IntervalSeconds Delay between samples when SampleCount is greater than 1. Defaults to 5. .INPUTS OceanstorLunv3, OceanstorLunv6 .OUTPUTS System.Collections.ArrayList .EXAMPLE PS> Get-DMlun | Get-DMLunPerformance .NOTES Filename: Get-DMLunPerformance.ps1 #> [CmdletBinding()] [OutputType([System.Collections.ArrayList])] param( [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [pscustomobject]$WebSession, [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [object[]]$InputObject, [Parameter(Mandatory = $false)] [ArgumentCompleter({ param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) (Get-DMPerformanceIndicatorMap).Keys | Where-Object { $_ -like "$wordToComplete*" } })] [ValidateScript({ $validNames = (Get-DMPerformanceIndicatorMap).Keys foreach ($metricName in $_) { if ($metricName -notin $validNames) { throw "Unknown performance metric '$metricName'. Valid metrics: $($validNames -join ', ')" } } return $true })] [string[]]$Metric, [Parameter(Mandatory = $false)] [int]$SampleCount = 1, [Parameter(Mandatory = $false)] [int]$IntervalSeconds = 5 ) begin { $session = if ($WebSession) { $WebSession } else { $script:CurrentOceanstorSession } $ids = [System.Collections.Generic.List[string]]::new() } process { foreach ($obj in $InputObject) { if ($obj -isnot [OceanstorLunv3] -and $obj -isnot [OceanstorLunv6]) { throw "Get-DMLunPerformance: InputObject must be an OceanstorLunv3 or OceanstorLunv6 object." } $ids.Add($obj.Id) } } end { if ($ids.Count -eq 0) { return } $params = @{ WebSession = $session; ObjectType = 'LUN'; ObjectId = @($ids) } if ($PSBoundParameters.ContainsKey('Metric')) { $params.Metric = $Metric } for ($s = 0; $s -lt $SampleCount; $s++) { Get-DMPerformance @params if ($s -lt ($SampleCount - 1)) { Start-Sleep -Seconds $IntervalSeconds } } } } |