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

Get-VBRViServerNetworkInfo

Short Description

Returns virtual networks for a VMware host.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBRViServerNetworkInfo -Server <CHost> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns the list of all virtual networks to which a selected VMware host is connected.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Server

Specifies the VMware host. The cmdlet will return virtual networks connected to this host.

Accepts server object or string (host name) type.

True

Named

True (ByValue,
ByProperty
Name)

True

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

Return Type

VBRViNetworkInfo[]

VBRViDVSNetworkInfo[]

Example 1

This command shows how to look for the networks to which the 'srv01.veeam.local' host is connected using a variable.

Run Get-VBRServer to get the host and save it to the $server variable.
Run Get-VBRViServerNetworkInfo with the $server variable.

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

Get-VBRViServerNetworkInfo -Server $server

Example 2

This command shows how to look for the networks to which the 'srv01.veeam.local' host is connected using the server name.

Get-VBRViServerNetworkInfo -Server "srv01.veeam.local"

Example 3

This example shows how to select one network from the list of network that is connected to the 'srv01.veeam.local' host.

Run Get-VBRViServerNetworkInfo to get the list of all networks connected to the host. Save the result to the '$networks' variable.
Address the index number of the corresponding network in the list. Save the result to the '$targetnetwork' variable.

$networks = Get-VBRViServerNetworkInfo -Server "srv01.veeam.local"

$targetnetwork = $networks[5]

Example 4

This example shows how to get a network named "VM Network" connected to the 'srv01.veeam.local' host.

Run Get-VBRViServerNetworkInfo to get the list of all networks connected to the host. Pass the result to the Where-Object cmdlet to select the networks with the NetworkName property that equals "VM Network".

Get-VBRViServerNetworkInfo -Server "srv01.veeam.local" | Where-Object { $_.NetworkName -eq "VM Network" }

Example 5

This example shows how to get a network named "DPortGroup" located on a distributed virtual switch named "DSwitch" from the list of networks connected to the 'srv01.veeam.local' host.

Run Get-VBRViServerNetworkInfo to get the list of all networks connected to the host.

Use the Where-Object statement to filter the networks by the following properties:

Type = "ViDVS"
SwitchName = "DSwitch"
NetworkName = "DPortGroup"

Get-VBRViServerNetworkInfo -Server "srv01.veeam.local" | Where { $_.Type -eq "ViDVS" -and $_.SwitchName -eq "DSwitch" -and $_.NetworkName -eq "DPortGroup" }

Related Commands

Get-VBRServer