PowerShell/Docs/poweroff.md
2023-07-29 09:55:25 +02:00

57 lines
1.1 KiB
Markdown

## Script: *poweroff.ps1*
This script halts the local computer immediately (needs admin rights).
## Parameters
```powershell
poweroff.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./poweroff
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Script Content
```powershell
<#
.SYNOPSIS
Halts the computer (needs admin rights)
.DESCRIPTION
This script halts the local computer immediately (needs admin rights).
.EXAMPLE
PS> ./poweroff
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
#Requires -RunAsAdministrator
try {
if ($IsLinux) {
sudo shutdown
} else {
Stop-Computer
}
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of poweroff.ps1 as of 07/29/2023 09:55:14)*