Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-NetIPsecDospSetting

Windows Server 2012 R2 and Windows 8.1

Updated: March 6, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-NetIPsecDospSetting

Retrieves IPsec DoS protection settings from the target computer.

Syntax

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

Parameter Set: GetAll
Get-NetIPsecDospSetting [-All] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NetIPsecDospSetting cmdlet returns the instances of existing IPsec DoS protection settings.

If the Name parameter is not specified, then all of the Dosp settings configured on the computer are returned. Querying by object requires the use of the Where-Object cmdlet.

Parameters

-All

Indicates that all of the Dosp settings within the specified policy store are retrieved.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


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

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies that only the matching IPsec rules of the indicated name are retrieved. Wildcard characters are accepted.
This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. During group policy processing and policy merge, rules that have the same name but come from multiple stores being merged, will overwrite one another so that only one exists. This overwriting behavior is desirable if the rules serve the same purpose. For instance, all of the firewall rules have specific names, so if an administrator can copy these rules to a GPO, and the rules will override the local versions on a local computer. GPOs can have precedence. So if an administrator has a different or more specific rule with the same name in a higher-precedence GPO, then it overrides other rules that exist.
The default value is a randomly assigned value.
When the defaults for main mode encryption need to overridden, specify the customized parameters and set this parameter value, making this parameter the new default setting for encryption.


Aliases

none

Required?

true

Position?

1

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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. 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\NetIPsecDospSetting[]

    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

This example gets all of the Dosp setting configured on the computer.


PS C:\> Get-NetIPsecDospSetting

EXAMPLE 2

This example gets the Dosp setting with the specified name.


PS C:\> Get-NetIPsecDospSetting -Name CorpNet-PubNet

EXAMPLE 3

This example gets all of the Dosp settings configured to the specified internal interface.


 

PS C:\> $netIPSDospSetting = Get-NetIPsecDospSetting

 

PS C:\> Where-Object –FilterScript { $_.PublicInterfaceAliases –Eq "PubNet" } –InputObject $netIPSDospSetting

 

This cmdlet can be run using only the pipeline.


PS C:\> Get-NetIPsecDospSetting | Where-Object –FilterScript { $_.PublicInterfaceAliases –Eq "PubNet" }

EXAMPLE 4

This example modifies the internal interface of the previously acquired IPsec Dosp settings.


 

PS C:\> $nIPSDospSetting = Get-NetIPsecDospSetting

 

PS C:\> $nIPSDospSettingPubNet = Where-Object –FilterScript { $_.PublicInterfaceAliases –Eq "PubNet" } –InputObject $nIPSDospSetting

 

PS C:\> Set-NetIPsecDospSetting –PublicInterfaceAliases PubNet2 –InputObject $nIPSDospSettingPubNet

 

This cmdlet can be run using only the pipeline.


PS C:\> Get-NetIPsecDospSetting | Where-Object –FilterScript { $_.PublicInterfaceAliases –Eq "PubNet" } | Set-NetIPsecDospSetting –PublicInterfaceAliases PubNet2

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.