Remove-NetIPsecPhase2AuthSet

Remove-NetIPsecPhase2AuthSet

Deletes all of the phase 2 authentication sets that match the specified criteria.

構文

Parameter Set: ByAssociatedNetIPsecRule
Remove-NetIPsecPhase2AuthSet -AssociatedNetIPsecRule <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByDisplayName
Remove-NetIPsecPhase2AuthSet -DisplayName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByName
Remove-NetIPsecPhase2AuthSet [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByQuery
Remove-NetIPsecPhase2AuthSet [-AsJob] [-CimSession <CimSession[]> ] [-Description <String[]> ] [-DisplayGroup <String[]> ] [-GPOSession <String> ] [-Group <String[]> ] [-PassThru] [-PolicyStore <String> ] [-PolicyStoreSource <String[]> ] [-PolicyStoreSourceType <PolicyStoreType[]> ] [-PrimaryStatus <PrimaryStatus[]> ] [-Status <String[]> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: GetAll
Remove-NetIPsecPhase2AuthSet [-All] [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-TracePolicyStore] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetIPsecPhase2AuthSet -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Remove-NetIPsecPhase2AuthSet cmdlet permanently deletes one or more phase 2 authentication sets from the specified policy store.

This cmdlet gets one or more authorization sets to be deleted with the Name parameter (default), the DisplayName parameter, the Group parameter, or by associated IPsec rule. The resulting queried set is deleted from the computer.

パラメーター

-All

Indicates that all of the phase 2 authentication sets within the specified policy store are removed.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-AsJob

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-AssociatedNetIPsecRule<CimInstance>

Gets the phase 2 authentication sets that are associated, via the pipeline, with the input IPsec rule to be removed.
A NetIPsecRule object represents an IPsec rule, which determines IPsec behavior. An IPsec rule can be associated with Phase1AuthSet, Phase2AuthSet, and NetIPsecQuickMode cryptographic sets. See the New-NetIPsecMainModeRule cmdlet for more information.

エイリアス	なし
必須?	true
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

エイリアス	Session
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Description<String[]>

Specifies that matching phase 2 authentication sets of the indicated description are removed. Wildcard characters are accepted.
This parameter provides information about the phase 2 authentication rule. This parameter specifies a localized, user-facing description of the object.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-DisplayGroup<String[]>

Specifies that only matching phase 2 authentication sets of the indicated group association are removed. Wildcard characters are accepted.
The Group parameter specifies the source string for this parameter. If the value for this parameter is a localizable string, then the Group parameter contains an indirect string. Rule groups can be used to organize rules by influence and allows batch rule modifications. Using the Set-NetIPsecPhase2AuthSet cmdlet, if the group name is specified for a set of rules, then all of the rules in that group receive the same set of modifications. It is good practice to specify the Group parameter with a universal and world-ready indirect @FirewallAPI name.
Note: This parameter cannot be specified upon object creation using the New-NetIPsecPhase2AuthSet cmdlet, but can be modified using dot notation and the Set-NetIPsecPhase2AuthSet cmdlet.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-DisplayName<String[]>

Specifies that only matching phase 2 authentication sets of the indicated display name are removed. Wildcard characters are accepted.
This parameter specifies the localized, user-facing name of the phase 2 authentication set being created. When creating a set this parameter is required. This parameter value is locale-dependent. If the object is not modified, this parameter value may change in certain circumstances. When writing scripts in multi-lingual environments, the Name parameter should be used instead, where the default value is a randomly assigned value.
Note: This parameter value cannot be All.

エイリアス	なし
必須?	true
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-GPOSession<String>

Specifies the network GPO from which to retrieve the sets to be removed.
This parameter is used in the same way as the PolicyStore parameter. When modifying Group Policy objects (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.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Group<String[]>

Specifies that only matching phase 2 authentication sets of the indicated group association are removed. Wildcard characters are accepted.
This parameter specifies the source string for the DisplayGroup parameter. If the DisplayGroup parameter value is a localizable string, then this parameter contains an indirect string. Rule groups organizes rules by influence and allows batch rule modifications. Using the Set-NetIPsecPhase2AuthSet cmdlet, if the group name is specified for a set of rules, then all of the rules in that group receive the same set of modifications. It is a good practice to specify this parameter with a universal and world-ready indirect @FirewallAPI name.
Note: The DisplayGroup parameter cannot be specified upon object creation using the New-NetIPsecPhase2AuthSet cmdlet, but can be modified using dot notation and the Set-NetIPsecPhase2AuthSet cmdlet.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

エイリアス	なし
必須?	true
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Name<String[]>

Specifies that only matching phase 2 authentication sets of the indicated name are removed. Wildcard characters are accepted.
This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. During group policy processing and policy merge, rules that have the same name but come from multiple stores being merged, will overwrite one another so that only one exists. This overwriting behavior is desirable if the rules serve the same purpose. For instance, all of the firewall rules have specific names, so if an administrator can copy these rules to a GPO, and the rules will override the local versions on a local computer. Since GPOs can have precedence, if an administrator gives a rule with a different or more specific rule the same name in a higher-precedence GPO, then it overrides other rules that exist.
The default value is a randomly assigned value.
When the defaults for phase 2 encryption are overridden, specify the customized parameters and set this parameter value, making this parameter the new default setting for encryption.

エイリアス	ID
必須?	true
位置は?	1
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PolicyStore<String>

Specifies the policy store from which to retrieve the sets to be removed.
A policy store is a container for firewall and IPsec policy.
このパラメーターに対して使用できる値:
-- 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).
---- Group Policy Objects (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_Namedomain.fqdn.comGPO_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-NetIPsecPhase2AuthSet 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-NetIPsecPhase2AuthSet cmdlet or with the New-NetIPsecPhase2AuthSet cmdlet.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PolicyStoreSource<String[]>

Specifies that phase 2 authentication sets that match the indicated policy store source are removed.
This parameter contains a path to the policy store where the rule originated if the object is retrieved from the ActiveStore with the TracePolicyStoreSource option set. This parameter value is automatically generated and should not be modified.
The monitoring output from this parameter is not completely compatible with the PolicyStore parameter. This parameter value cannot always be passed into the PolicyStore parameter. Domain GPOs are one example in which this parameter contains only the GPO name, not the domain name.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PolicyStoreSourceType<PolicyStoreType[]>

Specifies that phase 2 authentication sets that match the indicated policy store source type are removed.
This parameter describes the type of policy store where the rule originated if the object is retrieved from the ActiveStore with the TracePolicyStoreSource option set. This parameter value is automatically generated and should not be modified.
このパラメーターに対して使用できる値:
-- Local: The object originates from the local store.
-- GroupPolicy: The object originates from a GPO.
-- Dynamic: The object originates from the local runtime state. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.
-- Generated: The object was generated automatically. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.
-- Hardcoded: The object was hard-coded. This policy store name is not valid for use in the cmdlets, but may appear when monitoring active policy.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PrimaryStatus<PrimaryStatus[]>

Specifies that phase 2 authentication sets that match the indicated primary status are removed.
This parameter describes the overall status of the rule.
-- OK: Specifies that the rule will work as specified.
-- Degraded: Specifies that one or more parts of the rule will not be enforced.
-- Error: Specifies that the computer is unable to use the rule at all.
See the Status and StatusCode fields of the object for more detailed status information.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Status<String[]>

Specifies that phase 2 authentication sets that match the indicated status are removed.
This parameter describes the status message for the specified status code value. The status code is a numerical value that indicates any syntax, parsing, or run-time errors in the rule. This parameter value should not be modified.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-TracePolicyStore

Indicates that the phase 2 authentication sets that match the indicated policy store are removed.
This parameter specifies that the name of the source GPO is queried and set to the PolicyStoreSource parameter value.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetConSecRule[]

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIKEP2AuthSet[]

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• None

例

EXAMPLE 1

This example removes all of the static local phase 1 authentication sets. This cmdlet is useful for removing any policy that conflicts with the domain GPO.

PS C:\> Remove-NetIPsecPhase2AuthSet

EXAMPLE 2

This example deletes a set based on the localized name.

PS C:\> Remove-NetIPsecPhase2AuthSet -DisplayName "Home LAN - Phase 2 Auth Set"

EXAMPLE 3

This example removes all of the phase 2 authentication sets that are associated with an IPsec rule.

PS C:\> $ipsRule = Get-NetIPsecRule –DisplayName "Transport Mode - Extranet IPv4"

PS C:\> Remove-NetIPsecPhase2AuthSet –InputObject $ipsRule

関連トピック

Get-NetIPsecRule

New-NetIPsecMainModeRule

New-NetIPsecPhase2AuthSet

Open-NetGPO

Save-NetGPO

Set-NetIPsecPhase2AuthSet

New-GPO