Copy-NetIPsecMainModeRule

Copy-NetIPsecMainModeRule

Copies an entire main mode rule, and associated filters, to the same or to a different policy store.

Syntax

Parameter Set: ByAssociatedNetFirewallAddressFilter
Copy-NetIPsecMainModeRule -AssociatedNetFirewallAddressFilter <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByAssociatedNetFirewallProfile
Copy-NetIPsecMainModeRule -AssociatedNetFirewallProfile <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByAssociatedNetIPsecMainModeCryptoSet
Copy-NetIPsecMainModeRule -AssociatedNetIPsecMainModeCryptoSet <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByAssociatedNetIPsecPhase1AuthSet
Copy-NetIPsecMainModeRule -AssociatedNetIPsecPhase1AuthSet <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByDisplayName
Copy-NetIPsecMainModeRule -DisplayName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByName
Copy-NetIPsecMainModeRule [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByQuery
Copy-NetIPsecMainModeRule [-AsJob] [-CimSession <CimSession[]> ] [-Description <String[]> ] [-DisplayGroup <String[]> ] [-Enabled <Enabled[]> ] [-GPOSession <String> ] [-Group <String[]> ] [-MainModeCryptoSet <String[]> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-Phase1AuthSet <String[]> ] [-PolicyStore <String> ] [-PolicyStoreSource <String[]> ] [-PolicyStoreSourceType <PolicyStoreType[]> ] [-PrimaryStatus <PrimaryStatus[]> ] [-Status <String[]> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: GetAll
Copy-NetIPsecMainModeRule [-All] [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Copy-NetIPsecMainModeRule -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-NewGPOSession <String> ] [-NewName <String> ] [-NewPolicyStore <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Copy-NetIPsecMainModeRule cmdlet copies a main mode rule and associated filters to a policy store, making a complete clone. When a new policy store is not specified, it is copied to the same policy store with a new name specified by the user.

This cmdlet gets one or more main mode rules to be duplicated with the Name parameter (default), the DisplayName parameter, rule properties, or by the associated filters or objects. The resulting queried rule is copied to a new policy store using the NewPolicyStore parameter, a new GPO session using the NewGPOSession parameter, or to the same policy store using the NewName parameter by. Note: Only one main mode rule can be copied at a time when copying to the same policy store. This is because only a single main mode rule can use the unique identifier, or name, specified by the NewName parameter.

When copying a rule to a new policy store, the unique name of the set is preserved. This means that if the same set is attempted to be copied twice, then an error is displayed for the second attempt indicating that the object already exists. To overwrite the target set, run the Remove-NetIPsecMainModeRule cmdlet first. If it is possible that the object may already exist, then specify the ErrorAction parameter to silently ignore these errors, instead of running the Remove-NetIPsecMainModeRule cmdlet.

When copying rules between different policy stores, the authentication and cryptographic sets referenced in each rule must be copied separately. See the Copy-NetIPsecPhase1AuthSet and Copy-NetIPsecMainModeCryptoSet cmdlets for more information. When copying a main mode rule that has associated authentication or cryptographic sets from GPO-A to GPO-B, the newly created authentication and cryptographic set fields of the rule will maintain the Name parameter values of the source. This is desirable because after the NetIPsecPhase1AuthSet and NetIPsecMainModeCryptoSet are copied separately, they will be associated with the newly copied rule.

Parameters

-All

Indicates that all of the main mode rules within the specified policy store are copied.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AssociatedNetFirewallAddressFilter<CimInstance>

Gets the firewall rules that are associated with the given address filter to be copied.
A NetFirewallAddressFilter object represents the address conditions associated with a rule. See the Get-NetFirewallAddressFilter cmdlet for more information.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-AssociatedNetFirewallProfile<CimInstance>

Gets the firewall rules that are associated with the given port filter to be copied.
A NetFirewallPortFilter object represents the profile conditions associated with a rule. See the Get-NetFirewallProfile cmdlet for more information.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-AssociatedNetIPsecMainModeCryptoSet<CimInstance>

Gets the main mode rules that are associated, via the pipeline, with the input main mode cryptographic set to be copied.
A NetIPsecMainModeCryptoSet object represents a main mode cryptographic conditions associated with a main mode rule. This parameter sets the methods for the main mode negotiation by describing the proposals for encryption. See the Get-NetIPsecMainModeCryptoSet cmdlet for more information.
Alternatively, the MainModeCryptoSet parameter can be used for the same purpose, but does not allow the cryptographic set to be piped into this cmdlet and the set must be specified with the Name parameter.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-AssociatedNetIPsecPhase1AuthSet<CimInstance>

Gets the main mode rules that are associated with the given phase 1 authentication set to be copied.
A NetIPsecPhase1AuthSet object represents the phase 1 authorization set conditions associated with an IPsec or main mode rule. This parameter sets the methods for main mode negotiation by describing the proposals for computer authentication. See the Get-NetIPsecPhase1AuthSet cmdlet for more information.
Alternatively, the Phase1AuthSet parameter can be used for the same purpose, but does not allow the authentication set to be piped into the cmdlet and the set must be specified with the Name parameter.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
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

-Description<String[]>

Specifies that matching main mode rules of the indicated description are copied. Wildcard characters are accepted.
This parameter provides information about the main mode rule. This parameter specifies a localized, user-facing description of the object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisplayGroup<String[]>

Specifies that only matching main mode rules of the indicated group association are copied. Wildcard characters are accepted.
The Group parameter specifies the source string for this parameter. If the value for this parameter is a localizable string, then the Group parameter contains an indirect string. Rule groups can be used to organize rules by influence and allows batch rule modifications. Using the Set-NetIPsecMainModeRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications. It is good practice to specify the Group parameter with a universal and world-ready indirect @FirewallAPI name.
Note: This parameter cannot be specified upon object creation using the New-NetIPsecMainModeRule cmdlet, but can be modified using dot notation and the Set-NetIPsecMainModeRule cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisplayName<String[]>

Specifies that only matching main mode rules of the indicated display name are copied. Wildcard characters are accepted.
This parameter specifies the localized, user-facing name of the main mode rule. When creating a rule this parameter is required. This parameter value is locale-dependent. If the object is not modified, this parameter value may change in certain circumstances. When writing scripts in multi-lingual environments, the Name parameter should be used instead, where the default value is a randomly assigned value.
Note: This parameter cannot be All.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Enabled<Enabled[]>

Specifies that matching main mode rules of the indicated state are copied.
This parameter specifies that the rule object is administratively enabled or administratively disabled. The acceptable values for this parameter are:
-- True: Specifies the rule is currently enabled.
-- False: Specifies the rule is currently disabled. A disabled rule will not actively modify computer behavior, but the rule still exists on the computer so it can be re-enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-GPOSession<String>

Specifies the network GPO from which to retrieve the rules to be copied.
This parameter is used in the same way as the PolicyStore parameter. When modifying Group Policy Objects (GPOs) in Windows PowerShell®, each change to a GPO requires the entire GPO to be loaded, modified, and saved back. On a busy Domain Controller (DC), this can be a slow and resource-heavy operation. A GPO Session loads a domain GPO onto the local computer and makes all changes in a batch, before saving it back. This reduces the load on the DC and speeds up the Windows PowerShell cmdlets. To load a GPO Session, use the Open-NetGPO cmdlet. To save a GPO Session, use the Save-NetGPO cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Group<String[]>

Specifies that only matching main mode rules of the indicated group association are copied. Wildcard characters are accepted.
This parameter specifies the source string for the DisplayGroup parameter. If the DisplayGroup parameter value is a localizable string, then this parameter contains an indirect string. Rule groups can be used to organize rules by influence and allows batch rule modifications. Using the Set-NetIPsecMainModeRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications. It is good practice to specify this parameter with a universal and world-ready indirect @FirewallAPI name.
Note: The DisplayGroup parameter cannot be specified upon object creation using the New-NetIPsecMainModeRule cmdlet, but can be modified using dot notation and the Set-NetIPsecMainModeRule cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

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

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-MainModeCryptoSet<String[]>

Specifies the IPsec main mode rules that are associated with the given main mode cryptographic set to be copied.
This parameter specifies, by name, the main mode cryptographic set that is associated with the main mode rule.
A NetIPsecMainModeCryptoSet object represents a main mode cryptographic conditions associated with a main mode rule. This parameter sets the methods for main mode negotiation by describing the proposals for encryption. This is only associated with main mode rules. See the Get-NetIPsecMainModeCryptoSet cmdlet for more information. Alternatively, the AssociatedNetIPsecMainModeCryptoSet parameter can be used for the same purpose, but is used for piping the input set into the cmdlet.
Note: When specifying cryptographic sets, the name of the cryptographic set must be used. The object cannot be directly passed to the cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies that only matching main mode rules of the indicated name are copied. 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.

Aliases	ID
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NewGPOSession<String>

Specifies the new GPO session for one or more main mode rules.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NewName<String>

Specifies the new name for one or more main mode rules.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NewPolicyStore<String>

Specifies the policy store for one or more main mode rules.

Aliases	none
Required?	false
Position?	named
Default Value	none
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Phase1AuthSet<String[]>

Specifies the main mode rules that are associated with the given phase 1 authentication set to be copied.
This parameter specifies, by name, the Phase 1 authentication set that is associated with the main mode rule.
A NetIPsecPhase1AuthSet object represents the phase 1 authentication conditions associated with an IPsec or main mode rule. This parameter sets the methods for main mode negotiation by describing the proposals for computer authentication. See the New-NetIPsecAuthProposal cmdlet of more information. Alternatively, the AssociatedNetIPsecPhase1AuthSet parameter can be used for the same purpose, but is used to pipe the input set into the cmdlet.
Note: When specifying authentication sets, the name of the authentication set must be used. The object cannot be directly passed to the cmdlet. Use
Note: Each authentication set must be created in the policy store for the associated IPsec rule. If a particular set applies to multiple IPsec rules in different policy stores (GPOs), then the set must be duplicated for each of those stores (so that policies can be updated without linking issues). See the cmdlets with the Copy verb.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PolicyStore<String>

Specifies the policy store from which to retrieve the rules to be copied.
A policy store is a container for firewall and IPsec policy.
The acceptable values for this parameter are:
-- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. Rules created in this store are attached to the ActiveStore and activated on the computer immediately.
-- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. This is the resultant set of policy (RSOP) for the local computer (the sum of all GPOs that apply to the computer), and the local stores (the PersistentStore, the static Windows service hardening (WSH), and the configurable WSH).
---- Group Policy Objects (GPOs) are also policy stores. Computer GPOs can be specified as follows.
----- –PolicyStore hostname.
- - Active Directory GPOs can be specified as follows.
------ –PolicyStore domain.fqdn.com\GPO_Friendly_Namedomain.fqdn.comGPO_Friendly_Name.
------ Such as the following.
-------- -PolicyStore localhost
-------- -PolicyStore corp.contoso.com\FirewallPolicy
---- Active Directory GPOs can be created using the New-GPO cmdlet or the Group Policy Management Console.
-- RSOP: This read-only store contains the sum of all GPOs applied to the local computer.
-- SystemDefaults: This read-only store contains the default state of firewall rules that ship with Windows Server® 2012.
-- StaticServiceStore: This read-only store contains all the service restrictions that ship with Windows. Optional and product-dependent features are considered part of Windows Server 2012 for the purposes of WFAS.
-- ConfigurableServiceStore: This read-write store contains all the service restrictions that are added for third-party services. In addition, network isolation rules that are created for Windows Store application containers will appear in this policy store.
The default value is PersistentStore.
Note: The Set-NetIPsecMainModeRule cmdlet cannot be used to add an object to a policy store. An object can only be added to a policy store at creation time with this cmdlet and the New-NetIPsecMainModeRule cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PolicyStoreSource<String[]>

Specifies that main mode rules that match the indicated policy store source are copied.
This parameter contains a path to the policy store where the rule originated if the object is retrieved from the ActiveStore with the TracePolicyStoreSource option set. This parameter value is automatically generated and should not be modified.
The monitoring output from this parameter is not completely compatible with the PolicyStore parameter. This parameter value cannot always be passed into the PolicyStore parameter. Domain GPOs are one example in which this parameter contains only the GPO name, not the domain name.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PolicyStoreSourceType<PolicyStoreType[]>

Specifies the type of policy store from which the rule originated if the object is retrieved from the ActiveStore with the TracePolicyStoreSource option set. This parameter value is automatically generated and should not be modified.
The acceptable values for this parameter are:
-- Local: The object originates from the local store.
-- GroupPolicy: The object originates from a GPO.
-- Dynamic: The object originates from the local runtime state. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.
-- Generated: The object was generated automatically. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.
-- Hardcoded: The object was hard-coded. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PrimaryStatus<PrimaryStatus[]>

Specifies that main mode rules that match the indicated primary status are copied.
This parameter describes the overall status of the rule.
-- OK: Specifies that the rule will work as specified.
-- Degraded: Specifies that one or more parts of the rule will not be enforced.
-- Error: Specifies that the computer is unable to use the rule at all.
See the Status and StatusCode fields of the object for more detailed status information.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Status<String[]>

Specifies that main mode rules that match the indicated status are copied.
This parameter describes the status message for the specified status code value. The status code is a numerical value that indicates any syntax, parsing, or runtime errors in the rule. This parameter value should not be modified.

Aliases	none
Required?	false
Position?	named
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

-TracePolicyStore

Indicates that the main mode rules that match the indicated policy store are copied.
This parameter specifies that the name of the source GPO is queried and set to the PolicyStoreSource parameter value.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
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 (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\AssociatedNetIPsecMainModeCryptoSet

  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\MSFT_NetAddressFilter

  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\MSFT_NetFirewallProfile

  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\MSFT_NetIKEP1AuthSet

  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\MSFT_NetMainModeRule[]

  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\MSFT_NetProtocolPortFilter

  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.

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

  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 copies a main mode rule, found by the localized name, to the current policy store under a new unique identifier. The localized DisplayName parameter value remains the same.

PS C:\> Copy-NetIPsecMainModeRule –DisplayName "Main Mode Rule" -NewName "Alternate Main Mode Rule"

EXAMPLE 2

This example copies an entire IPsec main mode rule and the associated authentication and cryptographic sets to a new policy store. There is no need to link the newly copied sets to the newly copied rule since the set fields of the rule maintain the Name parameter value of the source.

PS C:\> $mMrule = Get-NetIPsecMainModeRule –DisplayName "Main Mode Rule: P1Auth + Crypto" –PolicyStore domain.contoso.com\GPO_name

PS C:\> Copy-NetIPsecPhase1AuthSet –InputObject $mMrule -NewPolicyStore domain.contoso.com\new_GPO

PS C:\> Copy-NetIPsecMainModeCryptoSet –InputObject $mMrule -NewPolicyStore domain.contoso.com\new_GPO

PS C:\> Set-NetIPsecMainModeRule –InputObject $mMrule –Phase1AuthSet $CopiedCryptoSet.Name

The following cmdlets accomplish the same task but take advantage of caching the GPO to apply the changes locally.

PS C:\> $mMrule = Get-NetIPsecMainModeRule –DisplayName "Main Mode Rule: P1Auth + Crypto" –PolicyStore domain.contoso.com\GPO_name

PS C:\> $newGPO = Open-NetGPO –PolicyStore domain.contoso.com\new_GPO

PS C:\> Copy-NetIPsecPhase1AuthSet –InputObject $mMrule –GPOSession $newGPO

PS C:\> Copy-NetIPsecMainModeCryptoSet –InputObject $mMrule –GPOSession $newGPO

PS C:\> Copy-NetIPsecMainModeRule –InputObject $mMrule –GPOSession $newGPO

PS C:\> Save-NetGPO –GPOSession $newGPO

Related topics

Copy-NetIPsecMainModeCryptoSet

Copy-NetIPsecPhase1AuthSet

Get-NetFirewallAddressFilter

Get-NetFirewallProfile

Get-NetIPsecMainModeCryptoSet

Get-NetIPsecMainModeRule

Get-NetIPsecPhase1AuthSet

New-NetIPsecMainModeRule

Open-NetGPO

Remove-NetIPsecMainModeRule

Save-NetGPO

Set-NetIPsecMainModeRule

New-NetIPsecAuthProposal

New-GPO