< Back

Get-PowerPlanSettingValue

Sat Jan 18, 2020 9:30 pm

NAME Get-PowerPlanSettingValue



SYNOPSIS

Get the information of a specific power plan's setting.





SYNTAX

Get-PowerPlanSettingValue [-InputPowerPlanId] <String> [[-InputPowerPlanSettingId] <String>] [[-OnBattery]

<Boolean>] [<CommonParameters>]





DESCRIPTION

Calls to the cim instance 'root\\cimv2\\power' via the Win32_PowerSettingDataIndex class to gather specific

information

for a setting of a power plan.





PARAMETERS

-InputPowerPlanId <String>

Specify the ID of the power plan you'd like to make changes to. This is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InputPowerPlanSettingId <String>

Specify the ID of the setting you'd like to make changes to. To get this value use the Get-PowerPlanSetting

function.

This is required.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OnBattery <Boolean>

Specify whether or not to set the value of the OnBattery power setting. By default the "plugged in" value is

set.

If this value is set to true then you will retrieve the power action for the "On battery" value. "Plugged in"

uses DC input wheras "On battery" utilizes AC input.



Required? false

Position? 3

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





NAME : Get-PowerPlanSettingValue

AUTHOR : BMO

EMAIL : brandonseahorse@gmail.com

GITHUB : github.com/Bmo1992

CREATED : September 17, 2019



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-PowerPlanSettingValue -InputPowerPlanId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -InputPowerPlanSettingId

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx



Returns the settings of the power plan with a value of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx and the setting with

an ID of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx











RELATED LINKS