Get-CIRole
This cmdlet retrieves roles in the cloud. You can filter the output by using the cmdlet parameters.
Syntax
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
String[] | named |
|
Specifies the names of the cloud roles you want to retrieve. | optional |
|
Org[] | named |
|
Specifies cloud orgs to view their roles. | optional |
|
CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. | optional |
|
CIUser[] | named |
|
Specifies cloud users to view their roles. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
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 |
|
CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is given 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.CIRole
Examples
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.