PowerShell/docs/wake-up.md
2024-08-15 09:51:46 +02:00

124 lines
3.9 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Script: *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 [[-macAddr] <String>] [[-ipAddr] <String>] [[-udpPort] <Int32>] [[-numTimes] <Int32>] [<CommonParameters>]
-macAddr <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
-ipAddr <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
-udpPort <Int32>
Specifies the UDP port (9 by default)
Required? false
Position? 3
Default value 9
Accept pipeline input? false
Accept wildcard characters? false
-numTimes <Int32>
Specifies # of times to send the packet (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
Magic packet sent 3x to IP 192.168.100.100, UDP port 9 - wait a minute until the computer fully boots up.
```
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 macAddr
Specifies the host's MAC address (e.g. 11:22:33:44:55:66)
.PARAMETER ipAddr
Specifies the host's IP address or subnet address (e.g. 192.168.0.255)
.PARAMETER udpPort
Specifies the UDP port (9 by default)
.PARAMETER numTimes
Specifies # of times to send the packet (3 by default)
.EXAMPLE
PS> ./wake-up.ps1 11:22:33:44:55:66 192.168.100.100
✔️ Magic packet sent 3x to IP 192.168.100.100, UDP port 9 - wait a minute until the computer fully boots up.
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$macAddr = "", [string]$ipAddr = "", [int]$udpPort = 9, [int]$numTimes = 3)
function Send-WOL { param([string]$macAddr, [string]$ipAddr, [int]$udpPort)
$broadcastAddr = [Net.IPAddress]::Parse($ipAddr)
$macAddr = (($macAddr.replace(":","")).replace("-","")).replace(".","")
$target = 0,2,4,6,8,10 | % {[convert]::ToByte($macAddr.substring($_,2),16)}
$packet = (,[byte]255 * 6) + ($target * 16)
$UDPclient = New-Object System.Net.Sockets.UdpClient
$UDPclient.Connect($broadcastAddr, $udpPort)
[void]$UDPclient.Send($packet, 102)
}
try {
if ($macAddr -eq "" ) { $macAddr = Read-Host "Enter the host's MAC address, e.g. 11:22:33:44:55:66" }
if ($ipAddr -eq "" ) { $ipAddr = Read-Host "Enter the host's IP or subnet address, e.g. 192.168.0.255" }
for ($i = 0; $i -lt $numTimes; $i++) {
Send-WOL $macAddr.Trim() $ipAddr.Trim() $udpPort
Start-Sleep -milliseconds 100
}
"✔️ Magic packet sent $($numTimes)x to IP $ipAddr, UDP port $udpPort - 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/15/2024 09:50:55)*