powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-VIAccount



NAME
Get-VIAccount

SYNOPSIS
Retrieves the accounts from the ESX or vCenter Server.

SYNTAX
Get-VIAccount [-Group] [-User] [[-Name] ] [-Server ] []

Get-VIAccount [-Group] [-User] [[-Id] ] [-Domain ] [-Server ] []


DESCRIPTION
Retrieves the accounts from the ESX or vCenter Server. Use the Group and User switch parameters to retrieve group a
nd user accounts. By default, the cmdlet lists only user accounts. If the Domain parameter is specified, the cmdlet
retrieves only the accounts on the specified AD domain, otherwise only local accounts are listed.


PARAMETERS
-Group
Specify that you want to retrieve only group accounts.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-User
Specify that you want to retrieve only user accounts.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Name
Specify the names of the accounts you want to retrieve.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Id
Specify the Ids of the accounts you want to retrieve.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Domain
Specify AD domains to search for accounts.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VIAccount


NOTES




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

C:\PS>Get-VIAccount -Id Administrator


Retrieve accounts by Id.





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

C:\PS>Get-VIAccount -Group


Retrieve all group accounts.





-------------- Example 3 --------------

C:\PS>Get-VIAccount -Server 10.23.111.23


Retrieve all accounts for the specified server.





-------------- Example 4 --------------

C:\PS>Get-VIAccount -Domain "MSDomain"


Retrieve all accounts for the specified domain.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-VIAccount.html
New-VMHostAccount
Set-VMHostAccount
Remove-VMHostAccount