Get-VMSwitch
Get-VMSwitch
Gets virtual switches from one or more virtual Hyper-V hosts.
Syntax
Parameter Set: Name
Get-VMSwitch [[-Name] <String> ] [[-ResourcePoolName] <String[]> ] [-ComputerName <String[]> ] [-SwitchType <VMSwitchType[]> ] [ <CommonParameters>]
Parameter Set: Id
Get-VMSwitch [[-Id] <Guid[]> ] [[-ResourcePoolName] <String[]> ] [-ComputerName <String[]> ] [-SwitchType <VMSwitchType[]> ] [ <CommonParameters>]
Detailed Description
The Get-VMSwitch gets the virtual switches from a Hyper-V host. If you specify no parameters, this cmdlet returns all virtual switches from the local Hyper-V host.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts from which virtual switches are to be retrieved. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Id<Guid[]>
Specifies the unique identifier of the virtual switch to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the virtual switch to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-ResourcePoolName<String[]>
Specifies the resource pool from which the virtual switches are to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-SwitchType<VMSwitchType[]>
Specifies the type of the virtual switches to be retrieved. Allowed values are External, Internal, and Private.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Virtualization.Powershell.EthernetSwitch
Examples
Example 1
Gets all virtual switches from the local Hyper-V host.
PS C:\> Get-VMSwitch
Example 2
Gets all virtual switches that connect to the external network.
PS C:\> Get-VMSwitch –SwitchType External