Set-CMPowerControl
Set-CMPowerControl
Changes power state for client devices by using AMT power control commands.
Syntax
Parameter Set: SearchByNameMandatory
Set-CMPowerControl -DeviceName <String[]> -PowerControl <PowerControlType> {None | Restart | Shutdown | Wakeup} [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Set-CMPowerControl -DeviceId <String[]> -PowerControl <PowerControlType> {None | Restart | Shutdown | Wakeup} [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Set-CMPowerControl -InputObject <IResultObject> -PowerControl <PowerControlType> {None | Restart | Shutdown | Wakeup} [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMPowerControl cmdlet changes the power state for one or more Intel Active Management Technology (Intel AMT) provisioned client devices in Microsoft System Center 2012 Configuration Manager by using AMT power control commands.
Parameters
-DeviceId<String[]>
Specifies an array of device IDs.
Aliases |
ResourceId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String[]>
Specifies an array of device names.
Aliases |
Name |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a CMPowerControl object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PowerControl<PowerControlType>
Specifies the power management action. Valid values are:
-- None. Disables power settings.
-- WakeUp. Turns on a sleeping computer.
-- Restart. Performs a hard reset of the computer and turns on the computer. This action does not shut the operating system down.
-- Shutdown. Performs a hard reset of the computer. This action does not shut the operating system down.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Change the power control setting for a client device
This command changes the power control setting to Restart for the client device that has the ID 209224563.
PS C:\> Set-CMPowerControl -DeviceId "209224563" -PowerControl Restart