Get-VBRViServerNetworkInfo

In this article

    Short Description

    Returns virtual networks for a VMware host.

    Applies to

    Platform: VMware

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

    Syntax

    Get-VBRViServerNetworkInfo -Server <CHost> [<CommonParameters>]

    Detailed Description

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

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Server

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

    Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    <CommonParameters>

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

    Return Type

    The cmdlet returns the following objects:

    VBRViNetworkInfo[]

    VBRViDVSNetworkInfo[]

    Examples

    Get-VBRViServerNetworkInfoExample 1. Getting Networks Connected to Specific VMware Host

    This example shows how to get the networks to which the srv01.veeam.local host is connected.

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

    Get-VBRViServerNetworkInfo -Server $server

    Perform the following steps:

    1. Run the Get-VBRServer cmdlet. Specify the Type and Name parameter values. Save the result to the $server variable.
    2. Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value.

    Get-VBRViServerNetworkInfoExample 2. Getting Networks Connected to Specific VMware Host Using Host Name

    This command shows how to look get the networks to which the srv01.veeam.local host is connected.

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

    Get-VBRViServerNetworkInfoExample 3. Getting Specific Network Connected to Specific VMware Host

    This example shows how to get one network from the list of networks that are connected to the srv01.veeam.local host.

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

    $targetnetwork = $networks[5]

    Perform the following steps:

    1. Run the Get-VBRViServerNetworkInfo cmdlet. Specify the Server parameter value. Save the result to the $networks variable.
    2. The Get-VBRViServerNetworkInfo cmdlet will return an array of networks. Specify the necessary network of the $networks variable using the square brackets. Save the result to the $targetnetwork variable.

    Get-VBRViServerNetworkInfoExample 4. Getting Specific Network Connected to Specific VMware Host [Using Pipeline]

    This example shows how to get the NW01 network that is connected to the srv01.veeam.local host.

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

    Perform the following steps:

    1. Run the Get-VBRViServerNetworkInfo cmdlet. Specify the Server parameter value.
    2. Pipe the cmdlet output to the Where-Object cmdlet. Specify the following settings:
    • Provide the $_. automatic variable.
    • Provide the NetworkName property.
    • Specify the eq comparison operator value.

     

    Related Commands