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

Get-VBRCloudTenantNetworkAppliance

Short Description

Returns network extension appliances.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a VCP license.

Syntax

This cmdlet provides the following parameter sets:

For looking for all tenant network appliances or for network 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>]

Detailed Description

This cmdlet returns network extension appliances. You can get the network extension appliance for the cloud tenants of the following types:

Simple cloud tenant accounts
vCD Cloud tenant accounts

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. Accepts the VBRCloudTenant type.	False	Named	True (ByValue, ByProperty Name)	False
Server	Specifies the array of hosts. The cmdlet will return appliances that use these hosts.	False	Named	False	False

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

Return Type

VBRCloudTenantNetworkAppliance[]

Example 1

This command returns all tenant network appliances.

Get-VBRCloudTenantNetworkAppliance

Example 2

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

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

$tenant = Get-VBRCloudTenant -Name "ABC Company"

Get-VBRCloudTenantNetworkAppliance -Tenant $tenant

Example 3

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

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

$server = Get-VBRServer –Name "srv01.veeam.local"

Get-VBRCloudTenantNetworkAppliance -Server $server

Related Commands

Get-VBRServer