PowerCLI Reference

Get-VICredentialStoreItem

Synopsis

This cmdlet retrieves the credential store items available on a vCenter Server system.

Syntax

Get-VICredentialStoreItem [[-Host] <String>] [[-User] <String>] [[-File] <String>] [<CommonParameters>]

Related Commands

Online Version
New-VICredentialStoreItem
Remove-VICredentialStoreItem

Detailed Description

This cmdlet retrieves the credential store items that correspond to the filter criteria defined by the Host and User parameters. Both the Host and User parameters support wildcards. If none of the Host and User parameters are specified, all available credential store items are returned. If the Host and User parameters are specified without using wildcards, and no item is found, non-terminating errors are reported for the Host and User parameters. If no file is specified, items are retrieved from the default credential store file %APPDATA%\VMware\credstore\vicredentials.xml.

Parameters

Name	Type	Description	Required?	Pipeline Input
Host	String	Specifies hosts for which you want to retrieve credential store items.	false	False
User	String	Specifies users for which you want to retrieve credential store items.	false	False
File	String	Specifies a path to a file where the credential store items that you want to retrieve are saved.	false	False

Return Type

Zero or more VICredentialStoreItem objects

Notes

This cmdlet is not supported on the Core edition of PowerShell.

Examples

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

Get-VICredentialStoreItem -User admin -Host 192.168.1.10 -File 'credentials.xml'

Retrieves the credentials for the 'admin' user on the specified host from a credential store file.