PowerCLI Reference

Get-VirtualPortGroup

Synopsis

This cmdlet retrieves the available port groups of hosts, virtual machines, and virtual switches.

Syntax

Get-VirtualPortGroup [[-VMHost] <VMHost[]>] [-Datacenter <Datacenter[]>] [-Distributed] [-Name <String[]>] [-Server <VIServer[]>] [-Standard] [-Tag <Tag[]>] [-VirtualSwitch <VirtualSwitchBase[]>] [-VM <VirtualMachine[]>] [<CommonParameters>]

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

Get-VirtualPortGroup -RelatedObject <VirtualPortGroupRelatedObjectBase[]> [<CommonParameters>]

Related Commands

Online Version
New-VirtualPortGroup
Remove-VirtualPortGroup
Set-VirtualPortGroup

Detailed Description

This cmdlet retrieves the available port groups of hosts, virtual machines, and virtual switches. To specify a server different from the default one, use the Server parameter.

Parameters

Name	Type	Description	Required?	Pipeline Input
VMHost	VMHost[]	Specifies the hosts whose port groups 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.	false	True (ByValue)
Datacenter	Datacenter[]	Filters the port groups of the virtual switches connected to hosts in the specified datacenters.	false	True (ByValue)
Distributed	SwitchParameter	Indicates that you want to retrieve the port groups for DistributedSwitch objects. This parameter is obsolete. To retrieve distributed port groups, use the Get-VDPortgroup cmdlet instead.	false	False
Id	String[]	Specifies the IDs of the port groups 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.	true	False
Name	String[]	Specifies the names of the port groups you want to retrieve.	false	False
RelatedObject	VirtualPortGroupRelatedObjectBase[]	Specifies objects to retrieve one or more VirtualPortGroup objects that are related to them. This parameter accepts vCloud NetworkPool, vCloud ExternalNetwork, and vCloud OrgNetwork objects. Note: In vCloud Director 5.1 environments, you cannot retrieve a distributed port group from an organization network backed by the distributed port group.	true	True (ByValue)
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.	false	False
Standard	SwitchParameter	Indicates that you want to retrieve the port groups for VirtualSwitch objects.	false	False
Tag	Tag[]	Returns only the virtual port groups that are associated with any of the specified tags. Note: This parameter is compatible only with standard virtual port groups. For distributed port groups, you should use the Get-VDPortgroup cmdlet.	false	False
VirtualSwitch	VirtualSwitchBase[]	Specifies the virtual switches for which you want to retrieve their port groups.	false	True (ByValue)
VM	VirtualMachine[]	Specifies the virtual machines whose port groups you want to retrieve.	false	True (ByValue)

Return Type

Zero or more VirtualPortGroup or DistributedPortGroup objects

Notes

This cmdlet retrieves standard port groups. Retrieving distributed port groups with this cmdlet is obsolete. Use the Get-VDPortgroup cmdlet instead.

Examples

-------------------------- Example 1 --------------------------

Get-VirtualPortgroup -Name "VM Network"

Retrieves all port groups named "VM Network".

-------------------------- Example 2 --------------------------

$myVMHost = Get-VMHost -Name "MyVMHost"
Get-VirtualPortGroup -Name "VM Network" -VMHost $myVmHost

Retrieves the port group named "VM Network" on the specified host.

-------------------------- Example 3 --------------------------

$myVM = Get-VM -Name "MyVM"
Get-VirtualPortGroup -VM $myVM

Retrieves all port groups to which the specified virtual machine is connected.

-------------------------- Example 4 --------------------------

$virtualSwitch = Get-VirtualSwitch -VMHost MyVMHost -Name vSwitch0
Get-VirtualPortGroup -VirtualSwitch $virtualSwitch

Retrieves all port groups which belong to the specified virtual switch.