vSphere PowerCLI Reference

Remove-VICredentialStoreItem

Synopsis

Removes the specified credential store items.

Syntax

Remove-VICredentialStoreItem [-CredentialStoreItem] <VICredentialStoreItem[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-VICredentialStoreItem [[-Host] <String>] [[-User] <String>] [[-File] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VICredentialStoreItem
New-VICredentialStoreItem

Detailed Description

Removes the credential store items that match the specified Host and User parameters. At least one of the Host and User parameters must be provided. To remove all passwords, call ?Remove-VICredentialStoreItem *?, which is a wildcard matching all hosts.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
CredentialStoreItemVICredentialStoreItem[]Specify the credential store items you want to remove.truetrue (ByValue)
HostStringSpecify a host to filter the credential store items you want to remove.falsefalse
UserStringSpecify a user to filter the credential store items you want to remove.falsefalse
FileStringSpecifies the file location of the credential store items that are to be removed.falsefalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

None

Notes

Examples

-------------- Example 1 --------------

Remove-VICredentialStoreItem -Host 192.168.1.100 -Confirm

Removes all credentials for the specified host from the default credential store file.

-------------- Example 2 --------------

Remove-VICredentialStoreItem -User 'admin' -Host '192.168.*' -File 'credentials.xml' -Confirm

Removes all credentials for the specified user and network from a credential store file.


Copyright © 1998 - 2011 VMware, Inc. All rights reserved.