PowerShell Logo Small

Rename-NetIPsecPhase1AuthSet



This is the built-in help made by Microsoft for the command 'Rename-NetIPsecPhase1AuthSet', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Renames a single phase 1 authentication set.

SYNTAX


Rename-NetIPsecPhase1AuthSet [-All] [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>]
[-TracePolicyStore] -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetIPsecRule <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-AsJob] [-CimSession <CimSession[]>] [-Description <String[]>] [-DisplayGroup <String[]>] [-GPOSession <String>] [-Group <String[]>]
[-PassThru] [-PolicyStore <String>] [-PolicyStoreSource <String[]>] [-PolicyStoreSourceType <PolicyStoreType[]>] [-PrimaryStatus <PrimaryStatus[]>] [-Status <String[]>]
[-ThrottleLimit <Int32>] [-TracePolicyStore] -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-DisplayName <String[]> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetIPsecMainModeRule <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject <CimInstance[]> -NewName <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Rename-NetIPsecPhase1AuthSet [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>]
[-TracePolicyStore] -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Rename-NetIPsecPhase1AuthSet cmdlet renames an existing phase 1 authentication set. When creating a set, if the Name parameter is not specified, then a random GUID is
used. This cmdlet specifies a friendly and descriptive rule name. Note: The newly specified name, using the NewName parameter, must still be unique since it identifies a
single rule object on the computer.


This cmdlet returns one or more phase 1 authentication sets to be renamed with the Name parameter (default), the DisplayName parameter, set properties, or by associated
filters or objects. The Name parameter value from the queried set is replaced by the NewName parameter value. Note: Only one set can be renamed at a time when copying to the
same policy store. This is because only a single set can use the unique identifier, or name, specified by the NewName parameter.


To modify the localized DisplayName parameter, run the Set-NetIPsecPhase1AuthSet cmdlet with the NewDisplayName parameter.


The names are unique identifiers for rules, similar to file names. Each name must be unique within a given policy store. If rules in multiple GPOs have the same name, then
one will overwrite the other based upon GPO precedence. If a rule from a GPO has the same name as a rule from the PersistentStore, then the rule from the GPO will overwrite
the local rule.


To specify a new default phase 1 authentication set, run this cmdlet to specify the default set with Name parameter value {E5A5D32A-4BCE-4e4d-B07F-4AB1BA7E5FE1}.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=288205
Copy-NetIPsecPhase1AuthSet
Get-NetIPsecMainModeRule
Get-NetIPsecRule
New-NetIPsecMainModeRule
New-NetIPsecPhase1AuthSet
Open-NetGPO
Save-NetGPO
Remove-NetIPsecQuickModeCryptoSet
Set-NetIPsecPhase1AuthSet
New-GPO

REMARKS

<

Examples


EXAMPLE 1

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



This example renames a phase 1 authorization set so that the unique identifier is descriptive and user friendly.