Start-UserLockComputer Cmdlet
Synopsis
Starts a computer through the UserLock server.
Syntax
Start-UserLockComputer [-Name] <string[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Start-UserLockComputer [-InputObject] <MachineState[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
The Start-UserLockComputer cmdlet wakes up a computer through the UserLock server. This cmdlet lets user know, that the computer will be started. Caution: PowerShell 3.0 is required.
Parameters
-Name <string[]>
Specifies the name of the computer to reboot. You can type multiple computer names (separated by commas). Wildcard characters are permited.
Required | true |
Position | 1 |
Accepts pipeline input | true (ByValue, ByPropertyName) |
Accepts wildcard characters | true |
-InputObject <MachineState[]>
Specifies the MachineState objects that represent the computers to reboot. Enter a variable that contains the MachineState objects or a command that gets the MachineState objects, such as a
Required | true |
Position | named |
Accepts pipeline input | true (ByValue) |
Accepts wildcard characters | false |
-UserLockServerName <string>
Specifies the name of the UserLock server. The default is the localhost name.
Required | false |
Position | named |
Accepts pipeline input | false |
Accepts wildcard characters | false |
Default Value | '.' |
-PassThru <SwitchParameter>
Returns the rebooted computer object(s). By default, this cmdlet does not generate any output.
Required | false |
Position | named |
Accepts pipeline input | false |
Accepts wildcard characters | false |
-Force <SwitchParameter>
Reboots computer(s) with no confirmation.
Required | false |
Position | named |
Accepts pipeline input | false |
Accepts wildcard characters | false |
-Confirm <SwitchParameter>
Prompts you for confirmation before executing the command.
Required | false |
Position | named |
Accepts pipeline input | false |
Accepts wildcard characters | false |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without actually executing the command.
Required | false |
Position | named |
Accepts pipeline input | false |
Accepts wildcard characters | false |
<CommonParameters>
For more information about common parameters, type "Get-Help about_commonparameters".
Input Type
ISDecisions.UserLockLibrary.MachineState
Return Type
ISDecisions.UserLockLibrary.MachineState or None
Notes
You can also refer to Start-UserLockComputer by its alias, "wulc". For more information, see about_Aliases. To use Start-UserLockComputer, you must have the "Agent distribution" UserLock administrative access right.
Example
Start-UserLockComputer Workstation1 -UserLockServerName MyUlSrv
Wakes up the computer called Workstation1 through the 'MyUlSrv' UserLock server.