CoreOps/System/Get-SDPSystemBatteries.ps1
|
<# .SYNOPSIS Retrieves battery hardware state from the SDP. .DESCRIPTION Queries the `system/batteries` endpoint. Filter by name, id, charge level state, connectivity state, FRU/phased-out flags, etc. .EXAMPLE Get-SDPSystemBatteries .EXAMPLE Get-SDPSystemBatteries -connectivity_state 'connected' .NOTES Authored by J.R. Phillips (GitHub: JayAreP) .LINK https://github.com/silk-us/silk-sdp-powershell-sdk #> function Get-SDPSystemBatteries { [CmdletBinding()] param( [parameter()] [Alias("ChargeLevelState")] [string] $charge_level_state, [parameter()] [Alias("ConnectivityState")] [string] $connectivity_state, [parameter()] [Alias("ContainedIn")] [string] $contained_in, [parameter()] [int] $id, [parameter()] [Alias("IsExpansionInProgress")] [bool] $is_expansion_in_progress, [parameter()] [Alias("IsFru")] [bool] $is_fru, [parameter()] [Alias("IsPhasedOut")] [bool] $is_phased_out, [parameter()] [string] $name, [parameter()] [Alias("NduState")] [string] $ndu_state, [parameter()] [switch] $doNotResolve, [parameter()] [string] $context = "sdpconnection" ) begin { $endpoint = "system/batteries" } process { $PSBoundParameters.Remove('doNotResolve') | Out-Null $results = Invoke-SDPRestCall -endpoint $endpoint -method GET -parameterList $PSBoundParameters -context $context -strictURI | Add-SDPTypeName -TypeName 'SDPSystemBattery' if ($doNotResolve) { return $results } return ($results | Update-SDPRefObjects -context $context) } } |