2022-07-13 08:34:31 +02:00
---
external help file: PSCredentialStore-help.xml
Module Name: PSCredentialStore
schema: 2.0.0
---
2017-09-28 11:08:41 +02:00
# Get-CredentialStoreItem
## SYNOPSIS
Returns the Credential from a given remote host item.
## SYNTAX
### Private (Default)
```
Get-CredentialStoreItem -RemoteHost < String > [-Identifier < String > ] [< CommonParameters > ]
```
### Shared
```
2019-01-16 12:55:29 +01:00
Get-CredentialStoreItem -RemoteHost < String > [-Identifier < String > ] [-Shared] [-Path < String > ]
2017-09-28 11:08:41 +02:00
[< CommonParameters > ]
```
## DESCRIPTION
Return the credential as PSCredential object.
## EXAMPLES
2022-07-13 08:34:31 +02:00
### EXAMPLE 1
2017-09-28 11:08:41 +02:00
```
$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
```
## PARAMETERS
2018-03-09 14:02:51 +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
2017-09-28 11:08:41 +02:00
```yaml
Type: String
2018-03-09 14:02:51 +01:00
Parameter Sets: (All)
Aliases:
2017-09-28 11:08:41 +02:00
Required: False
Position: Named
2018-03-09 14:02:51 +01:00
Default value: None
2017-09-28 11:08:41 +02:00
Accept pipeline input: False
Accept wildcard characters: False
```
2018-03-09 14:02:51 +01:00
### -Path
Define a custom path to a shared CredentialStore.
2017-09-28 11:08:41 +02:00
```yaml
Type: String
2018-03-09 14:02:51 +01:00
Parameter Sets: Shared
Aliases:
2017-09-28 11:08:41 +02:00
2018-03-09 14:02:51 +01:00
Required: False
2017-09-28 11:08:41 +02:00
Position: Named
2019-04-29 16:05:43 +02:00
Default value: None
2017-09-28 11:08:41 +02:00
Accept pipeline input: False
Accept wildcard characters: False
```
2018-03-09 14:02:51 +01:00
### -RemoteHost
Specify the host, for which you would like to change the credentials.
2017-09-28 11:08:41 +02:00
```yaml
Type: String
Parameter Sets: (All)
2018-03-09 14:02:51 +01:00
Aliases:
2017-09-28 11:08:41 +02:00
2018-03-09 14:02:51 +01:00
Required: True
2017-09-28 11:08:41 +02:00
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
2018-03-09 14:02:51 +01:00
Aliases:
2017-09-28 11:08:41 +02:00
2019-01-16 12:55:29 +01:00
Required: True
2017-09-28 11:08:41 +02:00
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
2019-04-29 16:05:43 +02: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 ).
2017-09-28 11:08:41 +02:00
## INPUTS
### [None]
## OUTPUTS
### [System.Management.Automation.PSCredential]
## NOTES
## RELATED LINKS