Get-NetAdapterSriovVf

Get-NetAdapterSriovVf

Displays the SR-IOV virtual function settings for a network adapter.

Syntax

Parameter Set: ByName
Get-NetAdapterSriovVf [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-FunctionID <UInt16[]> ] [-IncludeHidden] [-SwitchID <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceID
Get-NetAdapterSriovVf -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-FunctionID <UInt16[]> ] [-IncludeHidden] [-SwitchID <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NetAdapterSriovVf cmdlet displays the Single-Root I/O Virtualization (SR-IOV) virtual function settings for a network adapter. By default a table of virtual function settings will be displayed that includes the virtual function identifier (ID), virtual function name, network adapter ID, and the current MAC address. Specifying a single virtual function displays that virtual function in more detail. Additional displayed fields include the permanent MAC address, requester ID, and virtual port (VPort) information.

The network adapter to use is specified by either the name of the network adapter, interface description of the network adapter, or the switch ID of the virtual switch bound to the SR-IOV network adapter.

Parameters

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FunctionID<UInt16[]>

Specifies the virtual function ID number on the indicated network adapter to return more detailed information on the virtual function.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeHidden

Indicates that the cmdlet includes both visible and hidden network adapters in the operation. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceDescription<String[]>

Specifies an array of network adapter interface descriptions. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.


Aliases

ifDesc

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-Name<String[]>

Specifies an array of network adapter names.


Aliases

ifAlias, InterfaceAlias

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-SwitchID<UInt32[]>

Specifies the virtual switch ID that identifies the network adapter for one or more virtual functions as an array.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovVfSettingData

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.


Examples

Example 1: Get a list of virtual functions, virtual machines, and MAC addresses for the specified network adapter

This command gets a list of the virtual functions with the virtual machine names and MAC addresses for the network adapter named Ethernet 1.


PS C:\> Get-NetAdapterSriovVf -Name "Ethernet 1"

Example 2: Get a list of virtual functions, virtual machines, and MAC addresses for a network adapter bound to a virtual switch

This command gets a list of the virtual functions with the virtual machine names and MAC addresses for the network adapter bound to virtual switch 2.


PS C:\> Get-NetAdapterSriovVf -SwitchId 2

Related topics

Community Additions

ADD
Show: