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

Get-VBRViVirtualSwitch

In this article

    Short Description

    Returns VMware virtual switches.

    Applies to

    Platform: VMware

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    Get-VBRViVirtualSwitch -Server <Object[]>  [<CommonParameters>]

    Related Commands

    Get-VBRServer

    Return Type

    VBRViVirtualSwitch

    Detailed Description

    This cmdlet returns VMware virtual switches that are created on a ESX(i) host or cluster.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the ESX or ESXi host or cluster. The cmdlet will return the virtual switches created on this host or cluster.

    True

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    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 example shows how to get switches created on the host named "ESXiHost" .

    1. Run Get-VBRServer to get the host. Save it to the $server variable.
    2. Run Get-VBRViVirtualSwitch using the $server variable.

    PS C:\PS> $server = Get-VBRServer –Type ESXi -Name "ESXiHost"

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

    Example 2

    This example shows how to get switches created on the VMware cluster named "vSAN" .

    1. Run  Find-VBRViEntity to get the cluster. Save it to the $cluster variable.
    2. Run Get-VBRViVirtualSwitch using the $cluster variable.

    PS C:\PS> $cluster = Find-VBRViEntity -Server ESXiHost -HostsAndClusters -Name vSAN

    PS C:\PS> Get-VBRViVirtualSwitch -Server $cluster