PSCredentialStore/docs/New-CredentialStoreItem.md

132 lines
2.9 KiB
Markdown
Raw Normal View History

2019-04-08 13:12:15 +02:00
# 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 -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>] [-Shared]
[-Path <String>] [<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
### BEISPIEL 1
```
New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
```
## PARAMETERS
2019-04-08 15:25:08 +02:00
### -Credential
You can provide credentials optionally as pre existing pscredential object.
2019-04-08 13:12:15 +02:00
```yaml
2019-04-08 15:25:08 +02:00
Type: PSCredential
2019-04-08 13:12:15 +02:00
Parameter Sets: (All)
Aliases:
2019-04-08 15:25:08 +02:00
Required: False
2019-04-08 13:12:15 +02:00
Position: Named
Default value: None
2019-04-08 15:25:08 +02:00
Accept pipeline input: True (ByValue)
2019-04-08 13:12:15 +02:00
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
```
2019-04-08 15:25:08 +02:00
### -Path
Define the store in which you would like to add a new item.
2019-04-08 13:12:15 +02:00
```yaml
2019-04-08 15:25:08 +02:00
Type: String
Parameter Sets: Shared
2019-04-08 13:12:15 +02:00
Aliases:
Required: False
Position: Named
Default value: None
2019-04-08 15:25:08 +02:00
Accept pipeline input: False
2019-04-08 13:12:15 +02:00
Accept wildcard characters: False
```
2019-04-08 15:25:08 +02:00
### -RemoteHost
The identifier or rather name for the given credentials.
2019-04-08 13:12:15 +02:00
```yaml
2019-04-08 15:25:08 +02:00
Type: String
Parameter Sets: (All)
2019-04-08 13:12:15 +02:00
Aliases:
Required: True
Position: Named
2019-04-08 15:25:08 +02:00
Default value: None
2019-04-08 13:12:15 +02:00
Accept pipeline input: False
Accept wildcard characters: False
```
2019-04-08 15:25:08 +02:00
### -Shared
{{ Fill Shared Description }}
2019-04-08 13:12:15 +02:00
```yaml
2019-04-08 15:25:08 +02:00
Type: SwitchParameter
2019-04-08 13:12:15 +02:00
Parameter Sets: Shared
Aliases:
2019-04-08 15:25:08 +02:00
Required: True
2019-04-08 13:12:15 +02:00
Position: Named
2019-04-08 15:25:08 +02:00
Default value: False
2019-04-08 13:12:15 +02:00
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
- 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)