mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-09 13:04:59 +02:00
Updated the Markdown manuals
This commit is contained in:
78
docs/remove-user.md
Normal file
78
docs/remove-user.md
Normal file
@ -0,0 +1,78 @@
|
||||
Script: *remove-user.ps1*
|
||||
========================
|
||||
|
||||
This PowerShell script removes an existing user account including the home directory.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./remove-user.ps1 [[-username] <String>] [<CommonParameters>]
|
||||
|
||||
-username <String>
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value
|
||||
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> ./remove-user.ps1 Joe
|
||||
✔️ Removed user 'Joe' including home directory in 11s.
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Removes an user account
|
||||
.DESCRIPTION
|
||||
This PowerShell script removes an existing user account including the home directory.
|
||||
.EXAMPLE
|
||||
PS> ./remove-user.ps1 Joe
|
||||
✔️ Removed user 'Joe' including home directory in 11s.
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$username = "")
|
||||
|
||||
try {
|
||||
if ($username -eq "") { $username = Read-Host "Enter the user name to remove" }
|
||||
$stopWatch = [system.diagnostics.stopwatch]::startNew()
|
||||
|
||||
if ($IsLinux) {
|
||||
& sudo deluser --remove-home $username
|
||||
} else {
|
||||
throw "Not supported yet"
|
||||
}
|
||||
|
||||
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
|
||||
"✔️ Removed user '$username' including home directory in $($elapsed)s."
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
```
|
||||
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of remove-user.ps1 as of 05/19/2024 10:25:25)*
|
Reference in New Issue
Block a user