PowerShell Logo Small

Rename-NetIPsecRule



This is the built-in help made by Microsoft for the command 'Rename-NetIPsecRule', 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 IPsec rule.

SYNTAX


Rename-NetIPsecRule [-All] [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AllowSetKey <Boolean[]>] [-AllowWatchKey <Boolean[]>] [-AsJob] [-CimSession <CimSession[]>] [-Description <String[]>] [-DisplayGroup <String[]>]
[-Enabled <Enabled[]>] [-EncryptedTunnelBypass <Boolean[]>] [-ForwardPathLifetime <UInt32[]>] [-GPOSession <String>] [-Group <String[]>] [-InboundSecurity
<SecurityPolicy[]>] [-KeyModule <KeyModule[]>] [-Machine <String[]>] [-Mode <IPsecMode[]>] [-OutboundSecurity <SecurityPolicy[]>] [-PassThru] [-Phase1AuthSet <String[]>]
[-Phase2AuthSet <String[]>] [-PolicyStore <String>] [-PolicyStoreSource <String[]>] [-PolicyStoreSourceType <PolicyStoreType[]>] [-PrimaryStatus <PrimaryStatus[]>]
[-QuickModeCryptoSet <String[]>] [-RemoteTunnelHostname <String[]>] [-RequireAuthorization <Boolean[]>] [-Status <String[]>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
[-User <String[]>] -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-IPsecRuleName] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>]
[-TracePolicyStore] -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject <CimInstance[]> -NewName <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetIPsecQuickModeCryptoSet <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetIPsecPhase1AuthSet <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetIPsecPhase2AuthSet <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetFirewallProfile <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetFirewallPortFilter <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetFirewallInterfaceTypeFilter <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetFirewallInterfaceFilter <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-AssociatedNetFirewallAddressFilter <CimInstance> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore]
-DisplayName <String[]> -NewName <String> [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Rename-NetIPsecRule cmdlet renames an existing IPsec rule. When creating a rule, if the IPsecRuleName parameter is not specified, then a randomly generated value is
used. This cmdlet specifies a friendlier and more descriptive rule name. Note: The NewName parameter value must still be unique since it identifies a single rule object on
the computer.


This cmdlet get one or more IPsec rules to be renamed with the IPsecRuleName parameter (default), the DisplayName parameter, rule properties, or by associated filters or
objects. The IPsecRuleName parameter for the queried rule is replaced by the NewName parameter value. Note: Only one IPsec rule can be renamed at a time when copying to the
same policy store. This is because only a single IPsec rule can use the unique identifier, or name, specified by the NewName parameter.


To modify the localized the DisplayName parameter, run the Set-NetIPsecRule 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
rule 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 the rules are both 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 they perform the same function. If the
built-in local firewall rules, such as Core Networking or File & Printer Sharing rules, are copied into a domain GPO, then the domain GPO rules will override any local
versions of those rules. However, if different GPOs specify different scopes with the same rule names, then the rules will become much harder to effectively manage.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=288208
Copy-NetIPsecRule
Disable-NetIPsecRule
Get-NetFirewallAddressFilter
Get-NetFirewallInterfaceFilter
Get-NetFirewallInterfaceTypeFilter
Get-NetFirewallPortFilter
Get-NetFirewallProfile
Get-NetIPsecPhase1AuthSet
Get-NetIPsecPhase2AuthSet
Get-NetIPsecRule
New-NetIPsecRule
Open-NetGPO
Save-NetGPO
Set-NetIPsecRule
New-GPO

REMARKS

<

Examples


EXAMPLE 1

PS C:\>Rename-NetIPsecRule –IPsecRuleName "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "SecureNet - Exempt Servers"



This example renames an IPsec rule so that the identifier is descriptive and user friendly.