PowerCLI Reference

Get-CIRole

Synopsis

This cmdlet retrieves roles in the cloud.

Syntax

Get-CIRole [[-Name] <String[]>] [-User <CIUser[]>] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-CIRole -Id <String[]> [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Related Commands

Online version
Get-CIUser

Detailed Description

This cmdlet retrieves roles in the cloud. You can filter the output by using the cmdlet parameters.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the cloud roles you want to retrieve.	false	false
Id	String[]	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.	true	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
PipelineVariable	String		false	false
Server	CIServer[]	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.	false	false
User	CIUser[]	Specifies cloud users to view their roles.	false	true (ByValue)

Return Type

Zero or more CIRole objects

Notes

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.