Syntax
Get-VDPort [[-Key] <String[]>] [-ActiveOnly] [-ConnectedOnly] [-Server <VIServer[]>] [-Uplink] [-VDPortgroup <VDPortgroup[]>] [-VDSwitch <VDSwitch[]>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet retrieves virtual distributed ports. At least one of the VDSwitch or VDPortgroup parameters must be specified.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Key | String[] | Specifies the key of the port which you want to retrieve. | false | False | |
| ActiveOnly | SwitchParameter | If set, only the active ports are returned. | false | False | |
| ConnectedOnly | SwitchParameter | If set, only the connected ports are returned. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | False | |
| Uplink | SwitchParameter | If set, only uplink ports are returned. If not set, both uplink and non-uplink ports are returned. This parameter, like every SwitchParameter, can also be set to false (-Uplink:$false), in which case only non-uplink ports are returned. | false | False | |
| VDPortgroup | VDPortgroup[] | Specifies the distributed virtual port group whose ports you want to retrieve. | false | True (ByValue) | |
| VDSwitch | VDSwitch[] | Specifies the vSphere distributed switch whose ports you want to retrieve. | false | True (ByValue) |
Return Type
Zero or more VDPort objectsNotes
Requires vSphere API 4.0 or later.Examples
-------------------------- Example 1 --------------------------
Get-VDPortGroup "MyVDPortgroup" | Get-VDPort -Key "MyPortgroupKey"
Retrieves a virtual distributed port assigned with a key named "MyPortgroupKey" from a virtual distributed port group named "MyVDPortgroup".
-------------------------- Example 2 --------------------------
Get-VDSwitch "MyVDSwitch" | Get-VDPort -Uplink
Retrieves all uplink virtual distributed ports of a vSphere distributed switch named "MyVDSwitch".
-------------------------- Example 3 --------------------------
Get-VDSwitch "MyVDSwitch" | Get-VDPort -ConnectedOnly
Retrieves all connected virtual distributed ports of a vSphere distributed switch named "MyVDSwitch".