Get-VirtualPortGroup Command | Vmware PowerCLI Reference

Get-VirtualPortGroup

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
  • wildcards
 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.
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.
Get-VirtualPortGroup
[-Datacenter < Datacenter[] > ]
[-Distributed ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[-Standard ]
[-Tag < Tag[] > ]
[-VM < VirtualMachine[] > ]
[-VMHost < VMHost[] > ]
[-VirtualSwitch < VirtualSwitchBase[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Datacenter Datacenter[] named
  • pipeline
  • wildcards
 Filters the port groups of the virtual switches connected to hosts in the specified datacenters.
optional Distributed SwitchParameter named
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.
optional Name String[] named
  • wildcards
 Specifies the names of the port groups 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.
optional Standard SwitchParameter named
Indicates that you want to retrieve the port groups for VirtualSwitch objects.
optional Tag Tag[] named
  • wildcards
 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.
optional VM VirtualMachine[] named
  • pipeline
  • wildcards
 Specifies the virtual machines whose port groups you want to retrieve.
optional VMHost VMHost[] named
  • pipeline
  • wildcards
 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.
optional VirtualSwitch VirtualSwitchBase[] named
  • pipeline
  • wildcards
 Specifies the virtual switches for which you want to retrieve their port groups.
Get-VirtualPortGroup
-RelatedObject < VirtualPortGroupRelatedObjectBase[] >
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 RelatedObject VirtualPortGroupRelatedObjectBase[] named
  • pipeline
 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.

Output

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

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.

Related Commands

VirtualPortGroup

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

This cmdlet creates a new port group on the specified host.

This cmdlet removes the specified virtual port groups.

This cmdlet modifies the properties of the specified virtual port group.