From 649bcfdeaf83d3013cac88cd4f426d99d132816b Mon Sep 17 00:00:00 2001 From: OCram85 Date: Thu, 8 Mar 2018 10:19:25 +0100 Subject: [PATCH] Update docs (platyPS) --- docs/Connect-To.md | 99 ++++++++++++--------------- docs/Disconnect-From.md | 44 ++++++------ docs/Get-CredentialStore.md | 3 +- docs/Get-CredentialStoreItem.md | 39 +++++------ docs/New-CredentialStore.md | 104 ++++++++++++++++------------- docs/New-CredentialStoreItem.md | 69 +++++++++---------- docs/PSCredentialStore.md | 24 +++---- docs/Remove-CredentialStoreItem.md | 37 +++++----- docs/Set-CredentialStoreItem.md | 37 +++++----- docs/Test-CSConnection.md | 3 +- docs/Test-CredentialStore.md | 3 +- docs/Test-CredentialStoreItem.md | 37 +++++----- 12 files changed, 248 insertions(+), 251 deletions(-) diff --git a/docs/Connect-To.md b/docs/Connect-To.md index 8e80352..4287e02 100644 --- a/docs/Connect-To.md +++ b/docs/Connect-To.md @@ -64,26 +64,21 @@ Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS ``` -### EXAMPLE 8 -``` -$MyCreds = Get-Credential -``` - -Connect-To -RemoteHost "vcr01.myside.local" -Type VMware -Credentials $MyCreds -Get-VM -Name "*vlm*" | Select-Object -Property Name -Disconnect-From -RemoteHost "vcr01.myside.local" -Type VMware - ## PARAMETERS -### -RemoteHost -Specify the host, for which you would like to change the credentials. +### -Credentials +Use this parameter to bypass the stored credentials. +Without this parameter Connect-To tries to read the +needed credentials from the CredentialStore. +If you provide this parameter you skip this lookup behavior. +So you can use it to enable credentials without preparing any user interaction. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -107,49 +102,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specify the host type of the target. -Currently implemented targets are: - - CiscoUcs Establish a connection to a Cisco UCS fabric interconnect. - - FTP Establish a connection to a FTP host. - - NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer. - - VMware Establish a connection to a VMware vCenter or ESXi host. - - CisServer Establish a connection to a Vmware CisServer. - - ExchangeHTTP Start a new remote session to the given Exchange server via insecure http. - - Exchange HTTPS Start a new remote session to the given exchange server with the secure https endpoint. - - SCP Establish a SCP connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -Use this parameter to bypass the stored credentials. -Without this parameter Connect-To tries to read the -needed credentials from the CredentialStore. -If you provide this parameter you skip this lookup behavior. -So you can use it to enable credentials without preparing any user interaction. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Path Define a custom path to a shared CredentialStore. @@ -165,6 +117,21 @@ 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 Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which @@ -182,8 +149,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +Specify the host type of the target. +Currently implemented targets are: Possible connection values are: +CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 bcafe08..85e7950 100644 --- a/docs/Disconnect-From.md +++ b/docs/Disconnect-From.md @@ -63,6 +63,21 @@ Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS ## PARAMETERS +### -Force +Force the disconnect, even if the disconnect would fail. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoteHost Specify the remote endpoint, whose session you would like to terminate. @@ -80,15 +95,8 @@ Accept wildcard characters: False ### -Type Specify the host type of the target. -Currently implemented targets are: - - CiscoUcs Terminates the connection from a Cisco UCS Fabric Interconnect. - - FTP Terminates the connection from a FTP host. - - NetAppFAS Terminates the connection from a NetApp Clustered ONTAP filer. - - VMware Terminates the connection from a VMware vCenter or ESXi host. - - CisServer Terminates the connection from a Vmware CisServer. - - ExchangeHTTP Remove the existing remote session to the given Exchange server - - ExchangeHTTPS Remove the existing remote session to the given Exchange server - - SCP Terminates the existing SCP session. +Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware, +CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. ```yaml Type: String @@ -102,23 +110,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Force the disconnect, even if the disconnect would fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -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 4a9b63c..d22cd2d 100644 --- a/docs/Get-CredentialStore.md +++ b/docs/Get-CredentialStore.md @@ -71,7 +71,8 @@ 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 0962eb5..2491019 100644 --- a/docs/Get-CredentialStoreItem.md +++ b/docs/Get-CredentialStoreItem.md @@ -35,6 +35,24 @@ $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx0 ## PARAMETERS +### -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: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path Define a custom path to a shared CredentialStore. @@ -65,24 +83,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which @@ -101,7 +101,8 @@ 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 0962eb5..2cce87c 100644 --- a/docs/New-CredentialStore.md +++ b/docs/New-CredentialStore.md @@ -5,38 +5,79 @@ online version: https://github.com/OCram85/PSCredentialStore schema: 2.0.0 --- -# Get-CredentialStoreItem +# New-CredentialStore ## SYNOPSIS -Returns the Credential from a given remote host item. +Creates a new credential store File ## SYNTAX ### Private (Default) ``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [] +New-CredentialStore [-Force] [] ``` ### Shared ``` -Get-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] - [] +New-CredentialStore [-Shared] [-Path ] [-Force] [] ``` ## DESCRIPTION -Return the credential as PSCredential object. +You need to run this script first to create a new credential store before you try to +save new credentials with New-CredentialStoreItem. ## EXAMPLES ### EXAMPLE 1 ``` -$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +New-CredentialStore ``` +# 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path -Define a custom path to a shared CredentialStore. +Define a location for the new shared CredentialStore. +The default store will be created in +$Env:ProgramData\PSCredentialStore dir. ```yaml Type: String @@ -50,43 +91,11 @@ 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 -``` - -### -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: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. +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. ```yaml Type: SwitchParameter @@ -101,7 +110,8 @@ 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 @@ -109,11 +119,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### [System.Management.Automation.PSCredential] +### [None] ## NOTES \`\`\` -File Name : Get-CredentialStoreItem.ps1 +File Name : New-CredentialStore.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires : \`\`\` diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md index 1c373ea..9e6fc89 100644 --- a/docs/New-CredentialStoreItem.md +++ b/docs/New-CredentialStoreItem.md @@ -40,6 +40,39 @@ New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.lo ## PARAMETERS +### -Credential +You can provide credentials optionally as pre existing pscredential object. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path Define the store in which you would like to add a new item. @@ -70,39 +103,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -You can provide credentials optionally as pre existing pscredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared {{Fill Shared Description}} @@ -119,7 +119,8 @@ 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 6b840c0..da93bf4 100644 --- a/docs/PSCredentialStore.md +++ b/docs/PSCredentialStore.md @@ -12,35 +12,35 @@ Locale: en-US ## PSCredentialStore Cmdlets ### [Connect-To](Connect-To.md) -Connects to the given host using the stored CredentialStoreItem. +{{Manually Enter Connect-To Description Here}} ### [Disconnect-From](Disconnect-From.md) -Terminates a session established with Connect-To using a CredentialStoreItem. +{{Manually Enter Disconnect-From Description Here}} ### [Get-CredentialStore](Get-CredentialStore.md) -Reads the complete content of the credential store and returns it as a new object. +{{Manually Enter Get-CredentialStore Description Here}} ### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -Returns the Credential from a given remote host item. +{{Manually Enter Get-CredentialStoreItem Description Here}} -### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -Returns the Credential from a given remote host item. +### [New-CredentialStore](New-CredentialStore.md) +{{Manually Enter New-CredentialStore Description Here}} ### [New-CredentialStoreItem](New-CredentialStoreItem.md) -Adds a credential store item containing host, user and password to the given store. +{{Manually Enter New-CredentialStoreItem Description Here}} ### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) -Remove the given credentials from the credential store. +{{Manually Enter Remove-CredentialStoreItem Description Here}} ### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) -Changes the credentials for the given remote host in the store. +{{Manually Enter Set-CredentialStoreItem Description Here}} ### [Test-CredentialStore](Test-CredentialStore.md) -Returns the credential store state. +{{Manually Enter Test-CredentialStore Description Here}} ### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) -Checks if the given RemoteHost identifier combination exists in the credential store. +{{Manually Enter Test-CredentialStoreItem Description Here}} ### [Test-CSConnection](Test-CSConnection.md) -Returns the connection state of a given type to the remote host. +{{Manually Enter Test-CSConnection Description Here}} diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md index ee5757d..2fd8470 100644 --- a/docs/Remove-CredentialStoreItem.md +++ b/docs/Remove-CredentialStoreItem.md @@ -37,6 +37,23 @@ Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside ## PARAMETERS +### -Identifier +Defaults to "". +Specify a string, which separates two CredentialStoreItems for the +same hostname. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path Define the store in which your given host entry already exists. @@ -67,23 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identifier -Defaults to "". -Specify a string, which separates two CredentialStoreItems for the -same hostname. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which @@ -102,7 +102,8 @@ 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 34f119a..29a4385 100644 --- a/docs/Set-CredentialStoreItem.md +++ b/docs/Set-CredentialStoreItem.md @@ -37,6 +37,23 @@ Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.lo ## PARAMETERS +### -Identifier +Defaults to "". +Specify a string, which separates two CredentialStoreItems for the +same hostname. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path Define the store in which your given host entry already exists. @@ -67,23 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identifier -Defaults to "". -Specify a string, which separates two CredentialStoreItems for the -same hostname. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which @@ -102,7 +102,8 @@ 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 da6e927..2e0a607 100644 --- a/docs/Test-CSConnection.md +++ b/docs/Test-CSConnection.md @@ -61,7 +61,8 @@ 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 465d450..d8eaf62 100644 --- a/docs/Test-CredentialStore.md +++ b/docs/Test-CredentialStore.md @@ -71,7 +71,8 @@ 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 e5f5126..1635a9d 100644 --- a/docs/Test-CredentialStoreItem.md +++ b/docs/Test-CredentialStoreItem.md @@ -43,6 +43,23 @@ Else { ## PARAMETERS +### -Identifier +Adds an optional identifier to the given RemoteHost. +Makes it possible to store multiple credentials +for a single host. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Path Define a custom credential store you try to read from. Without the \`-Path\` parameter @@ -75,23 +92,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identifier -Adds an optional identifier to the given RemoteHost. -Makes it possible to store multiple credentials -for a single host. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Shared Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which @@ -110,7 +110,8 @@ 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