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]
[-Datacenter <Datacenter[]>]
[-Distributed]
[-Name <String[]>]
[-Server <VIServer[]>]
[-Standard]
[-VMHost <VMHost[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
VirtualMachine[] | 1 |
|
Specifies the virtual machines whose virtual switches you want to retrieve. | optional |
|
Datacenter[] | named |
|
Filters the virtual switches connected to hosts in the specified datacenters. | optional |
|
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 |
|
String[] | named |
|
Specifies the names of the virtual switches you want to retrieve. Passing values to this parameter through a pipeline is deprecated and will be deactivated 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 |
|
VIServer[] | named |
|
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 |
|
SwitchParameter | named |
|
Indicates that you want to retrieve only VirtualSwitch objects. | optional |
|
VMHost[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Specifies the IDs of the virtual switches you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
VIServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VirtualSwitchRelatedObjectBase[] | named |
|
Specifies objects to retrieve one or more VirtualSwitch objects that are related to them. This parameter accepts vCloud NetworkPool objects. Note: In vCloud Director 5.1 environments, you cannot retrieve a distributed switch from a network pool backed by the distributed switch. |
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
VirtualSwitch
This cmdlet retrieves the virtual switches associated with a virtual machine host or used by a virtual machine.
This cmdlet modifies the properties of the specified virtual switch.
This cmdlet removes the specified virtual switches from their locations.
This cmdlet creates a new virtual switch.
VirtualSwitchPhysicalNetworkAdapter
This cmdlet adds a host physical NIC to a standard virtual switch.
This cmdlet removes the specified host physical NICs from the standard virtual switch.
