Set-CMPowerControl

SYNOPSIS

Changes power state for client devices by using AMT power control commands.

SYNTAX

SearchByValueMandatory (Default)

Set-CMPowerControl -InputObject <IResultObject> -PowerControl <PowerControlType> [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByNameMandatory

Set-CMPowerControl -DeviceName <String> -PowerControl <PowerControlType> [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByIdMandatory

Set-CMPowerControl -DeviceId <String> -PowerControl <PowerControlType> [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

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 Configuration Manager by using AMT power control commands.

EXAMPLES

Example 1: Change the power control setting for a client device

PS C:\> Set-CMPowerControl -DeviceId "209224563" -PowerControl Restart

This command changes the power control setting to Restart for the client device that has the ID 209224563.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DeviceId

Specifies an array of device IDs.

Type: String
Parameter Sets: SearchByIdMandatory
Aliases: ResourceId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceName

Specifies an array of device names.

Type: String
Parameter Sets: SearchByNameMandatory
Aliases: Name

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies a CMPowerControl object.

Type: IResultObject
Parameter Sets: SearchByValueMandatory
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PowerControl

Specifies the power management action. The acceptable values for this parameter 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.
Type: PowerControlType
Parameter Sets: (All)
Aliases: 
Accepted values: Wakeup, Restart, Shutdown

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES