< Back
Get-NetAdapterIPsecOffload
Post
NAME Get-NetAdapterIPsecOffload
SYNOPSIS
Gets the IPsec offload properties of the network adapter.
SYNTAX
Get-NetAdapterIPsecOffload [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>]
[<CommonParameters>]
Get-NetAdapterIPsecOffload [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] -InterfaceDescription <String[]>
[<CommonParameters>]
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 [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
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
-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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Get the IPsec offload properties for the specified network adapter
PS C:\\>Get-NetAdapterIPsecOffload -Name "MyAdapter"
This command gets the IPsec offload properties of the network adapter named MyAdapter.
Example 2: Display all IPsec offload properties for the specified network adapter
PS C:\\>Get-NetAdapterIPsecOffload ????????Name "MyAdapter" | Format-List -Property "*"
This command displays all IPsec offload properties of the network adapter named MyAdapter.
Example 3: Get all IPsec offload capable network adapters that have it enabled
PS C:\\>Get-NetAdapterIPsecOffload ????????Name "*" | Where-Object -FilterScript { $_.Enabled }
This command gets all IPsec offload capable network adapters with IPsec offload enabled.
RELATED LINKS
Online Version:
Disable-NetAdapterIPsecOffload
Enable-NetAdapterIPsecOffload
Set-NetAdapterIPsecOffload
SYNOPSIS
Gets the IPsec offload properties of the network adapter.
SYNTAX
Get-NetAdapterIPsecOffload [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>]
[<CommonParameters>]
Get-NetAdapterIPsecOffload [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] -InterfaceDescription <String[]>
[<CommonParameters>]
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 [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
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
-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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
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.
Example 1: Get the IPsec offload properties for the specified network adapter
PS C:\\>Get-NetAdapterIPsecOffload -Name "MyAdapter"
This command gets the IPsec offload properties of the network adapter named MyAdapter.
Example 2: Display all IPsec offload properties for the specified network adapter
PS C:\\>Get-NetAdapterIPsecOffload ????????Name "MyAdapter" | Format-List -Property "*"
This command displays all IPsec offload properties of the network adapter named MyAdapter.
Example 3: Get all IPsec offload capable network adapters that have it enabled
PS C:\\>Get-NetAdapterIPsecOffload ????????Name "*" | Where-Object -FilterScript { $_.Enabled }
This command gets all IPsec offload capable network adapters with IPsec offload enabled.
RELATED LINKS
Online Version:
Disable-NetAdapterIPsecOffload
Enable-NetAdapterIPsecOffload
Set-NetAdapterIPsecOffload