Rename-NetFirewallRule

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

SYNOPSIS

Renames a single IPsec rule.

SYNTAX

Rename-NetFirewallRule [-Action <Action[]>] [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-Description <String[]>] [-Direction
<Direction[]>] [-DisplayGroup <String[]>] [-EdgeTraversalPolicy <EdgeTraversal[]>] [-Enabled <Enabled[]>] [-GPOSession <String>] [-Group
<String[]>] [-LocalOnlyMapping <Boolean[]>] [-LooseSourceMapping <Boolean[]>] [-Owner <String[]>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-PolicyStoreSource <String[]>] [-PolicyStoreSourceType <PolicyStoreType[]>] [-PrimaryStatus <PrimaryStatus[]>]
[-Status <String[]>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String> [-Confirm [<SwitchParameter>]]
[-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-All [<SwitchParameter>]] [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru
[<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String> [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallProfile <CimInstance> -NewName
<String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-Name] <String[]> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru
[<SwitchParameter>]] [-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -NewName <String> [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallPortFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -DisplayName <String[]> -NewName <String> [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-PassThru [<SwitchParameter>]] [-ThrottleLimit <Int32>]
-InputObject <CimInstance[]> -NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallServiceFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallSecurityFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallInterfaceTypeFilter
<CimInstance> -NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallInterfaceFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallApplicationFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Rename-NetFirewallRule [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PassThru [<SwitchParameter>]]
[-PolicyStore <String>] [-ThrottleLimit <Int32>] [-TracePolicyStore [<SwitchParameter>]] -AssociatedNetFirewallAddressFilter <CimInstance>
-NewName <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Search powershellhelp.space

DESCRIPTION

The Rename-NetFirewallRule cmdlet renames an existing firewall 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 newly specified name, using the NewName parameter,
must still be unique since it identifies a single rule object on the computer.


This cmdlet gets one or more firewall rules to be renamed with the Name parameter (default), the DisplayName parameter, rule properties, or by
associated filters or objects. The Name parameter value for the resulting query is replaced by the specified 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, as specified by the NewName parameter.


To modify the localized DisplayName parameter, run the Set-NetFirewallRule 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. This can be used to create overlapping policies, where the same
rule is placed in multiple GPOs, and if they 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 the rules perform the same function. For instance, if the built-in local
firewall rules (like Core Networking, or File & Printer Sharing rules) are copied to a domain GPO, then the 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

Copy-NetFirewallRule
Disable-NetFirewallRule
Enable-NetFirewallRule
Get-NetFirewallAddressFilter
Get-NetFirewallApplicationFilter
Get-NetFirewallInterfaceFilter
Get-NetFirewallInterfaceTypeFilter
Get-NetFirewallPortFilter
Get-NetFirewallProfile
Get-NetFirewallSecurityFilter
Get-NetFirewallServiceFilter
Get-NetFirewallRule
New-NetFirewallRule
Open-NetGPO
Remove-NetFirewallRule
Save-NetGPO
Set-NetFirewallRule
Show-NetFirewallRule
New-GPO

REMARKS

<

Examples