Get-VBRvCDCloudOrganizationUser

In this article

    Short Description

    Returns vCD cloud user accounts.

    Applies to

    Platform: VMware

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Get-VBRvCDCloudOrganizationUser [-Name <string[]>] [-vCDCloudProvider <VBRCloudProvider[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns the VBRvCDCloudOrganizationUser object that contains the details about vCD user accounts added to your Organization. You can use this object to create new subtenants.

    Get-VBRvCDCloudOrganizationUser Note:

    Mind the following:

    • You must add the vCD users to the vCD Organization in VMware vCloud Director beforehand. The user must not have the administrator role.
    • This cmdlet works for tenants only.
    • Run Find-VBRvCloudEntity with the OrganizationUser parameter to get the array of the vCD users from the Cloud Provider side.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies an array of names for the vCD user account that you want to get.

    False

    Named

    True (ByValue,
    ByPropertyName)

     

    vCDCloudProvider

    Specifies the service provider added to Veeam Backup & Replication.

    False

    Named

    True (ByValue,
    ByPropertyName)

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    Example 1

    This example shows how to get all vCD user accounts added to your vCD Organization.

    Get-VBRvCDCloudOrganizationUser

    Example 2

    This example shows how to get a vCD user by name.

    Get-VBRvCDCloudOrganizationUser -Name "vCDUser1"

    Example 3

    This example shows how to get a vCD user by vCD service provider.

    1. Run Get-VBRCloudProvider to get the service provider. Save the result to the $provider variable.
    2. Run Get-VBRvCDCloudOrganizationUser with the $provider variable.

    $provider = Get-VBRCloudProvider -Name "vCDProvider"

    Get-VBRvCDCloudOrganizationUser -vCDCloudProvider $provider -Name "vCDuser"

    Related Commands

    Get-VBRCloudProvider