Get-VirtualSwitch

This cmdlet retrieves the virtual switches associated with a virtual machine host or used by a virtual machine. At least one of the VMHost and VM parameters must be provided. The VM, VMHost, Name parameters do not accept string values through a pipeline because of collision. To specify a server different from the default one, use the Server parameter.

Syntax

[[-VM]  <VirtualMachine[]>]
[-Datacenter  <Datacenter[]>]
[-Distributed]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[-Standard]
[-VMHost  <VMHost[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
VM
VirtualMachine[] 1
  • wildcards
  • pipeline
  • Specifies the virtual machines whose virtual switches you want to retrieve.
    optional
    Datacenter
    Datacenter[] named
  • wildcards
  • pipeline
  • Filters the virtual switches connected to hosts in the specified datacenters.
    optional
    Distributed
    SwitchParameter named Indicates that you want to retrieve only DistributedSwitch objects. This parameter is obsolete. To retrieve distributed switches, use the Get-VDSwitch cmdlet instead.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the virtual switches you want to retrieve. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release. The position of this parameter is deprecated and will be changed in a future release. To avoid errors when you run existing scripts on future PowerCLI versions, specify the parameter by name.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    Standard
    SwitchParameter named Indicates that you want to retrieve only VirtualSwitch objects.
    optional
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts whose virtual switches you want to retrieve. The position of this parameter is deprecated and will be changed in a future release. To avoid errors when you run existing scripts on future PowerCLI versions, specify the parameter by name.

    -Id  <String[]>
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the virtual switches you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

    -RelatedObject  <VirtualSwitchRelatedObjectBase[]>
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    RelatedObject
    VirtualSwitchRelatedObjectBase[] named
  • pipeline
  • Specifies objects to retrieve one or more VirtualSwitch objects that are related to them. This parameter accepts vCloud NetworkPool objects.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.Networking.VirtualSwitchBase

    Examples


    Example 1

    Get-VirtualSwitch -VM VM

    Retrieves the virtual switch used by the virtual machine named VM.

    Example 2

    Get-Datacenter -Name "MyDatacenter" | Get-VirtualSwitch

    Retrieves all virtual switches in the specified datacenter.

    Example 3

    Get-VMHost -Name "MyVMHost" | Get-VirtualSwitch

    Retrieves all virtual switches on the specified host.

    Example 4

    Get-VirtualSwitch -Name "vSwitch0"

    Retrieves all virtual switches named "vSwitch0".

    Related Commands

    Feedback

    Was this page helpful?