PSCredentialStore/docs/Test-CredentialStore.md

1.9 KiB

external help file Module Name online version schema
PSCredentialStore-help.xml PSCredentialStore https://github.com/OCram85/PSCredentialStore 2.0.0

Test-CredentialStore

SYNOPSIS

Returns the credential store state.

SYNTAX

Private (Default)

Test-CredentialStore [<CommonParameters>]

Shared

Test-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]

DESCRIPTION

Use this script to test your credential store. For now it only checks if the file exists.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Path

Define a custom path to a shared CredentialStore.

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

-Shared

Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which can be decrypted across systems.

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

NOTES

``` File Name : Test-CredentialStore.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires : ```

https://github.com/OCram85/PSCredentialStore