PowerShell/docs/new-user.md
2024-05-19 10:25:56 +02:00

79 lines
1.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: *new-user.ps1*
========================
This PowerShell script creates a new user account with an encrypted home directory.
Parameters
----------
```powershell
PS> ./new-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> ./new-user.ps1 Joe
Created new user 'Joe' with encrypted home directory in 11s.
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Creates a new user account
.DESCRIPTION
This PowerShell script creates a new user account with an encrypted home directory.
.EXAMPLE
PS> ./new-user.ps1 Joe
✔️ Created new user 'Joe' with encrypted 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 new user name" }
$stopWatch = [system.diagnostics.stopwatch]::startNew()
if ($IsLinux) {
& sudo adduser --encrypt-home $username
} else {
throw "Not supported yet"
}
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Created new user '$username' with encrypted 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 new-user.ps1 as of 05/19/2024 10:25:23)*