Get-NetIPsecPhase2AuthSet

Get-NetIPsecPhase2AuthSet

Gets a phase 2 authorization set from the target computer.

구문

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

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

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

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

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

자세한 설명

The Get-NetIPsecPhase2AuthSet cmdlet returns the instances of phase 2 authentication sets that match the search parameters from the user. See the New-NetIPsecPhase2AuthSet cmdlet for more information.

This cmdlet returns phase 2 authentication sets by specifying the Name parameter (default), the DisplayName parameter, rule properties, or by associated filters or objects. The queried rules can be placed into variables and piped to other cmdlets for further modifications or monitoring.

매개 변수

-All

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

-AsJob

-AssociatedNetIPsecRule<CimInstance>

Gets the phase 2 authentication sets that are associated, via the pipeline, with the input IPsec rule to be retrieved.
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.

-CimSession<CimSession[]>

원격 세션에서 또는 원격 컴퓨터에서 cmdlet을 실행합니다. New-CimSession 또는 Get-CimSession cmdlet의 출력과 같은 컴퓨터 이름이나 세션 개체를 입력합니다. 기본값은 로컬 컴퓨터의 현재 세션입니다.

-Description<String[]>

Specifies that matching phase 2 authentication sets of the indicated description are retrieved. 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.

-DisplayGroup<String[]>

Specifies that only matching phase 2 authentication sets of the indicated group association are retrieved. 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.

-DisplayName<String[]>

Specifies that only matching phase 2 authentication sets of the indicated display name are retrieved. 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.

-GPOSession<String>

Specifies the network Group Policy objects (GPO) from which to retrieve the sets to be retrieved.
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.

-Group<String[]>

Specifies that only matching phase 2 authentication sets of the indicated group association are retrieved. 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 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.

-Name<String[]>

Specifies that only matching phase 2 authentication sets of the indicated name are retrieved. 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 that 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.

-PolicyStore<String>

Specifies the policy store from which to retrieve the sets to be retrieved.
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).
- - 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.

-PolicyStoreSource<String[]>

Specifies that phase 2 authentication sets that match the indicated policy store source are retrieved.
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.

-PolicyStoreSourceType<PolicyStoreType[]>

Specifies that phase 2 authentication sets that match the indicated policy store source type are retrieved.
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 cmdlets, but may appear when monitoring active policy.
- Generated: The object was generated automatically. This policy store name is not valid for use in cmdlets, but may appear when monitoring active policy.
- Hardcoded: The object was hard-coded. This policy store name is not valid for use in cmdlets, but may appear when monitoring active policy.

-PrimaryStatus<PrimaryStatus[]>

Specifies that phase 2 authentication sets that match the indicated primary status are retrieved.
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.

-Status<String[]>

Specifies that phase 2 authentication sets that match the indicated status are retrieved.
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 runtime errors in the rule. This parameter value should not be modified.

-ThrottleLimit<Int32>

이 cmdlet을 실행하도록 설정할 수 있는 최대 동시 작업 수를 지정합니다. 이 매개 변수가 생략되거나 값 0이 입력되면 Windows PowerShell®은 컴퓨터에서 실행 중인 CIM cmdlet의 수에 따라 cmdlet에 대한 최적의 제한 한도를 계산합니다. 제한 한도는 현재 cmdlet에만 적용되며 세션이나 컴퓨터에는 적용되지 않습니다.

-TracePolicyStore

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

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

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

  Microsoft.Management.Infrastructure.CimInstance 개체는 WMI(Windows Management Instrumentation) 개체를 표시하는 래퍼 클래스입니다. 파운드 기호(#) 뒤에 오는 경로는 기본 WMI 개체의 네임스페이스 및 클래스 이름을 제공합니다.

출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

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

  Microsoft.Management.Infrastructure.CimInstance 개체는 WMI(Windows Management Instrumentation) 개체를 표시하는 래퍼 클래스입니다. 파운드 기호(#) 뒤에 오는 경로는 기본 WMI 개체의 네임스페이스 및 클래스 이름을 제공합니다.

예제

EXAMPLE 1

This example gets all phase 2 authentication sets currently in the active store. Running this cmdlet without specifying the policy store retrieves the persistent store.

PS C:\> Get-NetIPsecPhase2AuthSet –PolicyStore ActiveStore

EXAMPLE 2

This example gets a phase 2 authentication set and displays the parameters based upon the localized rule name.

PS C:\> Get-NetIPsecPhase2AuthSet -DisplayName "Tunnel Mode - Americas (DA Client) - Phase 2 Auth Set"

EXAMPLE 3

This example returns the phase 2 authorization set associated with an IPsec rule to examine the properties.

PS C:\> Get-NetIPSecRule -DisplayName "Authenticate Both Computer and User" | Get-NetIPsecPhase2AuthSet

관련 항목

Get-NetIPSecRule

New-NetIPsecMainModeRule

New-NetIPsecPhase2AuthSet

Open-NetGPO

Save-NetGPO

Set-NetIPsecPhase2AuthSet

New-GPO