From cff5b6f04a0973efdd2d0eb058618cd02693e64d Mon Sep 17 00:00:00 2001 From: OCram85 Date: Tue, 19 Jul 2022 11:12:36 +0200 Subject: [PATCH 1/2] remove terminating error --- src/Item/Test-CredentialStoreItem.ps1 | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/Item/Test-CredentialStoreItem.ps1 b/src/Item/Test-CredentialStoreItem.ps1 index d516f6f..66269e6 100644 --- a/src/Item/Test-CredentialStoreItem.ps1 +++ b/src/Item/Test-CredentialStoreItem.ps1 @@ -7,6 +7,10 @@ function Test-CredentialStoreItem { Use this cmdlet for basic checks with a single item. Check the item first with this function before you try to interact with it. + Breaking Change for `v1.1.0+`: + Test-CredentialStoreItem will return `$false` even if the store doesn't exist. We removed the terminating + error and replaced it with a warning message. + .PARAMETER Path Define a custom credential store you try to read from. Without the `-Path` parameter `Test-CredentialStoreItem` tries to read from the default private store. @@ -88,10 +92,10 @@ function Test-CredentialStoreItem { } else { $MsgParams = @{ - ErrorAction = 'Stop' - Message = "The given credential store ({0}) does not exist!" -f $Path + Message = "The given credential store ({0}) does not exist!" -f $Path } - Write-Error @MsgParams + Write-Warning @MsgParams + return $false } } -- 2.40.1 From d4633d4b806b1a601bb7fbe7863426e87cc6e8e0 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Tue, 19 Jul 2022 11:27:12 +0200 Subject: [PATCH 2/2] update docs --- docs/Connect-To.md | 389 +++++++++++----------- docs/Disconnect-From.md | 247 +++++++------- docs/Get-CSCertificate.md | 143 ++++---- docs/Get-CredentialStore.md | 167 +++++----- docs/Get-CredentialStoreItem.md | 227 ++++++------- docs/Import-CSCertificate.md | 145 ++++---- docs/New-CSCertAttribute.md | 303 +++++++++-------- docs/New-CSCertificate.md | 241 +++++++------- docs/New-CredentialStore.md | 405 ++++++++++++----------- docs/New-CredentialStoreItem.md | 267 +++++++-------- docs/{PSCredentialStore.md => Readme.md} | 128 +++---- docs/Remove-CredentialStoreItem.md | 255 +++++++------- docs/Set-CredentialStoreItem.md | 267 +++++++-------- docs/Test-CSCertificate.md | 113 +++---- docs/Test-CSConnection.md | 147 ++++---- docs/Test-CredentialStore.md | 161 ++++----- docs/Test-CredentialStoreItem.md | 249 +++++++------- docs/Use-CSCertificate.md | 215 ++++++------ 18 files changed, 2050 insertions(+), 2019 deletions(-) rename docs/{PSCredentialStore.md => Readme.md} (89%) diff --git a/docs/Connect-To.md b/docs/Connect-To.md index ed58751..719aa63 100644 --- a/docs/Connect-To.md +++ b/docs/Connect-To.md @@ -1,194 +1,195 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Connect-To - -## SYNOPSIS -Connects to the given host using the stored CredentialStoreItem. - -## SYNTAX - -### Private (Default) -``` -Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-PassThru] - [] -``` - -### Shared -``` -Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-Shared] - [-Path ] [-PassThru] [] -``` - -## DESCRIPTION -Establish a connection to the selected host using a stored CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs -``` - -### EXAMPLE 2 -``` -Connect-To -RemoteHost "ftp.myside.local" -Type FTP -``` - -### EXAMPLE 3 -``` -Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS -``` - -### EXAMPLE 4 -``` -Connect-To -RemoteHost "esx01.myside.local" -Type VMware -``` - -### EXAMPLE 5 -``` -Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer -``` - -### EXAMPLE 6 -``` -Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP -``` - -### EXAMPLE 7 -``` -Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS -``` - -## PARAMETERS - -### -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 -``` - -### -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 -``` - -### -PassThru -Returns the value from the underlying connection type function. - -```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. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -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 -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Connect-To + +## SYNOPSIS +Connects to the given host using the stored CredentialStoreItem. + +## SYNTAX + +### Private (Default) +``` +Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-PassThru] + [] +``` + +### Shared +``` +Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] [-Shared] + [-Path ] [-PassThru] [] +``` + +## DESCRIPTION +Establish a connection to the selected host using a stored CredentialStoreItem. + +## EXAMPLES + +### EXAMPLE 1 +``` +Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs +``` + +### EXAMPLE 2 +``` +Connect-To -RemoteHost "ftp.myside.local" -Type FTP +``` + +### EXAMPLE 3 +``` +Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS +``` + +### EXAMPLE 4 +``` +Connect-To -RemoteHost "esx01.myside.local" -Type VMware +``` + +### EXAMPLE 5 +``` +Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer +``` + +### EXAMPLE 6 +``` +Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP +``` + +### EXAMPLE 7 +``` +Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS +``` + +## PARAMETERS + +### -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 +``` + +### -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 +``` + +### -PassThru +Returns the value from the underlying connection type function. + +```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. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +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 +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/Disconnect-From.md b/docs/Disconnect-From.md index f4202fa..3d06081 100644 --- a/docs/Disconnect-From.md +++ b/docs/Disconnect-From.md @@ -1,123 +1,124 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Disconnect-From - -## SYNOPSIS -Terminates a session established with Connect-To using a CredentialStoreItem. - -## SYNTAX - -``` -Disconnect-From [-RemoteHost] [-Type] [-Force] [] -``` - -## DESCRIPTION -Terminates a session established with Connect-To using a CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs -``` - -### EXAMPLE 2 -``` -Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP -``` - -### EXAMPLE 3 -``` -Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS -``` - -### EXAMPLE 4 -``` -Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -``` - -### EXAMPLE 5 -``` -Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True -``` - -### EXAMPLE 6 -``` -Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer -``` - -### EXAMPLE 7 -``` -Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP -``` - -### EXAMPLE 8 -``` -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specify the host type of the target. -Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware, -CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Disconnect-From + +## SYNOPSIS +Terminates a session established with Connect-To using a CredentialStoreItem. + +## SYNTAX + +``` +Disconnect-From [-RemoteHost] [-Type] [-Force] [] +``` + +## DESCRIPTION +Terminates a session established with Connect-To using a CredentialStoreItem. + +## EXAMPLES + +### EXAMPLE 1 +``` +Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs +``` + +### EXAMPLE 2 +``` +Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP +``` + +### EXAMPLE 3 +``` +Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS +``` + +### EXAMPLE 4 +``` +Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware +``` + +### EXAMPLE 5 +``` +Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True +``` + +### EXAMPLE 6 +``` +Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer +``` + +### EXAMPLE 7 +``` +Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP +``` + +### EXAMPLE 8 +``` +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specify the host type of the target. +Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware, +CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/Get-CSCertificate.md b/docs/Get-CSCertificate.md index 4de7217..1b728f7 100644 --- a/docs/Get-CSCertificate.md +++ b/docs/Get-CSCertificate.md @@ -1,71 +1,72 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Get-CSCertificate - -## SYNOPSIS -Returns the current used valid PfX certificate. - -## SYNTAX - -``` -Get-CSCertificate [-Type] [-Thumbprint] [] -``` - -## DESCRIPTION -Use this function to get the available pfx certificate respecting the config hierarchy. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-CSCertificate -Type 'Shared' -Thumbprint '12334456' -``` - -## PARAMETERS - -### -Thumbprint -Provide the credentials thumbprint for the search. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Select the current credential store type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [System.Security.Cryptography.X509Certificates.X509Certificate2] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Get-CSCertificate + +## SYNOPSIS +Returns the current used valid PfX certificate. + +## SYNTAX + +``` +Get-CSCertificate [-Type] [-Thumbprint] [] +``` + +## DESCRIPTION +Use this function to get the available pfx certificate respecting the config hierarchy. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-CSCertificate -Type 'Shared' -Thumbprint '12334456' +``` + +## PARAMETERS + +### -Thumbprint +Provide the credentials thumbprint for the search. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Select the current credential store type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [System.Security.Cryptography.X509Certificates.X509Certificate2] +## NOTES + +## RELATED LINKS diff --git a/docs/Get-CredentialStore.md b/docs/Get-CredentialStore.md index 722bb8a..4134fdf 100644 --- a/docs/Get-CredentialStore.md +++ b/docs/Get-CredentialStore.md @@ -1,83 +1,84 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Get-CredentialStore - -## SYNOPSIS -Reads the complete content of the credential store and returns it as a new object. - -## SYNTAX - -### Private (Default) -``` -Get-CredentialStore [] -``` - -### Shared -``` -Get-CredentialStore [-Path ] [-Shared] [] -``` - -## DESCRIPTION -The content is in a raw format. -It means there is no transformation to the different credential types. -You can not use the object properties to connect with remote host. -Therefore please use -Get-CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" -``` - -## PARAMETERS - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [PSObject] Returns the credential store content as PSObject. -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Get-CredentialStore + +## SYNOPSIS +Reads the complete content of the credential store and returns it as a new object. + +## SYNTAX + +### Private (Default) +``` +Get-CredentialStore [] +``` + +### Shared +``` +Get-CredentialStore [-Path ] [-Shared] [] +``` + +## DESCRIPTION +The content is in a raw format. +It means there is no transformation to the different credential types. +You can not use the object properties to connect with remote host. +Therefore please use +Get-CredentialStoreItem. + +## EXAMPLES + +### EXAMPLE 1 +``` +$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" +``` + +## PARAMETERS + +### -Path +Define a custom path to a shared CredentialStore. + +```yaml +Type: String +Parameter Sets: Shared +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [PSObject] Returns the credential store content as PSObject. +## NOTES + +## RELATED LINKS diff --git a/docs/Get-CredentialStoreItem.md b/docs/Get-CredentialStoreItem.md index 013eb03..db80c90 100644 --- a/docs/Get-CredentialStoreItem.md +++ b/docs/Get-CredentialStoreItem.md @@ -1,113 +1,114 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Get-CredentialStoreItem - -## SYNOPSIS -Returns the Credential from a given remote host item. - -## SYNTAX - -### Private (Default) -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] - [] -``` - -## DESCRIPTION -Return the credential as PSCredential object. - -## EXAMPLES - -### EXAMPLE 1 -``` -$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -## 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. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -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 -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [System.Management.Automation.PSCredential] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Get-CredentialStoreItem + +## SYNOPSIS +Returns the Credential from a given remote host item. + +## SYNTAX + +### Private (Default) +``` +Get-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] + [] +``` + +## DESCRIPTION +Return the credential as PSCredential object. + +## EXAMPLES + +### EXAMPLE 1 +``` +$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +## 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. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +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 +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [System.Management.Automation.PSCredential] +## NOTES + +## RELATED LINKS diff --git a/docs/Import-CSCertificate.md b/docs/Import-CSCertificate.md index bcda028..82c186a 100644 --- a/docs/Import-CSCertificate.md +++ b/docs/Import-CSCertificate.md @@ -1,72 +1,73 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Import-CSCertificate - -## SYNOPSIS -Imports a linked certificate to the valid store location. - -## SYNTAX - -``` -Import-CSCertificate [-Type] [-Path] [] -``` - -## DESCRIPTION -Import-CSCertificate takes a pfx certificate file and imports it to the supposed certificate store for -private and shared credential stores. - -## EXAMPLES - -### EXAMPLE 1 -``` -Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx') -``` - -## PARAMETERS - -### -Path -Provide a valid path to pfx certificate file. - -```yaml -Type: FileInfo -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Select between the a private and shared credential store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Import-CSCertificate + +## SYNOPSIS +Imports a linked certificate to the valid store location. + +## SYNTAX + +``` +Import-CSCertificate [-Type] [-Path] [] +``` + +## DESCRIPTION +Import-CSCertificate takes a pfx certificate file and imports it to the supposed certificate store for +private and shared credential stores. + +## EXAMPLES + +### EXAMPLE 1 +``` +Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx') +``` + +## PARAMETERS + +### -Path +Provide a valid path to pfx certificate file. + +```yaml +Type: FileInfo +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Select between the a private and shared credential store. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/New-CSCertAttribute.md b/docs/New-CSCertAttribute.md index 5c2c5aa..e6fe320 100644 --- a/docs/New-CSCertAttribute.md +++ b/docs/New-CSCertAttribute.md @@ -1,147 +1,156 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# New-CSCertAttribute - -## SYNOPSIS -Creates required data for a certificate signing request. - -## SYNTAX - -``` -New-CSCertAttribute [-Country] [-State] [-City] [-Organization] - [-OrganizationalUnitName] [-CommonName] [[-Days] ] [] -``` - -## DESCRIPTION -Defines the certificate related properties for an upcoming New-PfxCertificate execution. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert' -``` - -## PARAMETERS - -### -City -Certificate city value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommonName -The certificate common name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -County code like EN, DE, IT, FR... - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Days -The validation time itself. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: 365 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -Certificate organization value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnitName -Certificate OrganizationalUnitName value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Certificate state value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [PSCredentialStore.Certificate.CSRDetails] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# New-CSCertAttribute + +## SYNOPSIS +Creates required data for a certificate signing request. + +## SYNTAX + +``` +New-CSCertAttribute [-Country] [-State] [-City] [-Organization] + [-OrganizationalUnitName] [-CommonName] [[-Days] ] [] +``` + +## DESCRIPTION +Defines the certificate related properties for an upcoming New-PfxCertificate execution. + +## EXAMPLES + +### EXAMPLE 1 +``` +$AttribParams = @{ + Country = 'DE' + State = 'BW' + City = 'Karlsruhe' + Organization ='AwesomeIT' + OrganizationalUnitName ='PSCredentialStore' + CommonName ='MyPrivateCert' +} +New-CSCertAttribute @AttribParams +``` + +## PARAMETERS + +### -City +Certificate city value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonName +The certificate common name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +County code like EN, DE, IT, FR... + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Days +The validation time itself. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: 365 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +Certificate organization value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnitName +Certificate OrganizationalUnitName value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Certificate state value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [PSCredentialStore.Certificate.CSRDetails] +## NOTES + +## RELATED LINKS diff --git a/docs/New-CSCertificate.md b/docs/New-CSCertificate.md index cdf7a8a..90d10cb 100644 --- a/docs/New-CSCertificate.md +++ b/docs/New-CSCertificate.md @@ -1,120 +1,121 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# New-CSCertificate - -## SYNOPSIS -Creates a new PFX certificate for the CredentialStore encryption. - -## SYNTAX - -``` -New-CSCertificate [-CRTAttribute] [[-KeyName] ] [[-CertName] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Use this function to create a custom self signed certificate used by the PSCredentialStore module. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx' -``` - -## PARAMETERS - -### -CertName -Provide a custom full path and name for the PFX certificate file. -The file extension has to be \`*.pfx\` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: ./certificate.pfx -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CRTAttribute -Provide certificate related attributes provided by function New-CRTAttribute. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -Provide a custom full path and name for the private key. -The file extension has to be \`*.key\`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: ./private.key -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -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). - -## INPUTS - -### [PSCredentialStore.Certificate.Attribute] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# New-CSCertificate + +## SYNOPSIS +Creates a new PFX certificate for the CredentialStore encryption. + +## SYNTAX + +``` +New-CSCertificate [-CRTAttribute] [[-KeyName] ] [[-CertName] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Use this function to create a custom self signed certificate used by the PSCredentialStore module. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx' +``` + +## PARAMETERS + +### -CertName +Provide a custom full path and name for the PFX certificate file. +The file extension has to be \`*.pfx\` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: ./certificate.pfx +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CRTAttribute +Provide certificate related attributes provided by function New-CRTAttribute. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +Provide a custom full path and name for the private key. +The file extension has to be \`*.key\`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: ./private.key +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +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). + +## INPUTS + +### [PSCredentialStore.Certificate.Attribute] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/New-CredentialStore.md b/docs/New-CredentialStore.md index f1e25dd..29de94d 100644 --- a/docs/New-CredentialStore.md +++ b/docs/New-CredentialStore.md @@ -1,202 +1,203 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# New-CredentialStore - -## SYNOPSIS -Creates a new credential store File - -## SYNTAX - -### Private (Default) -``` -New-CredentialStore [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] [-WhatIf] [-Confirm] - [] -``` - -### Shared -``` -New-CredentialStore [-Shared] [-Path ] [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -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 -``` -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 -``` - -### -PassThru -{{ Fill PassThru Description }} - -```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 location for the new shared CredentialStore. -The default store will be created in -$Env:ProgramData\PSCredentialStore dir. - -```yaml -Type: FileInfo -Parameter Sets: Shared -Aliases: - -Required: False -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPFXCertCreation -You can skip the pfx certificate creation process. -This makes sense if you have a previously created cert or want to -import a cert in cross-platform environments. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseCertStore -Instead of using a plain pfx file beside your CredentialStore file you can import it into the user or machine -certificate store. -In this case the system itself secures the cert and you don't hat to set custom NTFS -permissions so secure your shared certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -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). - -## INPUTS - -### [None] -## OUTPUTS - -### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter -### was given. -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# New-CredentialStore + +## SYNOPSIS +Creates a new credential store File + +## SYNTAX + +### Private (Default) +``` +New-CredentialStore [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] [-WhatIf] [-Confirm] + [] +``` + +### Shared +``` +New-CredentialStore [-Shared] [-Path ] [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +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 +``` +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 +``` + +### -PassThru +{{ Fill PassThru Description }} + +```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 location for the new shared CredentialStore. +The default store will be created in +$Env:ProgramData\PSCredentialStore dir. + +```yaml +Type: FileInfo +Parameter Sets: Shared +Aliases: + +Required: False +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPFXCertCreation +You can skip the pfx certificate creation process. +This makes sense if you have a previously created cert +or want to import a cert in cross-platform environments. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCertStore +Instead of using a plain pfx file beside your CredentialStore file you can import it into the user or +machine certificate store. +In this case the system itself secures the cert and you don't hat to set custom +NTFS permissions so secure your shared certificate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +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). + +## INPUTS + +### [None] +## OUTPUTS + +### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter +### was given. +## NOTES + +## RELATED LINKS diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md index a310af1..a5071eb 100644 --- a/docs/New-CredentialStoreItem.md +++ b/docs/New-CredentialStoreItem.md @@ -1,133 +1,134 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# New-CredentialStoreItem - -## SYNOPSIS -Adds a credential store item containing host, user and password to the given store. - -## SYNTAX - -### Private (Default) -``` -New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] - [] -``` - -### Shared -``` -New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] - [-Path ] [] -``` - -## DESCRIPTION -The credentials are stored without any relations to it's further use. -If you need to change an existing -item please use Set-CredentialStoreItem. -You need to decide afterwards, whether to use the credential for -a VIConnection, NetApp FAS or UCS Fabric Interconnect. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -## 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: True (ByValue) -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. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -The identifier or rather name for the given credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Define the CredentialStore where you want to add the new item. -Default is always personal but can be -changed to shared, or even shared with custom path. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# New-CredentialStoreItem + +## SYNOPSIS +Adds a credential store item containing host, user and password to the given store. + +## SYNTAX + +### Private (Default) +``` +New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] + [] +``` + +### Shared +``` +New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] +``` + +## DESCRIPTION +The credentials are stored without any relations to it's further use. +If you need to change an existing +item please use Set-CredentialStoreItem. +You need to decide afterwards, whether to use the credential for +a VIConnection, NetApp FAS or UCS Fabric Interconnect. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +## 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: True (ByValue) +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. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHost +The identifier or rather name for the given credentials. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Define the CredentialStore where you want to add the new item. +Default is always personal but can be +changed to shared, or even shared with custom path. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/PSCredentialStore.md b/docs/Readme.md similarity index 89% rename from docs/PSCredentialStore.md rename to docs/Readme.md index 219b581..5da4a0c 100644 --- a/docs/PSCredentialStore.md +++ b/docs/Readme.md @@ -1,64 +1,64 @@ ---- -Module Name: PSCredentialStore -Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 6800e192-9df8-4e30-b253-eb2c799bbe84 -Download Help Link: {{ Update Download Link }} -Help Version: {{ Please enter version of help manually (X.X.X.X) format }} -Locale: en-US ---- - -# PSCredentialStore Module -## Description -{{ Fill in the Description }} - -## PSCredentialStore Cmdlets -### [Connect-To](Connect-To.md) -Connects to the given host using the stored CredentialStoreItem. - -### [Disconnect-From](Disconnect-From.md) -Terminates a session established with Connect-To using a CredentialStoreItem. - -### [Get-CredentialStore](Get-CredentialStore.md) -Reads the complete content of the credential store and returns it as a new object. - -### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -Returns the Credential from a given remote host item. - -### [Get-CSCertificate](Get-CSCertificate.md) -Returns the current used valid PfX certificate. - -### [Import-CSCertificate](Import-CSCertificate.md) -Imports a linked certificate to the valid store location. - -### [New-CredentialStore](New-CredentialStore.md) -Creates a new credential store File - -### [New-CredentialStoreItem](New-CredentialStoreItem.md) -Adds a credential store item containing host, user and password to the given store. - -### [New-CSCertAttribute](New-CSCertAttribute.md) -Creates required data for a certificate signing request. - -### [New-CSCertificate](New-CSCertificate.md) -Creates a new PFX certificate for the CredentialStore encryption. - -### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) -Remove the given credentials from the credential store. - -### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) -Changes the credentials for the given remote host in the store. - -### [Test-CredentialStore](Test-CredentialStore.md) -Returns the credential store state. - -### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) -Checks if the given RemoteHost identifier combination exists in the credential store. - -### [Test-CSCertificate](Test-CSCertificate.md) -Tests if the linked certificate is store ein the specified cert stores. - -### [Test-CSConnection](Test-CSConnection.md) -Returns the connection state of a given type to the remote host. - -### [Use-CSCertificate](Use-CSCertificate.md) -Links an existing PFX Certificate to a CredentialStore. - +--- +Module Name: PSCredentialStore +Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 +Download Help Link: {{ Update Download Link }} +Help Version: {{ Update Help Version }} +Locale: en-US +--- + +# PSCredentialStore Module +## Description +See global Readme file for usage instructions. + +## PSCredentialStore Cmdlets +### [Connect-To](Connect-To.md) +Connects to the given host using the stored CredentialStoreItem. + +### [Disconnect-From](Disconnect-From.md) +Terminates a session established with Connect-To using a CredentialStoreItem. + +### [Get-CredentialStore](Get-CredentialStore.md) +Reads the complete content of the credential store and returns it as a new object. + +### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) +Returns the Credential from a given remote host item. + +### [Get-CSCertificate](Get-CSCertificate.md) +Returns the current used valid PfX certificate. + +### [Import-CSCertificate](Import-CSCertificate.md) +Imports a linked certificate to the valid store location. + +### [New-CredentialStore](New-CredentialStore.md) +Creates a new credential store File + +### [New-CredentialStoreItem](New-CredentialStoreItem.md) +Adds a credential store item containing host, user and password to the given store. + +### [New-CSCertAttribute](New-CSCertAttribute.md) +Creates required data for a certificate signing request. + +### [New-CSCertificate](New-CSCertificate.md) +Creates a new PFX certificate for the CredentialStore encryption. + +### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) +Remove the given credentials from the credential store. + +### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) +Changes the credentials for the given remote host in the store. + +### [Test-CredentialStore](Test-CredentialStore.md) +Returns the credential store state. + +### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) +Checks if the given RemoteHost identifier combination exists in the credential store. + +### [Test-CSCertificate](Test-CSCertificate.md) +Tests if the linked certificate is store ein the specified cert stores. + +### [Test-CSConnection](Test-CSConnection.md) +Returns the connection state of a given type to the remote host. + +### [Use-CSCertificate](Use-CSCertificate.md) +Links an existing PFX Certificate to a CredentialStore. + diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md index 9cac167..3066888 100644 --- a/docs/Remove-CredentialStoreItem.md +++ b/docs/Remove-CredentialStoreItem.md @@ -1,127 +1,128 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Remove-CredentialStoreItem - -## SYNOPSIS -Remove the given credentials from the credential store. - -## SYNTAX - -### Private (Default) -``` -Remove-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Remove-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] - [] -``` - -## DESCRIPTION -Use this CMDLet to completely remove an credential store item. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -``` - -### EXAMPLE 2 -``` -Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local" -``` - -### EXAMPLE 3 -``` -Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -### EXAMPLE 4 -``` -Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc -``` - -## 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. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host you 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 -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Remove-CredentialStoreItem + +## SYNOPSIS +Remove the given credentials from the credential store. + +## SYNTAX + +### Private (Default) +``` +Remove-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Remove-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] + [] +``` + +## DESCRIPTION +Use this CMDLet to completely remove an credential store item. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" +``` + +### EXAMPLE 2 +``` +Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local" +``` + +### EXAMPLE 3 +``` +Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +### EXAMPLE 4 +``` +Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc +``` + +## 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. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHost +Specify the host you 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 +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/Set-CredentialStoreItem.md b/docs/Set-CredentialStoreItem.md index b717464..9ddb5d6 100644 --- a/docs/Set-CredentialStoreItem.md +++ b/docs/Set-CredentialStoreItem.md @@ -1,133 +1,134 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Set-CredentialStoreItem - -## SYNOPSIS -Changes the credentials for the given remote host in the store. - -## SYNTAX - -### Private (Default) -``` -Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] - [] -``` - -### Shared -``` -Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] - [-Path ] [] -``` - -## DESCRIPTION -Use this function to update your already stored RemoteHost items. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -### EXAMPLE 2 -``` -Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc -``` - -## PARAMETERS - -### -Credential -Provided the new credentials you want to update inside the RemoteHost item. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 -``` - -### -Path -Define the store in which your given host entry already exists. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host you 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 -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Set-CredentialStoreItem + +## SYNOPSIS +Changes the credentials for the given remote host in the store. + +## SYNTAX + +### Private (Default) +``` +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] + [] +``` + +### Shared +``` +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] +``` + +## DESCRIPTION +Use this function to update your already stored RemoteHost items. + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" +``` + +### EXAMPLE 2 +``` +Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc +``` + +## PARAMETERS + +### -Credential +Provided the new credentials you want to update inside the RemoteHost item. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -Path +Define the store in which your given host entry already exists. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteHost +Specify the host you 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 +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/Test-CSCertificate.md b/docs/Test-CSCertificate.md index 0e3da12..2be9631 100644 --- a/docs/Test-CSCertificate.md +++ b/docs/Test-CSCertificate.md @@ -1,56 +1,57 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Test-CSCertificate - -## SYNOPSIS -Tests if the linked certificate is store ein the specified cert stores. - -## SYNTAX - -``` -Test-CSCertificate [-Type] [] -``` - -## DESCRIPTION -Test-CSCertificate should be an easy high level test for the linked certificate. - -## EXAMPLES - -### EXAMPLE 1 -``` -Test-CSCertificate -Type 'Shared' -``` - -## PARAMETERS - -### -Type -Select between 'Private' or 'Shared'. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [bool] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Test-CSCertificate + +## SYNOPSIS +Tests if the linked certificate is store ein the specified cert stores. + +## SYNTAX + +``` +Test-CSCertificate [-Type] [] +``` + +## DESCRIPTION +Test-CSCertificate should be an easy high level test for the linked certificate. + +## EXAMPLES + +### EXAMPLE 1 +``` +Test-CSCertificate -Type 'Shared' +``` + +## PARAMETERS + +### -Type +Select between 'Private' or 'Shared'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [bool] +## NOTES + +## RELATED LINKS diff --git a/docs/Test-CSConnection.md b/docs/Test-CSConnection.md index 942e874..2e345e9 100644 --- a/docs/Test-CSConnection.md +++ b/docs/Test-CSConnection.md @@ -1,73 +1,74 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Test-CSConnection - -## SYNOPSIS -Returns the connection state of a given type to the remote host. - -## SYNTAX - -``` -Test-CSConnection [-RemoteHost] [-Type] [] -``` - -## DESCRIPTION -Use this script to check a connection which was established with the \`Connect-To\` cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware -``` - -## PARAMETERS - -### -RemoteHost -Define the remote host you would like to check. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Define the connection type you would like to check. -See the \`Connect-To\` documentation -for valid type values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [bool] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Test-CSConnection + +## SYNOPSIS +Returns the connection state of a given type to the remote host. + +## SYNTAX + +``` +Test-CSConnection [-RemoteHost] [-Type] [] +``` + +## DESCRIPTION +Use this script to check a connection which was established with the \`Connect-To\` cmdlet. + +## EXAMPLES + +### EXAMPLE 1 +``` +Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware +``` + +## PARAMETERS + +### -RemoteHost +Define the remote host you would like to check. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Define the connection type you would like to check. +See the \`Connect-To\` documentation +for valid type values. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [bool] +## NOTES + +## RELATED LINKS diff --git a/docs/Test-CredentialStore.md b/docs/Test-CredentialStore.md index c1a1ea5..83aac0a 100644 --- a/docs/Test-CredentialStore.md +++ b/docs/Test-CredentialStore.md @@ -1,80 +1,81 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Test-CredentialStore - -## SYNOPSIS -Returns the credential store state. - -## SYNTAX - -### Private (Default) -``` -Test-CredentialStore [] -``` - -### Shared -``` -Test-CredentialStore [-Path ] [-Shared] [] -``` - -## DESCRIPTION -Use this script to test your credential store. -For now it only checks if -the file exists. - -## EXAMPLES - -### EXAMPLE 1 -``` -Test-CredentialStore -eq $true -``` - -## PARAMETERS - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -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. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### System.Boolean -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Test-CredentialStore + +## SYNOPSIS +Returns the credential store state. + +## SYNTAX + +### Private (Default) +``` +Test-CredentialStore [] +``` + +### Shared +``` +Test-CredentialStore [-Path ] [-Shared] [] +``` + +## DESCRIPTION +Use this script to test your credential store. +For now it only checks if +the file exists. + +## EXAMPLES + +### EXAMPLE 1 +``` +Test-CredentialStore -eq $true +``` + +## PARAMETERS + +### -Path +Define a custom path to a shared CredentialStore. + +```yaml +Type: String +Parameter Sets: Shared +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. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS diff --git a/docs/Test-CredentialStoreItem.md b/docs/Test-CredentialStoreItem.md index ea68aa8..ea3a1a2 100644 --- a/docs/Test-CredentialStoreItem.md +++ b/docs/Test-CredentialStoreItem.md @@ -1,121 +1,128 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Test-CredentialStoreItem - -## SYNOPSIS -Checks if the given RemoteHost identifier combination exists in the credential store. - -## SYNTAX - -### Private (Default) -``` -Test-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Test-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] - [] -``` - -## DESCRIPTION -Use this cmdlet for basic checks with a single item. -Check the item first with this function before -you try to interact with it. - -## EXAMPLES - -### EXAMPLE 1 -``` -if (Test-CredentialStoreItem -RemoteHost "Default") { - Get-CredentialStoreItem -RemoteHost "Default" -} -else { - Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost) -} -``` - -## 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 -\`Test-CredentialStoreItem\` tries to read from the default private store. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -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 -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Test-CredentialStoreItem + +## SYNOPSIS +Checks if the given RemoteHost identifier combination exists in the credential store. + +## SYNTAX + +### Private (Default) +``` +Test-CredentialStoreItem -RemoteHost [-Identifier ] [] +``` + +### Shared +``` +Test-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] + [] +``` + +## DESCRIPTION +Use this cmdlet for basic checks with a single item. +Check the item first with this function before +you try to interact with it. + +> :bulb: Breaking Change for \`v1.1.0+\`: +> +> Test-CredentialStoreItem will return \`$false\` even if the store doesn't exist. +> We removed the terminating +> error and replaced it with a warning message. + +## EXAMPLES + +### EXAMPLE 1 +``` +if (Test-CredentialStoreItem -RemoteHost "Default") { + Get-CredentialStoreItem -RemoteHost "Default" +} +else { + Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost) +} +``` + +## 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 +\`Test-CredentialStoreItem\` tries to read from the default private store. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData +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 +can be decrypted across systems. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS diff --git a/docs/Use-CSCertificate.md b/docs/Use-CSCertificate.md index d145073..70dc9eb 100644 --- a/docs/Use-CSCertificate.md +++ b/docs/Use-CSCertificate.md @@ -1,107 +1,108 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -schema: 2.0.0 ---- - -# Use-CSCertificate - -## SYNOPSIS -Links an existing PFX Certificate to a CredentialStore. - -## SYNTAX - -### Private (Default) -``` -Use-CSCertificate -Path [-UseCertStore] [] -``` - -### Shared -``` -Use-CSCertificate -Path [-CredentialStore ] [-Shared] [-UseCertStore] [] -``` - -## DESCRIPTION -Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios. - -## EXAMPLES - -### EXAMPLE 1 -``` -Use-CSCertificate -Path 'C:\cert.pfx' -``` - -## PARAMETERS - -### -CredentialStore -Specify a custom path for a shared credential store. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specify the path to the PFX Certificate you want to link for usage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Use the credential store in shared mode. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseCertStore -Use the given certificate and import it into the corresponding certificate store. - -```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). - -## INPUTS - -### [None] -## OUTPUTS - -### [None] -## NOTES - -## RELATED LINKS +--- +external help file: ModuleRoot-help.xml +Module Name: PSCredentialStore +online version: +schema: 2.0.0 +--- + +# Use-CSCertificate + +## SYNOPSIS +Links an existing PFX Certificate to a CredentialStore. + +## SYNTAX + +### Private (Default) +``` +Use-CSCertificate -Path [-UseCertStore] [] +``` + +### Shared +``` +Use-CSCertificate -Path [-CredentialStore ] [-Shared] [-UseCertStore] [] +``` + +## DESCRIPTION +Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios. + +## EXAMPLES + +### EXAMPLE 1 +``` +Use-CSCertificate -Path 'C:\cert.pfx' +``` + +## PARAMETERS + +### -CredentialStore +Specify a custom path for a shared credential store. + +```yaml +Type: String +Parameter Sets: Shared +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specify the path to the PFX Certificate you want to link for usage. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Use the credential store in shared mode. + +```yaml +Type: SwitchParameter +Parameter Sets: Shared +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCertStore +Use the given certificate and import it into the corresponding certificate store. + +```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). + +## INPUTS + +### [None] +## OUTPUTS + +### [None] +## NOTES + +## RELATED LINKS -- 2.40.1