124 lines
2.8 KiB
Markdown
124 lines
2.8 KiB
Markdown
|
---
|
||
|
|
external help file: PSCredentialStore-help.xml
|
||
|
|
Module Name: PSCredentialStore
|
||
|
|
online version: https://github.com/OCram85/PSCredentialStore
|
||
|
|
schema: 2.0.0
|
||
|
|
---
|
||
|
|
|
||
|
|
# Remove-CredentialStoreItem
|
||
|
|
|
||
|
|
## SYNOPSIS
|
||
|
|
Remove the given credentials from the credential store.
|
||
|
|
|
||
|
|
## SYNTAX
|
||
|
|
|
||
|
|
### Private (Default)
|
||
|
|
```
|
||
|
|
Remove-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Shared
|
||
|
|
```
|
||
|
|
Remove-CredentialStoreItem [-Path <String>] -RemoteHost <String> [-Identifier <String>] [-Shared]
|
||
|
|
[<CommonParameters>]
|
||
|
|
```
|
||
|
|
|
||
|
|
## DESCRIPTION
|
||
|
|
Use this CMDLet to completely remove an credential store item.
|
||
|
|
|
||
|
|
## EXAMPLES
|
||
|
|
|
||
|
|
### -------------------------- EXAMPLE 1 --------------------------
|
||
|
|
```
|
||
|
|
Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
|
||
|
|
```
|
||
|
|
|
||
|
|
Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc
|
||
|
|
|
||
|
|
## PARAMETERS
|
||
|
|
|
||
|
|
### -Path
|
||
|
|
Define the store in which your given host entry already exists.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
### -RemoteHost
|
||
|
|
Specify the host you for which you would like to change the credentials.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: True
|
||
|
|
Position: Named
|
||
|
|
Default value: None
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -Identifier
|
||
|
|
Defaults to "".
|
||
|
|
Specify a string, which separates two CredentialStoreItems for the
|
||
|
|
same hostname.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: False
|
||
|
|
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
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: False
|
||
|
|
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
|
||
|
|
|
||
|
|
### [None]
|
||
|
|
|
||
|
|
## OUTPUTS
|
||
|
|
|
||
|
|
### [None]
|
||
|
|
|
||
|
|
## NOTES
|
||
|
|
File Name : Remove-CredentialStoreItem.ps1
|
||
|
|
Author : Marco Blessing - marco.blessing@googlemail.com
|
||
|
|
Requires :
|
||
|
|
|
||
|
|
## RELATED LINKS
|
||
|
|
|
||
|
|
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
||
|
|
|