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

[-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
  • wildcards
  • pipeline
  • 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.
    optional
    VM
    VirtualMachine[] named
  • wildcards
  • pipeline
  • Specifies the virtual machines whose port groups you want to retrieve.
    optional
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • 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
  • wildcards
  • pipeline
  • Specifies the virtual switches for which you want to retrieve their port groups.

    -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.
    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.

    -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.

    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

    Feedback

    Was this page helpful?