Skip to content

Latest commit

 

History

History
210 lines (163 loc) · 3.91 KB

Start-UMSDevice.md

File metadata and controls

210 lines (163 loc) · 3.91 KB
Raw
external help file Module Name online version schema
PSIGEL-help.xml
PSIGEL
2.0.0

Start-UMSDevice

SYNOPSIS

Sends WOL packet to a device.

SYNTAX

Start-UMSDevice [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
 [[-SecurityProtocol] <String[]>] [-WebSession] <Object> [-Id] <Int32> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sends WOL packet to a device (WOL) from the UMS via API.

EXAMPLES

Example 1

Sends WOL packet to device with the ID 195:

Start-UMSDevice -Computername 'igelrmserver' -WebSession $WebSession -Id 195

Message  : OK.
Id       : 195
ExecId   : ID-igelrmserver-53613-1552120204100-11-0
Mac      : 00515734C234
ExecTime : 1552121589519
State    : SUCCESS

Example 2

Sends WOL packet to all devices that were last started today:

$PSDefaultParameterValues = @{
  '*-UMS*:Credential'   = (Get-Credential)
  '*-UMS*:Computername' = 'igelrmserver'
  '*-UMS*:Confirm'      = $false
}
$PSDefaultParameterValues += @{
  '*-UMS*:WebSession' = New-UMSAPICookie
}

(Get-UMSDevice -Filter details).where{$_.LastBootTime -gt ((Get-Date)).AddDays(-1)} |
  Start-UMSDevice

Message  : OK.
Id       : 58
ExecId   : ID-LT035899H-53613-1552120204100-18-0 ID-LT035899H-53613-1552120204100-18-0
Mac      : 00515734C234 080027B0F6E2
ExecTime : 1552122278302 1552122278176
State    : SUCCESS SUCCESS

Message  : OK.
Id       : 195
ExecId   : ID-LT035899H-53613-1552120204100-19-0 ID-LT035899H-53613-1552120204100-19-0
Mac      : 080027B0F6E2 00515734C234
ExecTime : 1552122279824 1552122279713
State    : SUCCESS SUCCESS

PARAMETERS

-ApiVersion

API Version to use

Type: Int32
Parameter Sets: (All)
Aliases:
Accepted values: 3

Required: False
Position: 2
Default value: 3
Accept pipeline input: False
Accept wildcard characters: False

-Computername

Computername of the UMS Server

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

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

-Id

ID of the device

Type: Int32
Parameter Sets: (All)
Aliases:

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

-SecurityProtocol

Set SSL/TLS protocol

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: Tls12, Tls11, Tls, Ssl3

Required: False
Position: 3
Default value: Tls12
Accept pipeline input: False
Accept wildcard characters: False

-TCPPort

TCP Port API

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 8443
Accept pipeline input: False
Accept wildcard characters: False

-WebSession

Websession Cookie

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
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: Benannt
Default value: None
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.

INPUTS

System.Int32

OUTPUTS

System.Object

NOTES

RELATED LINKS