PowerCLI Reference

Get-CIUser

Synopsis

This cmdlet retrieves cloud users.

Syntax

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

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

Related Commands

Online version
Get-CIRole

Detailed Description

This cmdlet retrieves cloud users.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the cloud users you want to retrieve.	false	false
Id	String[]	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.	true	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
Org	Org[]	Specifies the organizations to which the users you want to retrieve belong.	false	true (ByValue)
PipelineVariable	String		false	false
Role	CIRole[]	Specifies the roles of the users you want to retrieve.	false	true (ByValue)
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

Return Type

Zero or more CIUser objects

Notes

Retrieving a user's Org property returns $null if the user is a member of the System organization. To ensure compatibility with future versions, all scripts checking if a user is a member of the System organization must use the following syntax: $user.Org -eq $null -or $user.Org.Name -like 'System'

Examples

-------------- 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".