Get-NetAdapterIPsecOffload

Get-NetAdapterIPsecOffload

Gets the IPsec offload properties of the network adapter.

Syntax

Parameter Set: ByName
Get-NetAdapterIPsecOffload [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceID
Get-NetAdapterIPsecOffload -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NetAdapterIPsecOffload cmdlet gets the IPsec offload properties of an IPsec offload capable network adapter. When IPsec Offload is enabled the network adapter performs the per packet encryption operations which reduces processor utilization.

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

-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

-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_NetAdapter IPsecOffloadV2SettingData

    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 the IPsec offload properties for the specified network adapter

This command gets the IPsec offload properties of the network adapter named MyAdapter.


PS C:\> Get-NetAdapterIPsecOffload -Name "MyAdapter"

Example 2: Display all IPsec offload properties for the specified network adapter

This command displays all IPsec offload properties of the network adapter named MyAdapter.


PS C:\> Get-NetAdapterIPsecOffload –Name "MyAdapter" | Format-List -Property "*"

Example 3: Get all IPsec offload capable network adapters that have it enabled

This command gets all IPsec offload capable network adapters with IPsec offload enabled.


PS C:\> Get-NetAdapterIPsecOffload –Name "*" | Where-Object -FilterScript { $_.Enabled }

Related topics

Community Additions

ADD
Show: