Set-NetIPsecPhase1AuthSet

Module:

NetSecurity

Modifies existing phase 1 authentication sets.

Syntax

Set-NetIPsecPhase1AuthSet
   [-Name] <String[]>
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [-NewDisplayName <String>]
   [-Description <String>]
   [-Proposal <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetIPsecPhase1AuthSet
   -DisplayName <String[]>
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [-NewDisplayName <String>]
   [-Description <String>]
   [-Proposal <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetIPsecPhase1AuthSet
   -DisplayGroup <String[]>
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [-NewDisplayName <String>]
   [-Description <String>]
   [-Proposal <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetIPsecPhase1AuthSet
   -Group <String[]>
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [-NewDisplayName <String>]
   [-Description <String>]
   [-Proposal <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetIPsecPhase1AuthSet
   -InputObject <CimInstance[]>
   [-NewDisplayName <String>]
   [-Description <String>]
   [-Proposal <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetIPsecPhase2AuthSet cmdlet modifies cryptographic set properties of existing main mode cryptographic sets.

This cmdlet returns one or more phase 1 authentication sets to be modified with the Name (default), DisplayName or by association using the DisplayGroup, or Group cmdlet. The sets cannot be queried by property in this cmdlet. The Get-NetIPsecPhase1AuthSet cmdlet returns queried rules and pipes the rules into this cmdlet. The remaining parameters specify the properties of this cmdlet to be modified. When a group is specified, all of the sets associated with the group receive the same modifications. The rule parameters modified using the dot-notation are committed with this cmdlet.

To move a set to a new GPO, copy the existing set by running the Copy-NetIPsecPhase1AuthSet cmdlet with the NewPolicyStore parameter, then remove the old set by running the Remove-NetIPsecPhase1AuthSet cmdlet.

Examples

EXAMPLE 1

PS C:\>$NewCertProposal = New-NetIPsecAuthProposal -Machine -Cert -Authority "C=US,O=MSFT,CN=Microsoft Root Authority" -AuthorityType Root



PS C:\>Set-NetIPsecPhase1AuthSet -DisplayName "Authenticate with Certificates" -Proposal $NewCertProposal

This example replaces the proposals for an existing authentication set.

EXAMPLE 2

PS C:\>Set-NetIPsecPhase1AuthSet -DisplayGroup "Authenticate with Certificates" -NewDisplayName "Authenticate with Computer Certificates"

This example modifies the display name of a phase 1 authentication set.

Parameters

-AsJob

ps_cimcommon_asjob

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:	CimSession[]
Aliases:	Session
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies that matching phase 1 authentication sets of the indicated description are modified. Wildcard characters are accepted.

This parameter provides information about the phase 1 authentication rule. This parameter specifies a localized, user-facing description of the object.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayGroup

Specifies that only matching phase 1 authentication sets of the indicated group association are modified. 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 this cmdlet, if the group name is specified for a set of rules, then all of the rules 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-NetIPsecPhase1AuthSet cmdlet, but can be modified using dot notation and this cmdlet.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

Specifies that only matching phase 1 authentication sets of the indicated display name are modified. Wildcard characters are accepted.

This parameter specifies the localized, user-facing name of the phase 1 authentication set being created. When creating a set 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 value cannot be All.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-GPOSession

Specifies the network GPO from which to retrieve the sets to be modified.

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Group

Specifies that only matching phase 1 authentication sets of the indicated group association are modified. 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 organizes rules by influence and allows batch rule modifications. Using this cmdlet, if the group name is specified for a set of rules, then all of the rules 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-NetIPsecPhase1AuthSet cmdlet, but can be modified using dot notation and this cmdlet.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	CimInstance[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies that only matching phase 1 authentication sets of the indicated name are modified. 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 phase 1 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
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NewDisplayName

Specifies the new display name for an IPsec rule.

Type:	String
Position:	Named
Default value:	None
Required:	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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PolicyStore

Specifies the policy store from which to retrieve the sets to be modified.

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 Server 2012. 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: This 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 New-NetIPsecPhase1AuthSet cmdlet or with the Copy-NetIPsecPhase1AuthSet cmdlet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Proposal

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

Type:	CimInstance[]
Position:	Named
Default value:	None
Required:	False
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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

CimInstance[]

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

CimInstance[]

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.

Related Links

• Copy-NetIPsecPhase1AuthSet
• Get-NetIPsecPhase1AuthSet
• New-NetIPsecPhase1AuthSet
• Open-NetGPO
• Save-NetGPO
• Remove-NetIPsecPhase1AuthSet
• New-GPO