Get-VMSwitchExtensionPortData
Get-VMSwitchExtensionPortData
Retrieves the status of a virtual switch extension feature applied to a virtual network adapter.
Syntax
Parameter Set: VMName
Get-VMSwitchExtensionPortData [-VMName] <String[]> [-ComputerName <String[]> ] [-Extension <VMSwitchExtension[]> ] [-ExtensionName <String[]> ] [-FeatureId <Guid[]> ] [-FeatureName <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [ <CommonParameters>]
Parameter Set: ExternalPort
Get-VMSwitchExtensionPortData [-SwitchName] <String> -ExternalPort [-ComputerName <String[]> ] [-Extension <VMSwitchExtension[]> ] [-ExtensionName <String[]> ] [-FeatureId <Guid[]> ] [-FeatureName <String[]> ] [-Passthru] [ <CommonParameters>]
Parameter Set: ManagementOS
Get-VMSwitchExtensionPortData -ManagementOS [-ComputerName <String[]> ] [-Extension <VMSwitchExtension[]> ] [-ExtensionName <String[]> ] [-FeatureId <Guid[]> ] [-FeatureName <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [ <CommonParameters>]
Parameter Set: ResourceObject
Get-VMSwitchExtensionPortData [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Extension <VMSwitchExtension[]> ] [-ExtensionName <String[]> ] [-FeatureId <Guid[]> ] [-FeatureName <String[]> ] [-Passthru] [ <CommonParameters>]
Parameter Set: VMObject
Get-VMSwitchExtensionPortData [-VM] <VirtualMachine[]> [-Extension <VMSwitchExtension[]> ] [-ExtensionName <String[]> ] [-FeatureId <Guid[]> ] [-FeatureName <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [ <CommonParameters>]
Detailed Description
The Get-VMSwitchExtensionPortData cmdlet retrieves the status of a virtual switch extension feature applied to a virtual network adapter. This port feature data surfaces runtime information and statistics on a per-port basis.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which the status of a virtual switch extension applied to a virtual network adapter is 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Extension<VMSwitchExtension[]>
Specifies the virtual switch extension for which status is to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExtensionName<String[]>
Specifies the name of the virtual switch extension for which status is to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExternalPort
Specifies the virtual switch port connected to the external network interface card.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FeatureId<Guid[]>
Specifies the unique identifier of the feature supported by the virtual switch extension.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FeatureName<String[]>
Specifies the name of the feature supported by the virtual switch extension.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementOS
Specifies that the status is to be retrieved from the management (i.e. parent, or host) operating system.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the status to be retrieved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SwitchName<String>
Specifies the name of the virtual switch.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies the name of the virtual machine.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapter<VMNetworkAdapterBase[]>
Specifies the virtual machine network adapter.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapterName<String>
Specifies the name of the virtual machine network adapter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
Gets the port feature data with ID eb29f0f2-f5dc-45c6-81bb-3cd9f219bbbb from the sample forwarding extension on the virtual network adapter in virtual machine VM1.
PS C:\> Get-VMSwitchExtensionPortData VM1 -FeatureId eb29f0f2-f5dc-45c6-81bb-3cd9f219bbbb