This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRCloudTenantNetworkAppliance

In this article

    Short Description

    Returns network extension appliances.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Requires a VCP license.

    Syntax

    This cmdlet provides three parameter sets.

    • For looking for all tenant network appliances or for netwokk appliances by name:

    Get-VBRCloudTenantNetworkAppliance [-Name <string[]>] [<CommonParameters>]

    • For looking for network appliances by name or by tenant:

    Get-VBRCloudTenantNetworkAppliance [-Name <string[]>] [-Tenant <VBRCloudTenant[]>] [<CommonParameters>]

    • For looking for network appliances by name or by hosts:

    Get-VBRCloudTenantNetworkAppliance [-Name <string[]>] [-Server <Object[]>] [<CommonParameters>]

    Related Commands

    Get-VBRServer

    Return Type

    VBRCloudTenantNetworkAppliance[]

    Detailed Description

    This cmdlet returns network extension appliances.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the array of names of the appliance. The cmdlet will return appliances with these names.

    False

    Named

    False

    True

    Tenant

    Specifies the array of tenants. The cmdlet will return appliances assigned to these tenants.

    False

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    False

    Server

    Specifies the array of hosts. The cmdlet will return appliances that uses these hosts.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example 1

    This command returns all tenant network appliances.

    PS C:\PS> Get-VBRCloudTenantNetworkAppliance

    Example 2

    This example shows how to return network appliances of a selected tenant.

    1. Run Get-VBRCloudTenant to get the tenant. Save it to the $tenant variable.
    2. Run Get-VBRCloudTenantNetworkAppliance using the $tenant variable.

    PS C:\PS> Get-VBRCloudTenant -Name "ABC Company"

    PS C:\PS> Get-VBRCloudTenantNetworkAppliance -Tenant $tenant

    Example 3

    This example shows how to return network appliances deployed on a selected host.

    1. Run Get-VBRServer to obtain the host. Save the host to the $server variable.
    2. Run Get-VBRCloudTenantNetworkAppliance. Use the $server variable.

    PS C:\PS> $server = Get-VBRServer –Name "srv01.veeam.local"

    PS C:\PS> Get-VBRCloudTenantNetworkAppliance -Server $server