This is the built-in help made by Microsoft for the command 'Rename-NetIPsecMainModeRule', 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 rule.
Rename-NetIPsecMainModeRule [-All [<SwitchParameter>]] [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>]
[-PassThru [<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String>
[-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-PassThru [<SwitchParameter>]] [-ThrottleLimit <Int32>]
-InputObject <CimInstance[]> -NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallAddressFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -DisplayName <String[]> -NewName <String> [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-Name] <String[]> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru
[<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String> [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetIPsecMainModeCryptoSet <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetIPsecPhase1AuthSet <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallProfile <CimInstance> -NewName
<String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetIPsecMainModeRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-Description <String[]>] [-DisplayGroup <String[]>]
[-Enabled <Enabled[]>] [-GPOSession <String>] [-Group <String[]>] [-MainModeCryptoSet <String[]>] [-PassThru [<SwitchParameter>]]
[-Phase1AuthSet <String[]>] [-PolicyStore <String>] [-PolicyStoreSource <String[]>] [-PolicyStoreSourceType <PolicyStoreType[]>]
[-PrimaryStatus <PrimaryStatus[]>] [-Status <String[]>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String>
[-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
The Rename-NetIPsecMainModeRule cmdlet renames a main mode rule. When creating a rule, if the Name parameter is not specified, then a random
GUID is used. This cmdlet specifies a friendly and descriptive rule name. Note: The NewName parameter value must be unique since it identifies
a single rule object on the computer.
This cmdlet gets a main mode rule to be renamed with the Name parameter (default), the DisplayName parameter, rule properties, or by
associated filters or objects. The Name parameter from the queried rule is replaced by the NewName parameter value. Note: Only one firewall
can be renamed at a time when copying to the same policy store. This is because only a single firewall can use the unique identifier, or name,
specified by the NewName parameter.
To modify the localized DisplayName parameter, run the Set-NetIPsecMainModeRule cmdlet with the NewDisplayName parameter.
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 of the GPOs will overwrite the other based upon GPO precedence. If a rule from a GPO has the same name as a rule
from the persistent store, then the rule from the GPO will overwrite the local rule. This can be used to create overlapping policies, where
the same rule is placed in multiple GPOs, and if both rules are applied to a computer, then the overlapping parts of the policies will only be
created once. For this reason, two rules should only have the same name if the same function is to be performed. For instance, if the built-in
local firewall rules, such as Core Networking or File & Printer Sharing rules, are copied to a domain GPO, then any local versions of those
rules are overridden. However, if different GPOs specify different scopes with the same rule names, then the GPOs will become much harder to
effectively manage.
<
Copy-NetIPsecMainModeRule
Disable-NetIPsecMainModeRule
Get-NetFirewallAddressFilter
Get-NetFirewallProfile
Get-NetIPsecMainModeCryptoSet
Get-NetIPsecPhase1AuthSet
New-NetIPsecMainModeRule
Open-NetGPO
Save-NetGPO
Set-NetIPsecMainModeRule
New-NetIPsecAuthProposal
New-GPO
<
EXAMPLE 1
PS C:\> Rename-NetIPsecMainModeRule –Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "Tunnel Mode - Americas (DA Client)"
This example renames a main mode rule so that the identifier is descriptive and user friendly.