NetSecurity PowerShell Module

https://learn.microsoft.com/en-us/powershell/module/netsecurity
Admin
NetSecurity PowerShell Module is a Microsoft utility for managing Windows firewall rules, IPSec...
Tokens:439,670
Snippets:1,750
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example -PolicyStore values

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/open-netgpo

Examples of -PolicyStore values for localhost and a domain GPO.

```powershell
-PolicyStore localhost
```

```powershell
-PolicyStore corp.contoso.com\FirewallPolicy
```

--------------------------------

### Example: -PolicyStore localhost

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/remove-netipsecrule

Example showing how to specify the local computer as the policy store using the -PolicyStore parameter.

```powershell
-PolicyStore localhost
```

--------------------------------

### PolicyStore parameter examples

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netipsecrule

Examples of specifying the -PolicyStore parameter for computer GPOs, Active Directory GPOs, and localhost.

```powershell
-PolicyStore hostname
```

```powershell
-PolicyStore domain.fqdn.com\GPO_Friendly_Name
```

```powershell
-PolicyStore localhost
```

```powershell
-PolicyStore corp.contoso.com\FirewallPolicy
```

--------------------------------

### Example: -PolicyStore corp.contoso.com\FirewallPolicy

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/remove-netipsecrule

Example showing how to specify an Active Directory GPO named FirewallPolicy in the corp.contoso.com domain as the policy store.

```powershell
-PolicyStore corp.contoso.com\FirewallPolicy
```

--------------------------------

### Set-NetFirewallSetting

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallsetting

Documentation for the Set-NetFirewallSetting cmdlet, including syntax, parameters, and examples.

```APIDOC
## Set-NetFirewallSetting

### Description
Configures properties that apply to the firewall and IPsec settings, regardless of which network profile is currently in use. This cmdlet allows the administrator to specify global firewall behavior.

### Syntax
```powershell
Set-NetFirewallSetting [-Exemptions] <Exemptions> [-InputObject] <CimInstance> [-PolicyStore <string>] [-RemoteMachineTunnelAuthorizationList <string>] [-RemoteMachineTransportAuthorizationList <string>] [-RemoteUserTransportAuthorizationList <string>] [-EnablePacketQueuing <EnablePacketQueuing>] [-KeyEncoding <KeyEncoding>] [-MaxSAContexts <uint32>] [-Force] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Parameters
- **-Exemptions** (Exemptions) - Specifies the type of traffic that is exempt from firewall and IPsec settings. Acceptable values: `None`, `NeighborDiscovery`, `ICMP`, `RouterDiscovery`, `DHCP`.
- **-InputObject** (CimInstance) - Specifies the input object that represents the firewall settings to modify. This parameter is required.
- **-PolicyStore** (string) - Specifies the policy store from which to retrieve the settings. Acceptable values: `PersistentStore`, `ActiveStore`, `SystemDefaults`, `GPO` (as `domain.com/gpo_name`), or a computer name.
- **-RemoteMachineTunnelAuthorizationList** (string) - Specifies the SDDL string that authorizes remote machines for tunnel mode.
- **-RemoteMachineTransportAuthorizationList** (string) - Specifies the SDDL string that authorizes remote machines for transport mode.
- **-RemoteUserTransportAuthorizationList** (string) - Specifies the SDDL string that authorizes remote users for transport mode.
- **-EnablePacketQueuing** (EnablePacketQueuing) - Specifies how packet queuing is enabled. Acceptable values: `None`, `Inbound`, `Outbound`, `Both`.
- **-KeyEncoding** (KeyEncoding) - Specifies the key encoding for IPsec. Acceptable values: `UTF16`, `UTF8`.
- **-MaxSAContexts** (uint32) - Specifies the maximum number of security association contexts.
- **-Force** (switch) - Forces the command to run without asking for user confirmation.
- **-PassThru** (switch) - Returns the newly modified object.
- **-CimSession** (CimSession[]) - Runs the cmdlet in a remote session or on a remote computer.
- **-ThrottleLimit** (int) - Specifies the maximum number of concurrent operations.
- **-AsJob** (switch) - Runs the cmdlet as a background job.
- **-WhatIf** (switch) - Shows what would happen if the cmdlet runs.
- **-Confirm** (switch) - Prompts for confirmation before running the cmdlet.

### Examples
#### Example 1: Modify global firewall settings for a GPO
```powershell
$nfSetting = Get-NetFirewallSetting -PolicyStore corp.contoso.com/gpo_name
Set-NetFirewallSetting -Exemptions RouterDiscovery -InputObject $nfSetting
```
This example modifies the global firewall settings of a particular GPO policy store.

#### Example 2: Set remote machine tunnel authorization list
```powershell
$computers = New-Object -Typename System.Security.Principal.NTAccount ("corp.contoso.com" "SecureMachineName1")
$SIDofSecureComputerGroup = $computers.Translate([System.Security.Principal.SecurityIdentifier]).Value
$SecureMachineGroupSDDL = "D:(A;;CC;;; $SIDofSecureComputerGroup)"
$nfSetting = Get-NetFirewallSetting -PolicyStore corp.contoso.com/gpo_name
Set-NetFirewallSetting -RemoteMachineTunnelAuthorizationList $SecureMachineGroupSDDL -InputObject $nfSetting
```
This example allows authorization to override the per-rule basis and to be done at the IPsec layer in a GPO.
```

--------------------------------

### Set-NetFirewallSetting

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallsetting

Documentation for the Set-NetFirewallSetting cmdlet, including its parameters, syntax, and examples.

```APIDOC
## Set-NetFirewallSetting

### Description
Sets the local firewall settings for the specified network firewall profile.

### Syntax
```powershell
Set-NetFirewallSetting [-AllowIPsecThroughNAT <IPsecThroughNAT>] [-AsJob] [-CertValidationLevel <CRLCheck>] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### Parameters
#### -AllowIPsecThroughNAT
- Type: IPsecThroughNAT
- Default value: None
- Accepted values: None, Server, Both, NotConfigured
- Mandatory: False
- Position: Named
- Description: Specifies that IPsec configures a security association (SA) when one or both computers involved are behind a network address translation (NAT) device. This setting indicates on which side NAT traversal should be attempted.

#### -AsJob
- Type: SwitchParameter
- Default value: None
- Mandatory: False
- Position: Named
- Description: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

#### -CertValidationLevel
- Type: CRLCheck
- Default value: None
- Accepted values: None, AttemptCrlCheck, RequireCrlCheck, NotConfigured
- Mandatory: False
- Position: Named
- Description: Specifies that IPsec checks the certificates used in authentication against a certificate revocation list (CRL), and how IPsec reacts to a certificate that is found to be on a CRL.

#### -CimSession
- Type: CimSession[]
- Default value: None
- Aliases: Session
- Mandatory: False
- Position: Named
- Description: 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.

#### -Confirm
- Type: SwitchParameter
- Default value: False
- Aliases: cf
- Mandatory: False
- Position: Named
- Description: Prompts you for confirmation before running the cmdlet.

#### -WhatIf
- Type: SwitchParameter
- Default value: False
- Aliases: wi
- Mandatory: False
- Position: Named
- Description: Shows what would happen if the cmdlet runs. The cmdlet is not run.

### Outputs
This cmdlet does not return any output.

### Examples
#### Example 1: Set the AllowIPsecThroughNAT setting
```powershell
Set-NetFirewallSetting -AllowIPsecThroughNAT Both
```
This command sets the AllowIPsecThroughNAT setting to Both, allowing IPsec security associations to be negotiated when both computers are behind NAT devices.

#### Example 2: Set the CertValidationLevel setting
```powershell
Set-NetFirewallSetting -CertValidationLevel RequireCrlCheck
```
This command sets the CertValidationLevel setting to RequireCrlCheck, requiring certificate revocation list checking for IPsec authentication.

### Notes
- The default value for AllowIPsecThroughNAT is None. When managing a GPO, the default setting is NotConfigured.
- The default value for CertValidationLevel is None. When managing a GPO, the default setting is NotConfigured.
- This cmdlet is part of the NetSecurity module.
```

--------------------------------

### Rename-NetIPsecMainModeCryptoSet example

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netipsecmainmodecryptoset

Renames a main mode cryptographic set from its GUID to a descriptive name. The example uses the -Name and -NewName parameters.

```powershell
PS C:\>Rename-NetIPsecMainModeCryptoSet -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "(DA Client) - Phase 2 Crypto Set"
```

--------------------------------

### Rename-NetFirewallRule example

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netfirewallrule

Renames a firewall rule identified by its GUID to a descriptive name. The example uses the -Name parameter to specify the rule and -NewName to set the new name.

```powershell
PS C:\>Rename-NetFirewallRule -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "Contoso-NETDIS-UPnPHost-Out-TCP-Active"

```

--------------------------------

### Rename-NetIPsecMainModeRule example

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netipsecmainmoderule

Renames a main mode rule identified by its GUID to a descriptive name. The example uses the -Name parameter to specify the rule and -NewName to set the new name.

```powershell
PS C:\>Rename-NetIPsecMainModeRule -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "Tunnel Mode - Americas (DA Client)"

```

--------------------------------

### Rename-NetIPsecPhase1AuthSet example

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netipsecphase1authset

Renames a phase 1 authentication set identified by its GUID to a descriptive name. Useful for making the unique identifier user-friendly.

```powershell
PS C:\>Rename-NetIPsecPhase1AuthSet -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "Transport Mode - Home LAN - Phase 1 Auth Set"

```

--------------------------------

### Create a domain isolation rule with multiple quick mode proposals

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/new-netipsecrule

Creates a domain isolation rule with a custom quick mode crypto set that includes multiple proposals. The example shows how to specify AH and ESP protocols, use the None keyword for optional components, and set custom SA timeouts.

```powershell
This cmdlet illustrates how to include both AH and ESP protocols in a single suite.
PS C:\>$aHandESPQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation AH,ESP -AHHash SHA1 -ESPHash SHA1 -Encryption DES3


This cmdlet illustrates how to specify the use of the AH protocol only.
PS C:\>$aHQM = New-NetipsecQuickModeCryptoProposal -Encapsulation AH -AHHash SHA1 -ESPHash None -Encryption None


This cmdlet illustrates how to specify the use of the ESP protocol only, and uses the None keyword to specify not to include an encryption option.
PS C:\>$eSPQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation ESP -ESPHash SHA1 -Encryption None


This cmdlet illustrates how to use the None keyword to specify that ESP is used with an encryption protocol, but with no integrity protocol. This cmdlet also illustrates how to set a custom SA timeout using both time and data amount values.
PS C:\>$eSPnoAHQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation ESP -ESPHash None -Encryption AES256 -MaxKiloBytes 50000 -MaxMinutes 30



PS C:\>$qMCryptoSet = New-NetIPsecQuickModeCryptoSet -DisplayName "Custom Quick Mode" -Proposal $aHandESPQM,$aHQM,$eSPQM,$eSPnoAHQM



PS C:\>New-NetIPsecRule -DisplayName "Domain Isolation Rule" -InboundSecurity Require Request -OutboundSecurity Request -QuickModeCryptoSet $qMCryptoSet.Name

```

--------------------------------

### Rename an IPsec rule with Rename-NetIPsecRule

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netipsecrule

Renames an IPsec rule by specifying its current name (GUID) and a new descriptive name. The example uses the -IPsecRuleName and -NewName parameters.

```powershell
PS C:\>Rename-NetIPsecRule -IPsecRuleName "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "SecureNet - Exempt Servers"

```

--------------------------------

### Set-NetFirewallSetting -WhatIf

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallsetting

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

```APIDOC
## Set-NetFirewallSetting -WhatIf

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

### Parameters
#### -WhatIf
- **Type:** SwitchParameter
- **Default value:** False
- **Supports wildcards:** False
- **DontShow:** False
- **Aliases:** wi
- **Position:** Named
- **Mandatory:** False
- **Value from pipeline:** False
- **Value from pipeline by property name:** False
- **Value from remaining arguments:** False

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
```

--------------------------------

### Set-NetFirewallHyperVVMSetting

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallhypervvmsetting

Documentation for the Set-NetFirewallHyperVVMSetting cmdlet, including its parameters and common parameters.

```APIDOC
## Set-NetFirewallHyperVVMSetting

### Description
Modifies the Hyper-V firewall settings for a specific VM creator. This cmdlet allows you to enable or disable the Hyper-V firewall and control guest-host loopback traffic.

### Syntax
```powershell
Set-NetFirewallHyperVVMSetting [-Name] <String> [-Enabled <GpoBoolean>] [-LoopbackEnabled <GpoBoolean>] [-ThrottleLimit <Int32>] [-CommonParameters]
```

### Parameters

#### -Name
- **Type:** String
- **Mandatory:** False
- **Position:** Named
- **Aliases:** VMCreatorId
- **Description:** Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'.

#### -Enabled
- **Type:** GpoBoolean
- **Mandatory:** False
- **Position:** Named
- **Accepted values:** False, True, NotConfigured
- **Description:** Determines whether or not the Hyper-V firewall is active and enforced. This setting applies the configuration to all profiles. For per-profile granularity, use the `Set-NetFirewallHyperVProfile` cmdlet. True enables the firewall, False disables it, and NotConfigured resets to default (True).

#### -LoopbackEnabled
- **Type:** GpoBoolean
- **Mandatory:** False
- **Position:** Named
- **Accepted values:** False, True, NotConfigured
- **Description:** Determines whether or not guest-host loopback traffic is allowed. This setting is orthogonal to existing Hyper-V firewall rules; both must allow communication for it to succeed. True allows traffic, False blocks it, and NotConfigured resets to default (False).

#### -ThrottleLimit
- **Type:** Int32
- **Mandatory:** False
- **Position:** Named
- **Description:** Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If omitted or set to 0, Windows PowerShell calculates an optimum throttle limit based on the number of CIM cmdlets running on the computer.

#### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

### Examples
No examples are provided in the source documentation.

### Notes
- The default value for -Enabled is True.
- The default value for -LoopbackEnabled is False.
- The -Name parameter uses the alias VMCreatorId.
- The cmdlet is part of the NetSecurity module.
```

--------------------------------

### Set-NetIPsecQuickModeCryptoSet -WhatIf

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netipsecquickmodecryptoset

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

```APIDOC
## Set-NetIPsecQuickModeCryptoSet -WhatIf

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

### Parameters
#### -WhatIf
- **Type**: SwitchParameter
- **Default value**: False
- **Supports wildcards**: False
- **DontShow**: False
- **Aliases**: wi
- **Position**: Named
- **Mandatory**: False
- **Value from pipeline**: False
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```

--------------------------------

### Sync-NetIPsecRule -All syntax (GetAll parameter set)

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/sync-netipsecrule

Shows the syntax for the default GetAll parameter set, which syncs all IPsec rules. Includes common parameters and options for policy store, servers, domains, and CIM session.

```powershell
Sync-NetIPsecRule
    [-All]
    [-PolicyStore <String>]
    [-GPOSession <String>]
    [-TracePolicyStore]
    [-Servers <String[]>]
    [-Domains <String[]>]
    [-EndpointType <EndpointType>]
    [-AddressType <AddressVersion>]
    [-DnsServers <String[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
```

--------------------------------

### Rename-NetIPsecMainModeCryptoSet

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/rename-netipsecmainmodecryptoset

Documentation for the Rename-NetIPsecMainModeCryptoSet cmdlet, including its parameters and an example.

```APIDOC
## Rename-NetIPsecMainModeCryptoSet

### Description
Renames a main mode cryptographic set. This cmdlet allows you to change the name of an existing main mode cryptographic set to a more descriptive or user-friendly name.

### Syntax
```powershell
Rename-NetIPsecMainModeCryptoSet [-Name] <string> -NewName <string> [-All] [-AsJob] [-AssociatedNetIPsecMainModeRule <CimInstance>] [-CimSession <CimSession[]>] [-Confirm] [-Description <string[]>] [-WhatIf] [<CommonParameters>]
```

### Parameters
#### -Name
- Type: String
- Position: 0
- Mandatory: True
- Description: Specifies the name (or unique identifier) of the main mode cryptographic set to rename.

#### -NewName
- Type: String
- Position: Named
- Mandatory: True
- Description: Specifies the new name for the main mode cryptographic set.

#### -All
- Type: SwitchParameter
- Position: Named
- Mandatory: False
- Description: Indicates that all main mode cryptographic sets within the specified policy store are renamed.

#### -AsJob
- Type: SwitchParameter
- Position: Named
- Mandatory: False
- Description: Runs the cmdlet as a background job.

#### -AssociatedNetIPsecMainModeRule
- Type: CimInstance
- Position: Named
- Mandatory: True (when specified)
- Description: Gets the main mode cryptographic sets that are associated, via the pipeline, with the input main mode rule to be renamed.

#### -CimSession
- Type: CimSession[]
- Position: Named
- Mandatory: False
- Aliases: Session
- Description: Runs the cmdlet in a remote session or on a remote computer.

#### -Confirm
- Type: SwitchParameter
- Position: Named
- Mandatory: False
- Aliases: cf
- Description: Prompts you for confirmation before running the cmdlet.

#### -Description
- Type: String[]
- Position: Named
- Mandatory: False
- Description: Specifies that matching main mode cryptographic sets of the indicated description are renamed. Wildcard characters are accepted.

### Examples
#### Example 1: Rename a main mode cryptographic set
```powershell
Rename-NetIPsecMainModeCryptoSet -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "(DA Client) - Phase 2 Crypto Set"
```
This example renames a main mode cryptographic set so that the unique identifier is descriptive and user friendly.
```

--------------------------------

### Show-NetFirewallRule Syntax (Default Parameter Set)

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/show-netfirewallrule

The default syntax for the Show-NetFirewallRule cmdlet, showing all available parameters including PolicyStore, GPOSession, CimSession, ThrottleLimit, and AsJob.

```powershell
Show-NetFirewallRule
    [-PolicyStore <String>]
    [-GPOSession <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

```

--------------------------------

### Remove-NetIPsecPhase1AuthSet

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/remove-netipsecphase1authset

Documentation for the Remove-NetIPsecPhase1AuthSet cmdlet, including its description, syntax, parameters, and examples.

```APIDOC
## Remove-NetIPsecPhase1AuthSet

### Description
Permanently deletes one or more phase 1 authentication sets from the computer. This cmdlet gets one or more authentication sets to be deleted with the Name parameter (default), the DisplayName parameter, the Group parameter, or by associated IPsec rule, and removes the resulting queried set from the computer.

### Syntax
```powershell
Remove-NetIPsecPhase1AuthSet [-All] [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -AssociatedNetIPsecMainModeRule <CimInstance> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -AssociatedNetIPsecRule <CimInstance> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -DisplayName <String> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -Group <String> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -InputObject <CimInstance> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-NetIPsecPhase1AuthSet -Name <String[]> [-AsJob] [-CimSession <CimSession[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### Parameters
#### -All
Indicates that all of the phase 1 authentication sets within the specified policy store are removed.
- Type: SwitchParameter
- Default value: None
- Supports wildcards: False
- Mandatory: False
- Position: Named
- Accept pipeline input: False

#### -AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
- Type: SwitchParameter
- Default value: None
- Supports wildcards: False
- Mandatory: False
- Position: Named
- Accept pipeline input: False

#### -AssociatedNetIPsecMainModeRule
Gets the phase 1 authentication sets that are associated, via the pipeline, with the input main mode rule to be removed. A NetIPsecMainModeRule object represents a main mode rule, which alters the behavior of main mode authentications.
- Type: CimInstance
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: True (ByValue)

#### -AssociatedNetIPsecRule
Gets the phase 1 authentication sets that are associated, via the pipeline, with the input IPsec rule to be removed. A NetIPsecRule object represents an IPsec rule, which determines IPsec behavior.
- Type: CimInstance
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: True (ByValue)

#### -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[]
- Default value: None
- Supports wildcards: False
- Aliases: Session
- Mandatory: False
- Position: Named
- Accept pipeline input: False

#### -Confirm
Prompts you for confirmation before running the cmdlet.
- Type: SwitchParameter
- Default value: False
- Supports wildcards: False
- Aliases: cf
- Mandatory: False
- Position: Named
- Accept pipeline input: False

#### -DisplayName
Specifies the localized name of the phase 1 authentication set to be removed.
- Type: String
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: False

#### -Group
Specifies the group name of the phase 1 authentication set to be removed.
- Type: String
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: False

#### -InputObject
Specifies the object to be removed. This parameter accepts a NetIPsecPhase1AuthSet object, or a NetIPsecMainModeRule or NetIPsecRule object via the pipeline.
- Type: CimInstance
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: True (ByValue)

#### -Name
Specifies the name of the phase 1 authentication set to be removed.
- Type: String[]
- Default value: None
- Supports wildcards: False
- Mandatory: True
- Position: Named
- Accept pipeline input: False

#### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
- Type: SwitchParameter
- Default value: None
- Supports wildcards: False
- Aliases: wi
- Mandatory: False
- Position: Named
- Accept pipeline input: False

### Examples
#### Example 1: Remove all static local phase 1 authentication sets
```powershell
Remove-NetIPsecPhase1AuthSet
```
This example removes all of the static local phase 1 authentication sets. This cmdlet is useful for removing any policy that conflicts with the domain GPO.

#### Example 2: Remove a phase 1 authentication set by display name
```powershell
Remove-NetIPsecPhase1AuthSet -DisplayName "(DA Client) - Phase 1 Auth Set"
```
This example deletes a set based on the localized name.

#### Example 3: Remove phase 1 authentication sets associated with a main mode rule
```powershell
$ipsMMRule = Get-NetIPsecMainModeRule -DisplayName "Main Mode Authenticate Computer"
Remove-NetIPsecPhase1AuthSet -InputObject $ipsMMRule
```
This example removes all of the phase 1 authentication sets that are associated with the main mode rule.
```

--------------------------------

### Show-NetIPsecRule Syntax (Default Parameter Set)

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/show-netipsecrule

Shows the default parameter set syntax for the Show-NetIPsecRule cmdlet. It includes parameters such as PolicyStore, GPOSession, CimSession, ThrottleLimit, and AsJob.

```powershell
Show-NetIPsecRule
    [-PolicyStore <String>]
    [-GPOSession <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

```

--------------------------------

### Sync-NetIPsecRule -AssociatedNetFirewallPortFilter

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/sync-netipsecrule

Gets the IPsec rules that are associated with the given port filter to be synchronized.

```APIDOC
## Sync-NetIPsecRule -AssociatedNetFirewallPortFilter

### Description
Gets the IPsec rules that are associated with the given port filter to be synchronized. A _NetFirewallPortFilter_ object represents the port conditions associated with a rule. See the Get-NetFirewallPortFilter cmdlet for more information.

### Parameters
#### -AssociatedNetFirewallPortFilter
- **Type**: CimInstance
- **Default value**: None
- **Supports wildcards**: False
- **DontShow**: False
- **Position**: Named
- **Mandatory**: True
- **Value from pipeline**: True
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```

--------------------------------

### Set-NetFirewallRule -WhatIf

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallrule

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

```APIDOC
## Set-NetFirewallRule -WhatIf

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

### Parameters
#### -WhatIf
- **Type**: SwitchParameter
- **Default value**: False
- **Supports wildcards**: False
- **DontShow**: False
- **Aliases**: wi
- **Position**: Named
- **Mandatory**: False
- **Value from pipeline**: False
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```

--------------------------------

### Sync-NetIPsecRule -AssociatedNetFirewallProfile

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/sync-netipsecrule

Gets the IPsec rules that are associated with the given firewall profile type to be synchronized.

```APIDOC
## Sync-NetIPsecRule -AssociatedNetFirewallProfile

### Description
Gets the IPsec rules that are associated with the given firewall profile type to be synchronized. A _NetFirewallProfile_ object represents the profile conditions associated with a rule. See the Get-NetFirewallProfile cmdlet for more information.

### Parameters
#### -AssociatedNetFirewallProfile
- **Type**: CimInstance
- **Default value**: None
- **Supports wildcards**: False
- **DontShow**: False
- **Position**: Named
- **Mandatory**: True
- **Value from pipeline**: True
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```

--------------------------------

### New-NetIPsecRule -WhatIf

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/new-netipsecrule

Shows what would happen if the cmdlet runs without actually running it.

```APIDOC
## New-NetIPsecRule -WhatIf

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

### Parameters
#### -WhatIf
- **Type**: SwitchParameter
- **Default value**: False
- **Supports wildcards**: False
- **DontShow**: False
- **Aliases**: wi
- **Position**: Named
- **Mandatory**: False
- **Value from pipeline**: False
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```

--------------------------------

### Sync-NetIPsecRule -AssociatedNetFirewallInterfaceTypeFilter

Source: https://learn.microsoft.com/en-us/powershell/module/netsecurity/sync-netipsecrule

Gets the IPsec rules that are associated with the given interface type filter to be synchronized.

```APIDOC
## Sync-NetIPsecRule -AssociatedNetFirewallInterfaceTypeFilter

### Description
Gets the IPsec rules that are associated with the given interface type filter to be synchronized. A _NetFirewallInterfaceTypeFilter_ object represents the interface conditions associated with a rule. See the Get-NetFirewallInterfaceTypeFilter cmdlet for more information.

### Parameters
#### -AssociatedNetFirewallInterfaceTypeFilter
- **Type**: CimInstance
- **Default value**: None
- **Supports wildcards**: False
- **DontShow**: False
- **Position**: Named
- **Mandatory**: True
- **Value from pipeline**: True
- **Value from pipeline by property name**: False
- **Value from remaining arguments**: False
```
Tokens:
Raw