Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-NetIPsecMainModeCryptoSet

New-NetIPsecMainModeCryptoSet

netipsecmainmodecryptoset.cmdletdefinition.cdxml

Synopsis

Creates a main mode cryptographic set that contains suites of cryptographic protocols to offer in IPsec main mode negotiations with other computers.

Syntax

New-NetIPsecMainModeCryptoSet [-AsJob] [-CimSession] [-Default] [-Description] [-ForceDiffieHellman] [-GPOSession] [-Group] [-MaxMinutes] [-MaxSessions] [-Name] [-PolicyStore] [-ThrottleLimit] [-DisplayName] [-Proposal] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-NetIPsecMainModeCryptoSet cmdlet creates a cryptographic set to be used to negotiate a main mode security association (SA).

A main mode cryptographic set is an ordered list of cryptographic proposals.

Each proposal in the set specifies a set of encryption, hashing, and key exchange algorithms to propose. Proposals can be created by running the New-NetIPsecMainModeCryptoProposal cmdlet. The main mode exchange will use the first proposal that the peer computers have in common.

The default main mode cryptographic set is used with all IPsec rules. IPsec rules are specified by the Default parameter at creation time. Additional main mode cryptographic sets can be used with IPsec main mode rules for fully customized main mode negotiations.

Parameters

-AsJob <SwitchParameter>

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

-Default <SwitchParameter>

Indicates the customized parameters for overriding the defaults for main mode encryption, making it the new default setting for encryption. For the MainModeCryptoSet object, the default Name parameter value becomes {E5A5D32A-4BCE-4e4d-B07F-4AB1BA7E5FE1}. To retrieve default settings, query by using the default Name parameter value. To specify a different default cryptographic set, delete the current default set and use the Rename-NetIPsecMainModeCryptoSet cmdlet to specify the default set with {E5A5D32A-4BCE-4e4d-B07F-4AB1BA7E5FE1}.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Description <String>

Specifies that matching firewall rules of the indicated description are created. Wildcard characters are accepted. This parameter provides information about the firewall rule. This parameter specifies the localized, user-facing description of the IPsec rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DisplayName <String>

Specifies that only matching firewall rules of the indicated display name are created. Wildcard characters are accepted. Specifies the localized, user-facing name of the firewall rule being created. 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 set to All.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ForceDiffieHellman <Boolean>

Indicates that matching main mode cryptographic sets of the indicated value are created. If this parameter is set to True, then IPsec uses Diffie-Hellman exchanges to protect the main mode key exchange when AuthIP is used. AuthIP is specified by KeyModule. This provides stronger security for the key exchange. The default value is False.

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 created. This parameter is used in the same way as the PolicyStore parameter. When modifying 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 firewall rules of the indicated group association are created. 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-NetFirewallRule cmdlets, 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 value with a universal and world-ready indirect @FirewallAPI name. Note: The DisplayGroup parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxMinutes <UInt32>

Specifies that matching main mode cryptographic sets of the indicated maximum lifetime, in minutes, are created. This parameter specifies the number of minutes established for a main mode security association before it expires and must be renegotiated. The acceptable values for this parameter are:  0 through 2879. -- A non-zero value specifies the desired minute lifetime. -- NotConfigured: Valid only when configuring a GPO. Removes the setting from the GPO, which results in the policy not changing the value on the computer when the policy is applied. The default value is 4800 minutes (eight hours). When managing a GPO, the default setting is NotConfigured.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxSessions <UInt32>

Specifies that matching main mode cryptographic sets of the indicated maximum lifetime, in sessions, are created. This parameter specifies the number of sessions established for a main mode security association before it expires and must be renegotiated. The acceptable values for this parameter are:  0 to 2147483647. -- A value of zero (0) specifies that there should be no maximum session lifetime. -- A non-zero value specifies the desired session number. -- NotConfigured: Valid only when configuring a GPO. Removes the setting from the GPO, which results in the policy not changing the value on the computer when the policy is applied. The default value is zero (0) sessions. When managing a GPO, the default setting is NotConfigured.

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 cryptographic sets of the indicated name are created. 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 the same name in a higher-precedence GPO, then it overrides other rules that exist. The default value is a randomly assigned value. When you want to override the defaults for main mode encryption, specify the customized parameters and set this parameter, making this parameter the new default setting for encryption.

Aliases

ID

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 sets to be created. 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). ---- 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_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: Use the Any keyword to configure the profile as Private, Public, Domain in this store. Note: The Set-NetIPsecMainModeCryptoSet 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 the Copy-NetIPsecMainModeCryptoSet cmdlet or with the New-NetIPsecMainModeCryptoSet cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Proposal <CimInstance[]>

Associates the specified cryptographic proposal to the corresponding cryptographic set to be used in main mode negotiations. Separate multiple entries with a comma.

Aliases

None

Required?

true

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetIPsec
Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\AssociatedNetIPsecMainModeCryptoSet

Notes

None

Examples

EXAMPLE 1

This example creates a main mode rule linked to a cryptographic set that contains three cryptographic proposals.

PS C:\>$proposal1 = (New-NetIPsecMainModeCryptoProposal -Encryption DES3 -Hash MD5 -KeyExchange DH1)



PS C:\>$proposal2 = (New-NetIPsecMainModeCryptoProposal -Encryption AES192 -Hash MD5 -KeyExchange DH14)



PS C:\>$proposal3 = (New-NetIPsecMainModeCryptoProposal -Encryption DES3 -Hash MD5 -KeyExchange DH19)



PS C:\>$mmCryptoSet = New-NetIPsecMainModeCryptoSet -DisplayName "Main Mode Crypto Set" -Proposal $proposal1, $proposal2, $proposal3



PS C:\>New-NetIPsecMainModeRule -DisplayName "Main Mode Rule" -MainModeCryptoSet $mmCryptoSet.Name

EXAMPLE 2

This example creates a cryptographic set that contains four cryptographic proposals and makes this the default main mode setting to be used with all network IPsec rules.

PS C:\>$dES3MD5DH1 = New-NetIPsecMainModeCryptoProposal -Encryption DES3 -Hash MD5 -KeyExchange DH1



PS C:\>$aES192MD5DH14 = New-NetIPsecMainModeCryptoProposal -Encryption AES192 -Hash MD5 -KeyExchange DH14



PS C:\>$dES3MD5DH19 = New-NetIPsecMainModeCryptoProposal -Encryption DES3 -Hash MD5 -KeyExchange DH19



PS C:\>New-NetIPsecMainModeCryptoSet -DisplayName "Default Main Mode Crypto Set" -Proposal $dES3MD5DH1, $aES192MD5DH14, $dES3MD5DH19 -Default

Online Version
New-NetFirewallRule
New-NetIPsecMainModeCryptoSet
New-NetIPsecMainModeRule
Open-NetGPO
Rename-NetIPsecMainModeCryptoSet
Save-NetGPO
Set-NetFirewallRule
Set-NetIPsecMainModeCryptoSet
New-NetIPsecMainModeCryptoProposal
New-GPO