Get-VBRCloudSubUser

In this article

    Short Description

    Returns cloud subuser accounts.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides the following parameter sets:

    • To look for all cloud subusers

    Get-VBRCloudSubUser [-Mode <VBRCloudSubUserMode> {Common | AgentManagement}]  [<CommonParameters>]

    • To look for cloud subusers by the subuser ID

    Get-VBRCloudSubUser [-Id <guid[]>] [-Mode <VBRCloudSubUserMode> {Common | AgentManagement}]  [<CommonParameters>]

    • To look for cloud subusers by the subuser name

    Get-VBRCloudSubUser [-Name <string[]>] [-Mode <VBRCloudSubUserMode> {Common | AgentManagement}][<CommonParameters>]

    • To look for cloud subusers by a cloud service provider

    Get-VBRCloudSubUser [-CloudProvider <VBRCloudProvider[]>] [-Mode <VBRCloudSubUserMode> {Common | AgentManagement}] [<CommonParameters>]>]

    Detailed Description

    This cmdlet returns cloud subuser accounts of the following types:

    • Simple cloud subtenant accounts
    • vCD cloud subtenant accounts

    You can get the list of all existing subuser accounts, or narrow down the search results to name, ID or cloud provider. Use an appropriate parameter set for each case.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

    Specifies an array of subuser ID. The cmdlet will return subusers with these IDs.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies an array of names for subuser accounts. The cmdlet will return subusers with names.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    True

    Mode

    Specifies the cloud subtenant mode. You can select either of the following modes:

    • Common
    • AgentManagement

    The cmdlet will return subusers of the specified mode.

    False

    Named

    False

    False

    CloudProvider

    Specifies a cloud provider. The cmdlet will return subusers associated with this cloud provider.

    Accepts the VBRCloudProvider type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

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

    Return Type

    IVBRCloudSubUser

    Example 1

    This command returns all cloud subusers.

    Get-VBRCloudSubUser

    Example 2

    This command looks for a subuser by the subuser name.

    Get-VBRCloudSubUser -Name "Subuser 1"

    Example 3

    This example shows how to get a subuser by a cloud service provider.

    1. Run Get-VBRCloudProvider to get a cloud service provider. Save the result to the $cloudprovider variable.
    2. Run Get-VBRSubUser. Use the $cloudprovider variable.

    $cloudProvider = Get-VBRCloudProvider

    Get-VBRCloudSubUser -CloudProvider $cloudprovider

    Related Commands

    Get-VBRCloudProvider