powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-CIUser



NAME
Get-CIUser

SYNOPSIS
Gets cloud users.

SYNTAX
Get-CIUser [[-Name] ] [-Org ] [-Role ] [-Server ] []

Get-CIUser -Id [-Server ] []


DESCRIPTION
Retrieves cloud users.


PARAMETERS
-Name
Specify the names of the cloud users you want to get.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Org
Specify the organizations to which the users you want to get belong.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Role
Specify the roles of the users you want to get.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Server
Specify the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the comm
and runs on the default servers. For more information about default servers, see the description of Connect-CIS
erver.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Id
Specify the Ids of the cloud users you want to retrieve.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
CIUser


NOTES


Retrieving a user's Org property returns $null if the user is a member of the System organization. To ensure co
mpatibility 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'

-------------- Example 1 --------------

C:\PS>Get-CIUser -Org Org


Gets a list of the users in the specified organization.





-------------- Example 2 --------------

C:\PS>Get-CIUser -Org Organization -Role "Catalog Author"


Gets a list of the organization users that have the "Catalog Author" role.





-------------- Example 3 --------------

C:\PS>Get-CIRole | Get-CIUser


Gets the users with the provided roles.





-------------- Example 4 --------------

C:\PS>Get-CIUser User*


Gets a list of users with names that start with "User".






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-CIUser.html
Get-CIRole