Get-CIRole
This cmdlet retrieves roles in the cloud. You can filter the output by using the cmdlet parameters.
Syntax
[-Name
< String[] > ]
[-Org
< Org[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< CIServer[] > ]
[-User
< CIUser[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Name | String[] | named |
|
Specifies the names of the cloud roles you want to retrieve. |
| optional | Org | Org[] | named |
|
Specifies cloud orgs to view their roles. |
| 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. |
| optional | User | CIUser[] | named |
|
Specifies cloud users to view their roles. |
-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 roles 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.CIRoleExamples
Example 1
Get-CIRole
Retrieves all roles that are visible to the current user.
Example 2
Get-CIUser -Name User | Get-CIRole
Get the roles assigned to a cloud user.
Example 3
Get-CIRole -Name Role
Gets a role by name.
Example 4
Get-CIRole -Id roleId
Gets a role by Id.
Related Commands
CIRole
This cmdlet retrieves roles in the cloud.