vSphere PowerCLI Reference

Get-VICredentialStoreItem

Synopsis

Retrieves the credential store items available on a vSphere server.

Syntax

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

Related Commands

Online version
New-VICredentialStoreItem
Remove-VICredentialStoreItem

Detailed Description

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 he 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

NameTypeDescriptionRequired?Pipeline InputDefault Value
HostStringSpecify hosts for which you want to retrieve credential store items.falsefalse
UserStringSpecify users for which you want to retrieve credential store items.falsefalse
FileStringSpecify a path to a file where the credential store items that you want to retrieve are saved.falsefalse

Return Type

VICredentialStoreItem

Notes

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.


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