Get-CIUser
This cmdlet retrieves cloud users.
Syntax
[-Name
< String[] > ]
[-Org
< Org[] > ]
[-ProgressAction
< ActionPreference > ]
[-Role
< CIRole[] > ]
[-Server
< CIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Name | String[] | named |
|
Specifies the names of the cloud users you want to retrieve. |
| optional | Org | Org[] | named |
|
Specifies the organizations to which the users you want to retrieve belong. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Role | CIRole[] | named |
|
Specifies the roles of the users you want to retrieve. |
| optional | Server | CIServer[] | named |
|
Specifies the cloud 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 Connect-CIServer. |
-Id
< String[] >
[-ProgressAction
< ActionPreference > ]
[-Server
< CIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Specifies the IDs of the cloud users you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | CIServer[] | named |
|
Specifies the cloud 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 Connect-CIServer. |
Output
VMware.VimAutomation.Cloud.Types.V1.CIUserExamples
Example 1
Get-CIUser -Org Org
Gets a list of the users in the specified organization.
Example 2
Get-CIUser -Org Organization -Role "Catalog Author"
Gets a list of the organization users that have the "Catalog Author" role.
Example 3
Get-CIRole | Get-CIUser
Gets the users with the provided roles.
Example 4
Get-CIUser User*
Gets a list of users with names that start with "User".
Related Commands
CIUser
This cmdlet retrieves cloud users.