Windows PowerShell command on Get-command Disable-NetAdapterSriov

NAME

Disable-NetAdapterSriov

SYNOPSIS

Disables SR-IOV on a network adapter.

SYNTAX

Disable-NetAdapterSriov [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart]

[-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Disable-NetAdapterSriov [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ]

-InputObject [-Confirm] [-WhatIf] []

Disable-NetAdapterSriov [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru]

[-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] []

DESCRIPTION

The Disable-NetAdapterSriov cmdlet disables Single-Root I/O Virtualization (SR-IOV) on a network adapter. SR-IOV

enables network traffic to bypass the software switch layer of the Hyper-V virtualization stack. As a result, the

I/O overhead in the software emulation layer is reduced and can achieve network performance that is nearly the

same performance as in non-virtualized environments.

This cmdlet prevents the adapter from using SR-IOV until enabled again. While SR-IOV is disabled, Windows Serverr

2012 and later does not attempt to allocate a virtual function to a virtual machine . If virtual functions from this network adapter are allocated to any virtual machine, then the virtual functions are revoked and each virtual machine interface reverted to the synthetic network path.

PARAMETERS

-AsJob []

ps_cimcommon_asjob Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-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. Required? false Position? named Default value 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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. Required? true Position? named Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false

-InterfaceDescription

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". Required? true Position? named Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true

-Name

Specifies an array of network adapter names. Required? true Position? 1 Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true

-NoRestart []

Indicates that the cmdlet does not restart the network adapter after completing the operation. Many advanced properties require restarting the network adapter before the new settings take effect. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-PassThru []

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-ThrottleLimit

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 PowerShellr 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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData[] 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.

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData 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.

The output object contains the network adapter object with SR-IOV disabled.

Example 1: Disable SR-IOV on the specified network adapter

PS C:\> Disable-NetAdapterSriov -Name "Ethernet 1"

This command disables SR-IOV on the network adapter named Ethernet 1 and restarts the network adapter.

Example 2: Disable SR-IOV on the specified network adapter

PS C:\>$NetAdapter2 = Get-NetAdapter -Name "Ethernet 2"

Disable-NetAdapterSriov -InputObject $NetAdapter2

A version of the cmdlet that uses the pipeline to select the network adapter named Ethernet 2 and pipes that object into this cmdlet.

PS C:\> Get-NetAdapter -Name "Ethernet 2" | Disable-NetAdapterSriov

The first command gets the network adapter named Ethernet 2 and stores the result in the variable named

$NetAdapter2.

The second command disables the SR-IOV adapter stored in the $NetAdapter variable.

Example 3: Disable SR-IOV on the specified network and do not restart it

PS C:\> Disable-NetAdapterSriov -Name "Ethernet 3" -NoRestart

This command disables SR-IOV on the network adapter named Ethernet 3 without restarting the network adapter.