This is the built-in help made by Microsoft for the command 'Rename-NetIPsecMainModeCryptoSet', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 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.
Renames a single main mode cryptographic set.
Rename-NetIPsecMainModeCryptoSet [-All [<SwitchParameter>]] [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>]
[-PassThru [<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String>
[-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeCryptoSet [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-Description <String[]>] [-DisplayGroup
<String[]>] [-ForceDiffieHellman <Boolean[]>] [-GPOSession <String>] [-Group <String[]>] [-MaxMinutes <UInt32[]>] [-MaxSessions <UInt32[]>]
[-PassThru [<SwitchParameter>]] [-PolicyStore <String>] [-PolicyStoreSource <String[]>] [-PolicyStoreSourceType <PolicyStoreType[]>]
[-PrimaryStatus <PrimaryStatus[]>] [-Status <String[]>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String>
[-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeCryptoSet [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru
[<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetIPsecMainModeRule
<CimInstance> -NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeCryptoSet [-Name] <String[]> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>]
[-PassThru [<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String>
[-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeCryptoSet [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru
[<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -DisplayName <String[]> -NewName
<String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeCryptoSet [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-PassThru [<SwitchParameter>]] [-ThrottleLimit
<Int32>] -InputObject <CimInstance[]> -NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
The Rename-NetIPsecMainModeCryptoSet cmdlet renames an existing main mode cryptographic set. When creating a set, if the Name parameter is not
specified, then a randomly generated value is used. This cmdlet allows the user to specify a friendly and descriptive set name. Note: The
NewName parameter value must be unique since it identifies a single set object on the computer.
This cmdlet gets one or more main mode cryptographic sets to be renamed with the Name parameter (default), the DisplayName parameter, set
properties, or by the associated filters or objects. The Name parameter for the resulting 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-NetIPsecMainModeCryptoSet 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 main mode cryptographic set, run this cmdlet to specify the default set with the Name parameter value set to
{E5A5D32A-4BCE-4e4d-B07F-4AB1BA7E5FE1}.
<
Copy-NetIPsecMainModeCryptoSet
Get-NetIPsecMainModeRule
New-NetIPsecMainModeCryptoSet
Set-NetIPsecMainModeCryptoSet
New-GPO
<
EXAMPLE 1
PS C:\> 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.