Get-VcsUser Command | Vmware PowerCLI Reference

Get-VcsUser

This cmdlet retrieves users from the VMware Cloud Services Platform.

Syntax

Get-VcsUser
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < IVcsServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies the names of the users you want to retrieve.
optional ProgressAction ActionPreference named
optional Server IVcsServer[] named
  • wildcards
Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet.
Get-VcsUser
[-Id < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < IVcsServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Id String[] named
Specifies the IDs of the users you want to retrieve.
optional ProgressAction ActionPreference named
optional Server IVcsServer[] named
  • wildcards
Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet.

Output

VMware.CloudServices.Types.V1.CmdletOutput.IVcsUser

Examples

Example 1

Get-VcsUser -Id "UserId"

Retrieves the user with an "UserId" ID.

Example 2

Get-VcsUser -Name "FirstName FamiliName"

Retrieves the user with an "FirstName FamiliName" name.

Related Commands

VcsUser

This cmdlet retrieves users from the VMware Cloud Services Platform.

This cmdlet removes a user from the VMware Cloud Services Platform.

VcsUserInvitation

This cmdlet retrieves user invitations from the VMware Cloud Services Platform.

This cmdlet creates а new user invitation on the VMware Cloud Services Platform.

This cmdlet revokes a user invitation from the VMware Cloud Services Platform.