PowerShell/docs/new-user.md

79 lines
1.9 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*new-user.ps1*
================
2022-02-10 09:01:07 +01:00
2023-12-07 20:24:45 +01:00
This PowerShell script creates a new user account with an encrypted home directory.
2022-02-10 09:01:07 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2022-02-10 09:01:07 +01:00
```powershell
2023-12-07 20:24:45 +01:00
PS> ./new-user.ps1 [[-username] <String>] [<CommonParameters>]
2022-02-10 09:01:07 +01:00
2023-12-07 20:24:45 +01:00
-username <String>
2022-02-10 09:01:07 +01:00
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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2022-02-10 09:01:07 +01:00
```powershell
2023-12-07 20:24:45 +01:00
PS> ./new-user.ps1 Joe
✔️ Created new user 'Joe' with encrypted home directory in 11 sec
2022-02-10 09:01:07 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2022-02-10 09:01:07 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2022-02-10 09:01:07 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Creates a new user account
.DESCRIPTION
2023-12-07 20:24:45 +01:00
This PowerShell script creates a new user account with an encrypted home directory.
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-12-07 20:24:45 +01:00
PS> ./new-user.ps1 Joe
✔️ Created new user 'Joe' with encrypted home directory in 11 sec
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-12-07 20:24:45 +01:00
param([string]$username = "")
2022-11-17 20:02:26 +01:00
try {
2023-12-07 20:24:45 +01:00
if ($username -eq "") { $username = Read-Host "Enter the new user name" }
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2022-11-17 20:02:26 +01:00
if ($IsLinux) {
2023-12-07 20:24:45 +01:00
& sudo adduser --encrypt-home $username
2022-11-17 20:02:26 +01:00
} else {
throw "Not supported yet"
}
2023-12-07 20:24:45 +01:00
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Created new user '$username' with encrypted home directory in $elapsed sec"
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-12-16 10:12:58 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of new-user.ps1 as of 12/16/2023 10:12:23)*