PowerShell/Docs/wake-up.md
2023-08-06 21:36:33 +02:00

124 lines
3.8 KiB
Markdown

*wake-up.ps1*
================
This PowerShell script sends a magic UDP packet to a computer to wake him up (requires the target computer to have Wake-on-LAN activated).
Parameters
----------
```powershell
PS> ./wake-up.ps1 [[-MACaddress] <String>] [[-IPaddress] <String>] [[-Port] <Int32>] [[-NumRetries] <Int32>] [<CommonParameters>]
-MACaddress <String>
Specifies the host's MAC address (e.g. 11:22:33:44:55:66)
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IPaddress <String>
Specifies the host's IP address or subnet address (e.g. 192.168.0.255)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
Specifies the UDP port (9 by default)
Required? false
Position? 3
Default value 9
Accept pipeline input? false
Accept wildcard characters? false
-NumRetries <Int32>
Specifies number of retries (3 by default)
Required? false
Position? 4
Default value 3
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./wake-up.ps1 11:22:33:44:55:66 192.168.100.100
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Wakes up a computer using Wake-on-LAN
.DESCRIPTION
This PowerShell script sends a magic UDP packet to a computer to wake him up (requires the target computer to have Wake-on-LAN activated).
.PARAMETER MACaddress
Specifies the host's MAC address (e.g. 11:22:33:44:55:66)
.PARAMETER IPaddress
Specifies the host's IP address or subnet address (e.g. 192.168.0.255)
.PARAMETER Port
Specifies the UDP port (9 by default)
.PARAMETER NumRetries
Specifies number of retries (3 by default)
.EXAMPLE
PS> ./wake-up.ps1 11:22:33:44:55:66 192.168.100.100
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$MACaddress = "", [string]$IPaddress = "", [int]$Port=9, [int]$NumRetries=3)
function Send-WOL { param([string]$mac, [string]$ip, [int]$port)
$broadcast = [Net.IPAddress]::Parse($ip)
$mac=(($mac.replace(":","")).replace("-","")).replace(".","")
$target=0,2,4,6,8,10 | % {[convert]::ToByte($mac.substring($_,2),16)}
$packet = (,[byte]255 * 6) + ($target * 16)
$UDPclient = new-Object System.Net.Sockets.UdpClient
$UDPclient.Connect($broadcast,$port)
[void]$UDPclient.Send($packet, 102)
}
try {
if ($MACaddress -eq "" ) { $MACaddress = Read-Host "Enter the host's MAC address, e.g. 11:22:33:44:55:66" }
if ($IPaddress -eq "" ) { $IPaddress = Read-Host "Enter the host's IP or subnet address, e.g. 192.168.0.255" }
Send-WOL $MACaddress $IPaddress $Port
for ($i = 0; $i -lt $NumRetries; $i++) {
Start-Sleep -milliseconds 100
Send-WOL $MACaddress $IPaddress $Port
}
"✔️ sent magic packet with MAC $MACaddress to IP $IPaddress on port $Port as wakeup call ($($NumRetries + 1) times)"
" (Hint: wait a minute until the computer fully boots up)"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of wake-up.ps1 as of 08/06/2023 21:36:18)*