PSCredentialStore/docs/Remove-CredentialStoreItem.md

2.5 KiB

external help file Module Name online version schema
ModuleRoot-help.xml PSCredentialStore 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 -RemoteHost <String> [-Identifier <String>] [-Shared] [-Path <String>]
 [<CommonParameters>]

DESCRIPTION

Use this CMDLet to completely remove an credential store item.

EXAMPLES

EXAMPLE 1

Remove-CredentialStoreItem -RemoteHost "esx01.myside.local"

EXAMPLE 2

Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local"

EXAMPLE 3

Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"

EXAMPLE 4

Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc

PARAMETERS

-Identifier

Defaults to "". Specify a string, which separates two CredentialStoreItems for the same hostname.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Define the store in which your given host entry already exists.

Type: String
Parameter Sets: Shared
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteHost

Specify the host you for which you would like to change the credentials.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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.

Type: SwitchParameter
Parameter Sets: Shared
Aliases:

Required: True
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.

INPUTS

[None]

OUTPUTS

[None]

NOTES