Remove-NetIPsecMainModeSA

Remove-NetIPsecMainModeSA

Removes an active main mode security association (SA).

Syntax

Parameter Set: ByAssociatedNetIPsecQuickModeSA
Remove-NetIPsecMainModeSA -AssociatedNetIPsecQuickModeSA <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByName
Remove-NetIPsecMainModeSA [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: GetAll
Remove-NetIPsecMainModeSA [-All] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetIPsecMainModeSA -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-NetIPsecMainModeSA cmdlet deletes an established main mode security association (SA).

The main mode SAs can be monitored for information including which peers are currently connected to this computer and which protection suite was used to create the SA. To view the active main mode SAs with the computer, run the Get-NetIPsecMainModeSA cmdlet. Use the InputObject parameter, or the pipeline, to input the SA into this cmdlet to remove the association from the computer.

Parameters

-All

Indicates that all of the main mode security associations within the specified policy store are removed.

-AsJob

-AssociatedNetIPsecQuickModeSA<CimInstance>

Gets the quick mode security associations associated with the given main mode security association.

-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.

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-Name<String[]>

Specifies that only matching main mode rules of the indicated name are removed. 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. Since GPOs can have precedence, if an administrator that gives a rule with a different or more specific rule 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 are overridden, specify the customized parameters and set this parameter value, making this parameter the new default setting for encryption.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-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.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetIPsecMainModeSA[]

  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.

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetIPsecQuickModeSA

  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

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

• None

Examples

EXAMPLE 1

This example removes all of the active main mode cryptographic sets on the local computer.

PS C:\> Remove-NetIPsecMainModeSA –PolicyStore ActiveStore

EXAMPLE 2

This example removes a specified main mode security association on a remote computer.

PS C:\> $computer1 = "RemoteMachineName"

PS C:\> $ipsQMSA = Get-NetIPsecQuickModeSA –Name "3456" –CimSession $computer1

PS C:\> Remove-NetIPsecMainModeSA –CimSession $computer1 –InputObject $ipsQMSA

Related topics

Get-NetIPsecMainModeSA