Get-CIUser

This cmdlet retrieves cloud users.

Syntax

[-Name  <String[]>]
[-Org  <Org[]>]
[-Role  <CIRole[]>]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named
  • wildcards
  • Specifies the names of the cloud users you want to retrieve.
    optional
    Org
    Org[] named
  • wildcards
  • pipeline
  • Specifies the organizations to which the users you want to retrieve belong.
    optional
    Role
    CIRole[] named
  • wildcards
  • pipeline
  • Specifies the roles of the users you want to retrieve.
    optional
    Server
    CIServer[] named
  • wildcards
  • 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.

    -Id  <String[]>
    [-Server  <CIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Specifies the IDs of the cloud users you want to retrieve.
    optional
    Server
    CIServer[] named
  • wildcards
  • 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.CIUser

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

    Related Commands

    Feedback

    Was this page helpful?