mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-13 14:37:19 +02:00
Updated the manuals
This commit is contained in:
@ -1,19 +1,19 @@
|
||||
Script: *save-credentials.ps1*
|
||||
========================
|
||||
|
||||
This PowerShell script asks for credentials and saves them encrypted into a target file ("$HOME\my.credentials" by default).
|
||||
This PowerShell script asks for credentials and saves them encrypted into a target file.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./save-credentials.ps1 [[-TargetFile] <String>] [<CommonParameters>]
|
||||
/home/markus/Repos/PowerShell/scripts/save-credentials.ps1 [[-targetFile] <String>] [<CommonParameters>]
|
||||
|
||||
-TargetFile <String>
|
||||
Specifies the target file ("$HOME\my.credentials" by default)
|
||||
-targetFile <String>
|
||||
Specifies the target file ("~\my.credentials" by default)
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value "$HOME\my.credentials"
|
||||
Default value ~\my.credentials
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
@ -27,7 +27,7 @@ Example
|
||||
```powershell
|
||||
PS> ./save-credentials.ps1
|
||||
Enter username and password, please.
|
||||
✔️ Your credentials have been saved encrypted into C:\Users\Markus\my.credentials
|
||||
✅ Your credentials have been saved to C:\Users\Markus\my.credentials (encrypted).
|
||||
|
||||
```
|
||||
|
||||
@ -46,26 +46,26 @@ Script Content
|
||||
.SYNOPSIS
|
||||
Saves credentials encrypted
|
||||
.DESCRIPTION
|
||||
This PowerShell script asks for credentials and saves them encrypted into a target file ("$HOME\my.credentials" by default).
|
||||
.PARAMETER TargetFile
|
||||
Specifies the target file ("$HOME\my.credentials" by default)
|
||||
This PowerShell script asks for credentials and saves them encrypted into a target file.
|
||||
.PARAMETER targetFile
|
||||
Specifies the target file ("~\my.credentials" by default)
|
||||
.EXAMPLE
|
||||
PS> ./save-credentials.ps1
|
||||
Enter username and password, please.
|
||||
✔️ Your credentials have been saved encrypted into C:\Users\Markus\my.credentials
|
||||
✅ Your credentials have been saved to C:\Users\Markus\my.credentials (encrypted).
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$TargetFile = "$HOME\my.credentials")
|
||||
param([string]$targetFile = "~\my.credentials")
|
||||
|
||||
try {
|
||||
Write-Host "Enter username and password, please." -foreground red
|
||||
$cred = Get-Credential
|
||||
$cred.Password | ConvertFrom-SecureString | Set-Content "$TargetFile"
|
||||
"✔️ Your credentials have been saved encrypted into $TargetFile"
|
||||
$cred.Password | ConvertFrom-SecureString | Set-Content "$targetFile"
|
||||
"✅ Your credentials have been saved to $targetFile (encrypted)."
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
@ -73,4 +73,4 @@ try {
|
||||
}
|
||||
```
|
||||
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of save-credentials.ps1 as of 08/15/2024 09:50:53)*
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of save-credentials.ps1 as of 11/08/2024 12:34:54)*
|
||||
|
Reference in New Issue
Block a user