Get-VMSwitch

Reference

Module:: Hyper-V

Gets virtual switches from one or more virtual Hyper-V hosts.

Syntax

Get-VMSwitch
   [[-Name] <String>]
   [[-ResourcePoolName] <String[]>]
   [-SwitchType <VMSwitchType[]>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]

Get-VMSwitch
   [[-Id] <Guid[]>]
   [[-ResourcePoolName] <String[]>]
   [-SwitchType <VMSwitchType[]>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]

Description

The Get-VMSwitch cmdlet 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.

Examples

Example 1

PS C:\> Get-VMSwitch

Gets all virtual switches from the local Hyper-V host.

Example 2

PS C:\> Get-VMSwitch -SwitchType External

Gets all virtual switches that connect to the external network.

Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:	CimSession[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:	PSCredential[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the unique identifier of the virtual switch to be retrieved.

Type:	Guid[]
Aliases:	SwitchId
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of the virtual switch to be retrieved.

Type:	String
Aliases:	SwitchName
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourcePoolName

Specifies the resource pool from which the virtual switches are to be retrieved.

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SwitchType

Specifies the type of the virtual switches to be retrieved. Allowed values are External, Internal, and Private.

Type:	VMSwitchType[]
Accepted values:	Private, Internal, External
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

Microsoft.HyperV.PowerShell.VMSwitch

Compartilhar via