From f6dc7b010821872d8aaf07f5743440869f740a35 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Wed, 21 Mar 2018 14:27:56 +0100 Subject: [PATCH] update docs --- docs/Connect-To.md | 3 +- docs/Disconnect-From.md | 3 +- docs/Get-CredentialStore.md | 3 +- docs/Get-CredentialStoreItem.md | 3 +- docs/New-CredentialStore.md | 82 +++++++++++++----------------- docs/New-CredentialStoreItem.md | 3 +- docs/PSCredentialStore.md | 24 ++++----- docs/Remove-CredentialStoreItem.md | 3 +- docs/Set-CredentialStoreItem.md | 3 +- docs/Test-CSConnection.md | 3 +- docs/Test-CredentialStore.md | 3 +- docs/Test-CredentialStoreItem.md | 3 +- 12 files changed, 58 insertions(+), 78 deletions(-) diff --git a/docs/Connect-To.md b/docs/Connect-To.md index 4287e02..96c0a5a 100644 --- a/docs/Connect-To.md +++ b/docs/Connect-To.md @@ -167,8 +167,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Disconnect-From.md b/docs/Disconnect-From.md index 85e7950..9d2d322 100644 --- a/docs/Disconnect-From.md +++ b/docs/Disconnect-From.md @@ -111,8 +111,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Get-CredentialStore.md b/docs/Get-CredentialStore.md index d22cd2d..4a9b63c 100644 --- a/docs/Get-CredentialStore.md +++ b/docs/Get-CredentialStore.md @@ -71,8 +71,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Get-CredentialStoreItem.md b/docs/Get-CredentialStoreItem.md index 2491019..c1c2fd5 100644 --- a/docs/Get-CredentialStoreItem.md +++ b/docs/Get-CredentialStoreItem.md @@ -101,8 +101,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/New-CredentialStore.md b/docs/New-CredentialStore.md index 2cce87c..c1c2fd5 100644 --- a/docs/New-CredentialStore.md +++ b/docs/New-CredentialStore.md @@ -5,79 +5,56 @@ online version: https://github.com/OCram85/PSCredentialStore schema: 2.0.0 --- -# New-CredentialStore +# Get-CredentialStoreItem ## SYNOPSIS -Creates a new credential store File +Returns the Credential from a given remote host item. ## SYNTAX ### Private (Default) ``` -New-CredentialStore [-Force] [] +Get-CredentialStoreItem -RemoteHost [-Identifier ] [] ``` ### Shared ``` -New-CredentialStore [-Shared] [-Path ] [-Force] [] +Get-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] + [] ``` ## DESCRIPTION -You need to run this script first to create a new credential store before you try to -save new credentials with New-CredentialStoreItem. +Return the credential as PSCredential object. ## EXAMPLES ### EXAMPLE 1 ``` -New-CredentialStore +$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" ``` -# Creates a new private CredentialStore - -### EXAMPLE 2 -``` -New-CredentialStore -Force -``` - -# Resets an existing private CredentialStore - -### EXAMPLE 3 -``` -New-CredentialStore -Shared -``` - -# Creates a new shared CredentialStore - -### EXAMPLE 4 -``` -New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json" -``` - -# Creates a new shared CredentialStore in the given location. - ## PARAMETERS -### -Force -Use this switch to reset an existing store. -The complete content will be wiped. +### -Identifier +Provide a custom identifier to the given remote host key. +This enables you to store multiple credentials +for a single remote host entry. +For example ad/sys1, ftp/sys1, mssql/sys1 ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Path -Define a location for the new shared CredentialStore. -The default store will be created in -$Env:ProgramData\PSCredentialStore dir. +Define a custom path to a shared CredentialStore. ```yaml Type: String @@ -91,11 +68,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoteHost +Specify the host, for which you would like to change the credentials. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Shared -Creates a CredentialStore in the Shared mode. -This enables you to read the CredentialStore Items on -different systems or profiles. -In addition you can optionally provide a custom path wit the -Path parameter. +Switch to shared mode with this param. +This enforces the command to work with a shared CredentialStore which +can be decrypted across systems. ```yaml Type: SwitchParameter @@ -110,8 +101,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -119,11 +109,11 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## OUTPUTS -### [None] +### [System.Management.Automation.PSCredential] ## NOTES \`\`\` -File Name : New-CredentialStore.ps1 +File Name : Get-CredentialStoreItem.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires : \`\`\` diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md index 9e6fc89..5896e9b 100644 --- a/docs/New-CredentialStoreItem.md +++ b/docs/New-CredentialStoreItem.md @@ -119,8 +119,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/PSCredentialStore.md b/docs/PSCredentialStore.md index da93bf4..6b840c0 100644 --- a/docs/PSCredentialStore.md +++ b/docs/PSCredentialStore.md @@ -12,35 +12,35 @@ Locale: en-US ## PSCredentialStore Cmdlets ### [Connect-To](Connect-To.md) -{{Manually Enter Connect-To Description Here}} +Connects to the given host using the stored CredentialStoreItem. ### [Disconnect-From](Disconnect-From.md) -{{Manually Enter Disconnect-From Description Here}} +Terminates a session established with Connect-To using a CredentialStoreItem. ### [Get-CredentialStore](Get-CredentialStore.md) -{{Manually Enter Get-CredentialStore Description Here}} +Reads the complete content of the credential store and returns it as a new object. ### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -{{Manually Enter Get-CredentialStoreItem Description Here}} +Returns the Credential from a given remote host item. -### [New-CredentialStore](New-CredentialStore.md) -{{Manually Enter New-CredentialStore Description Here}} +### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) +Returns the Credential from a given remote host item. ### [New-CredentialStoreItem](New-CredentialStoreItem.md) -{{Manually Enter New-CredentialStoreItem Description Here}} +Adds a credential store item containing host, user and password to the given store. ### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) -{{Manually Enter Remove-CredentialStoreItem Description Here}} +Remove the given credentials from the credential store. ### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) -{{Manually Enter Set-CredentialStoreItem Description Here}} +Changes the credentials for the given remote host in the store. ### [Test-CredentialStore](Test-CredentialStore.md) -{{Manually Enter Test-CredentialStore Description Here}} +Returns the credential store state. ### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) -{{Manually Enter Test-CredentialStoreItem Description Here}} +Checks if the given RemoteHost identifier combination exists in the credential store. ### [Test-CSConnection](Test-CSConnection.md) -{{Manually Enter Test-CSConnection Description Here}} +Returns the connection state of a given type to the remote host. diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md index 2fd8470..95e9dcd 100644 --- a/docs/Remove-CredentialStoreItem.md +++ b/docs/Remove-CredentialStoreItem.md @@ -102,8 +102,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Set-CredentialStoreItem.md b/docs/Set-CredentialStoreItem.md index 29a4385..edc6771 100644 --- a/docs/Set-CredentialStoreItem.md +++ b/docs/Set-CredentialStoreItem.md @@ -102,8 +102,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Test-CSConnection.md b/docs/Test-CSConnection.md index 2e0a607..da6e927 100644 --- a/docs/Test-CSConnection.md +++ b/docs/Test-CSConnection.md @@ -61,8 +61,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Test-CredentialStore.md b/docs/Test-CredentialStore.md index d8eaf62..465d450 100644 --- a/docs/Test-CredentialStore.md +++ b/docs/Test-CredentialStore.md @@ -71,8 +71,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docs/Test-CredentialStoreItem.md b/docs/Test-CredentialStoreItem.md index 1635a9d..abc9dff 100644 --- a/docs/Test-CredentialStoreItem.md +++ b/docs/Test-CredentialStoreItem.md @@ -110,8 +110,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS