Remove-NetIPsecQuickModeSA

Deletes an established quick mode security association (SA).

Syntax

Remove-NetIPsecQuickModeSA
      [-All]
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Confirm]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]
Remove-NetIPsecQuickModeSA
      [-AsJob]
      -AssociatedNetIPsecMainModeSA <CimInstance>
      [-CimSession <CimSession[]>]
      [-Confirm]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]
Remove-NetIPsecQuickModeSA
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Confirm]
      -InputObject <CimInstance[]>
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]
Remove-NetIPsecQuickModeSA
      [-Name] <String[]>
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-Confirm]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-NetIPsecQuickModeSA cmdlet deletes an established quick mode security association (SA).

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

Examples

EXAMPLE 1

PS C:\>Remove-NetIPsecQuickModeSA -PolicyStore ActiveStore

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

EXAMPLE 2

PS C:\>$computer1 = "RemoteMachineName"



PS C:\>$ipsMMSA = Get-NetIPsecMainModeSA -Name "196511" -CimSession $computer1



PS C:\>Remove-NetIPsecQuickModeSA -CimSession $computer1 -InputObject $ipsMMSA

This example removes all of the active quick mode cryptographic sets associated with the specified main mode security association on a remote computer.

Required Parameters

-AssociatedNetIPsecMainModeSA

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

Type:CimInstance
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies that only matching quick mode cryptographic sets 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 quick mode encryption are overridden, specify the customized parameters and set this parameter value, making this parameter the new default setting for encryption.

Type:String[]
Aliases:ID
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-All

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

Type:SwitchParameter
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.

Type:SwitchParameter
Position:Named
Default value:None
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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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.

Type:SwitchParameter
Position:Named
Default value:None
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 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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

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.

Inputs

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

None