< Back
Remove-VICredentialStoreItem
Post
NAME Remove-VICredentialStoreItem
SYNOPSIS
This cmdlet removes the specified credential store items.
SYNTAX
Remove-VICredentialStoreItem [-CredentialStoreItem] <VICredentialStoreItem[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-VICredentialStoreItem [[-Host] <String>] [[-User] <String>] [[-File] <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet 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
-CredentialStoreItem <VICredentialStoreItem[]>
Specifies the credential store items you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-File <String>
Specifies the file location of the credential store items that are to be removed.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Host <String>
Specifies a host to filter the credential store items you want to remove.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-User <String>
Specifies a user to filter the credential store items you want to remove.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
This cmdlet is not supported on the Core edition of PowerShell.
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... eItem.html
Get-VICredentialStoreItem
New-VICredentialStoreItem
SYNOPSIS
This cmdlet removes the specified credential store items.
SYNTAX
Remove-VICredentialStoreItem [-CredentialStoreItem] <VICredentialStoreItem[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-VICredentialStoreItem [[-Host] <String>] [[-User] <String>] [[-File] <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet 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
-CredentialStoreItem <VICredentialStoreItem[]>
Specifies the credential store items you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-File <String>
Specifies the file location of the credential store items that are to be removed.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Host <String>
Specifies a host to filter the credential store items you want to remove.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-User <String>
Specifies a user to filter the credential store items you want to remove.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
This cmdlet is not supported on the Core edition of PowerShell.
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... eItem.html
Get-VICredentialStoreItem
New-VICredentialStoreItem