PSCredentialStore/docs/New-CredentialStore.md

135 lines
2.8 KiB
Markdown
Raw Normal View History

---
external help file: PSCredentialStore-help.xml
Module Name: PSCredentialStore
online version: https://github.com/OCram85/PSCredentialStore
schema: 2.0.0
---
2018-03-08 10:19:25 +01:00
# New-CredentialStore
## SYNOPSIS
2018-03-08 10:19:25 +01:00
Creates a new credential store File
## SYNTAX
### Private (Default)
```
2018-03-08 10:19:25 +01:00
New-CredentialStore [-Force] [<CommonParameters>]
```
### Shared
```
2018-03-08 10:19:25 +01:00
New-CredentialStore [-Shared] [-Path <String>] [-Force] [<CommonParameters>]
```
## DESCRIPTION
2018-03-08 10:19:25 +01:00
You need to run this script first to create a new credential store before you try to
save new credentials with New-CredentialStoreItem.
## EXAMPLES
2018-03-06 15:08:08 +01:00
### EXAMPLE 1
```
2018-03-08 10:19:25 +01:00
New-CredentialStore
```
2018-03-08 10:19:25 +01:00
# Creates a new private CredentialStore
2018-03-08 10:19:25 +01:00
### EXAMPLE 2
```
New-CredentialStore -Force
```
2018-03-08 10:19:25 +01:00
# Resets an existing private CredentialStore
2018-03-08 10:19:25 +01:00
### EXAMPLE 3
```
New-CredentialStore -Shared
```
# Creates a new shared CredentialStore
### EXAMPLE 4
```
2018-03-08 10:19:25 +01:00
New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"
```
# Creates a new shared CredentialStore in the given location.
2018-03-08 10:19:25 +01:00
## PARAMETERS
### -Force
Use this switch to reset an existing store.
The complete content will be wiped.
```yaml
2018-03-08 10:19:25 +01:00
Type: SwitchParameter
Parameter Sets: (All)
2018-03-06 15:08:08 +01:00
Aliases:
2018-03-08 10:19:25 +01:00
Required: False
Position: Named
2018-03-08 10:19:25 +01:00
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
2018-03-08 10:19:25 +01:00
### -Path
Define a location for the new shared CredentialStore.
The default store will be created in
$Env:ProgramData\PSCredentialStore dir.
```yaml
Type: String
2018-03-08 10:19:25 +01:00
Parameter Sets: Shared
2018-03-06 15:08:08 +01:00
Aliases:
Required: False
Position: Named
2018-03-08 10:19:25 +01:00
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
Accept pipeline input: False
Accept wildcard characters: False
```
### -Shared
2018-03-08 10:19:25 +01:00
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
2018-03-06 15:08:08 +01:00
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
2018-03-08 10:19:25 +01:00
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
2018-03-08 10:19:25 +01:00
### [None]
## NOTES
\`\`\`
2018-03-08 10:19:25 +01:00
File Name : New-CredentialStore.ps1
Author : Marco Blessing - marco.blessing@googlemail.com
Requires :
\`\`\`
## RELATED LINKS
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)