< Back
Show-NetIPsecRule
Post
NAME Show-NetIPsecRule
SYNOPSIS
Displays all of the existing IPsec rules and associated objects in a fully expanded view.
SYNTAX
Show-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PolicyStore <String>] [-ThrottleLimit <Int32>]
[<CommonParameters>]
DESCRIPTION
The Show-NetIPsecRule cmdlet displays each of the IPsec rules in the required policy store, along with the associated objects, in a clear and
formatted list.
The ActiveStore is a collection of all of the policy stores that apply to the computer so the majority of the rules output by this cmdlet using
the PolicyStore parameter value set to ActiveStore are read-only when run on a client computer.
PARAMETERS
-AsJob [<SwitchParameter>]
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the
session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell???? background jobs, see about_Jobs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CimSession <CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession
or Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GPOSession <String>
Specifies the network GPO from which to retrieve the rules to be displayed.
This parameter is used in the same way as the PolicyStore parameter. When modifying GPOs in Windows PowerShell????, each change to a GPO requires
the entire GPO to be loaded, modified, and saved back. On a busy Domain Controller (DC), this can be a slow and resource-heavy operation. A
GPO Session loads a domain GPO onto the local computer and makes all changes in a batch, before saving it back. This reduces the load on the
DC and speeds up the Windows PowerShell cmdlets. To load a GPO Session, use the Open-NetGPO cmdlet. To save a GPO Session, use the Save-NetGPO
cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PolicyStore <String>
Specifies the policy store from which to retrieve the rules to be displayed.
A policy store is a container for firewall and IPsec policy.
The acceptable values for this parameter are:??
-- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. This policy is not from
GPOs, and has been created manually or programmatically (during application installation) on the computer. Rules created in this store are
attached to the ActiveStore and activated on the computer immediately.
-- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. This is
the resultant set of policy (RSOP) for the local computer (the sum of all GPOs that apply to the computer), and the local stores (the
PersistentStore, the static Windows service hardening (WSH), and the configurable WSH).
---- GPOs are also policy stores. Computer GPOs can be specified as follows.
------ ????????PolicyStore hostname.
---- Active Directory GPOs can be specified as follows.
------ ????????PolicyStore domain.fqdn.com\\GPO_Friendly_Name.
------ Such as the following.
-------- -PolicyStore localhost
-------- -PolicyStore corp.contoso.com\\FirewallPolicy
---- Active Directory GPOs can be created using the New-GPO cmdlet or the Group Policy Management Console.
-- RSOP: This read-only store contains the sum of all GPOs applied to the local computer.
-- SystemDefaults: This read-only store contains the default state of firewall rules that ship with Windows Server???? 2012.
-- StaticServiceStore: This read-only store contains all the service restrictions that ship with Windows Server 2012. Optional and
product-dependent features are considered part of Windows Server 2012 for the purposes of WFAS.
-- ConfigurableServiceStore: This read-write store contains all the service restrictions that are added for third-party services. In
addition, network isolation rules that are created for Windows Store application containers will appear in this policy store.
The default value is PersistentStore.
Note: The Set-NetIPsecRule cmdlet cannot be used to add an object to a policy store. An object can only be added to a policy store at creation
time with the Copy-NetIPsecRule cmdlet or with the New-NetIPsecRule cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit <Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0
is entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running
on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#root\\StandardCimv2\\MSFT_NetConSecRule[]
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
EXAMPLE 1
PS C:\\>Show-NetIPsecRule ????????PolicyStore ActiveStore
This example displays all of the IPsec rules currently in the active policy, which is a collection of all of the policy stores that apply to the
computer.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=288377
Copy-NetIPsecRule
Disable-NetIPsecRule
Enable-NetIPsecRule
Get-NetIPsecRule
New-NetIPsecRule
Open-NetGPO
Remove-NetIPsecRule
Rename-NetIPsecRule
Save-NetGPO
Set-NetIPsecRule
New-GPO
SYNOPSIS
Displays all of the existing IPsec rules and associated objects in a fully expanded view.
SYNTAX
Show-NetIPsecRule [-AsJob] [-CimSession <CimSession[]>] [-GPOSession <String>] [-PolicyStore <String>] [-ThrottleLimit <Int32>]
[<CommonParameters>]
DESCRIPTION
The Show-NetIPsecRule cmdlet displays each of the IPsec rules in the required policy store, along with the associated objects, in a clear and
formatted list.
The ActiveStore is a collection of all of the policy stores that apply to the computer so the majority of the rules output by this cmdlet using
the PolicyStore parameter value set to ActiveStore are read-only when run on a client computer.
PARAMETERS
-AsJob [<SwitchParameter>]
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the
session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell???? background jobs, see about_Jobs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CimSession <CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession
or Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GPOSession <String>
Specifies the network GPO from which to retrieve the rules to be displayed.
This parameter is used in the same way as the PolicyStore parameter. When modifying GPOs in Windows PowerShell????, each change to a GPO requires
the entire GPO to be loaded, modified, and saved back. On a busy Domain Controller (DC), this can be a slow and resource-heavy operation. A
GPO Session loads a domain GPO onto the local computer and makes all changes in a batch, before saving it back. This reduces the load on the
DC and speeds up the Windows PowerShell cmdlets. To load a GPO Session, use the Open-NetGPO cmdlet. To save a GPO Session, use the Save-NetGPO
cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PolicyStore <String>
Specifies the policy store from which to retrieve the rules to be displayed.
A policy store is a container for firewall and IPsec policy.
The acceptable values for this parameter are:??
-- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. This policy is not from
GPOs, and has been created manually or programmatically (during application installation) on the computer. Rules created in this store are
attached to the ActiveStore and activated on the computer immediately.
-- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. This is
the resultant set of policy (RSOP) for the local computer (the sum of all GPOs that apply to the computer), and the local stores (the
PersistentStore, the static Windows service hardening (WSH), and the configurable WSH).
---- GPOs are also policy stores. Computer GPOs can be specified as follows.
------ ????????PolicyStore hostname.
---- Active Directory GPOs can be specified as follows.
------ ????????PolicyStore domain.fqdn.com\\GPO_Friendly_Name.
------ Such as the following.
-------- -PolicyStore localhost
-------- -PolicyStore corp.contoso.com\\FirewallPolicy
---- Active Directory GPOs can be created using the New-GPO cmdlet or the Group Policy Management Console.
-- RSOP: This read-only store contains the sum of all GPOs applied to the local computer.
-- SystemDefaults: This read-only store contains the default state of firewall rules that ship with Windows Server???? 2012.
-- StaticServiceStore: This read-only store contains all the service restrictions that ship with Windows Server 2012. Optional and
product-dependent features are considered part of Windows Server 2012 for the purposes of WFAS.
-- ConfigurableServiceStore: This read-write store contains all the service restrictions that are added for third-party services. In
addition, network isolation rules that are created for Windows Store application containers will appear in this policy store.
The default value is PersistentStore.
Note: The Set-NetIPsecRule cmdlet cannot be used to add an object to a policy store. An object can only be added to a policy store at creation
time with the Copy-NetIPsecRule cmdlet or with the New-NetIPsecRule cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit <Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0
is entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running
on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#root\\StandardCimv2\\MSFT_NetConSecRule[]
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
EXAMPLE 1
PS C:\\>Show-NetIPsecRule ????????PolicyStore ActiveStore
This example displays all of the IPsec rules currently in the active policy, which is a collection of all of the policy stores that apply to the
computer.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=288377
Copy-NetIPsecRule
Disable-NetIPsecRule
Enable-NetIPsecRule
Get-NetIPsecRule
New-NetIPsecRule
Open-NetGPO
Remove-NetIPsecRule
Rename-NetIPsecRule
Save-NetGPO
Set-NetIPsecRule
New-GPO