PSCredentialStore/docs/New-CredentialStoreItem.md

144 lines
3.2 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
---
# New-CredentialStoreItem
## SYNOPSIS
Adds a credential store item containing host, user and password to the given store.
## SYNTAX
### Private (Default)
```
New-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>]
[<CommonParameters>]
```
### Shared
```
New-CredentialStoreItem [-Path <String>] -RemoteHost <String> [-Identifier <String>]
[-Credential <PSCredential>] [-Shared] [<CommonParameters>]
```
## 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
2018-03-06 15:08:08 +01:00
### EXAMPLE 1
```
New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
```
## PARAMETERS
2018-03-08 10:19:25 +01:00
### -Credential
You can provide credentials optionally as pre existing pscredential object.
```yaml
2018-03-08 10:19:25 +01:00
Type: PSCredential
Parameter Sets: (All)
2018-03-06 15:08:08 +01:00
Aliases:
Required: False
Position: Named
2018-03-08 10:19:25 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2018-03-08 10:19:25 +01:00
### -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)
2018-03-06 15:08:08 +01:00
Aliases:
2018-03-08 10:19:25 +01:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2018-03-08 10:19:25 +01:00
### -Path
Define the store in which you would like to add a new item.
```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
```
2018-03-08 10:19:25 +01:00
### -RemoteHost
The identifier or rather name for the given credentials.
```yaml
2018-03-08 10:19:25 +01:00
Type: String
Parameter Sets: (All)
2018-03-06 15:08:08 +01:00
Aliases:
2018-03-08 10:19:25 +01:00
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Shared
{{Fill Shared Description}}
```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
### [None]
## NOTES
\`\`\`
File Name : New-CredentialStoreItem.ps1
Author : Marco Blessing - marco.blessing@googlemail.com
Requires :
\`\`\`
## RELATED LINKS
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)