Get-ServiceFabricClusterHealth
Service Fabric クラスターの正常性情報を取得します。
構文
Get-ServiceFabricClusterHealth
[-ConsiderWarningAsError <Boolean>]
[-MaxPercentUnhealthyApplications <Byte>]
[-MaxPercentUnhealthyNodes <Byte>]
[-EventsHealthStateFilter <Int64>]
[-EventsFilter <HealthStateFilter>]
[-ApplicationsHealthStateFilter <Int64>]
[-ApplicationsFilter <HealthStateFilter>]
[-NodesHealthStateFilter <Int64>]
[-NodesFilter <HealthStateFilter>]
[-ApplicationHealthPolicyMap <ApplicationHealthPolicyMap>]
[-ApplicationTypeHealthPolicyMap <ApplicationTypeHealthPolicyMap>]
[-NodeTypeHealthPolicyMap <NodeTypeHealthPolicyMap>]
[-IncludeSystemApplicationHealthStatistics]
[-TimeoutSec <Int32>]
[<CommonParameters>] Get-ServiceFabricClusterHealth
[-ConsiderWarningAsError <Boolean>]
[-MaxPercentUnhealthyApplications <Byte>]
[-MaxPercentUnhealthyNodes <Byte>]
[-EventsHealthStateFilter <Int64>]
[-EventsFilter <HealthStateFilter>]
[-ApplicationsHealthStateFilter <Int64>]
[-ApplicationsFilter <HealthStateFilter>]
[-NodesHealthStateFilter <Int64>]
[-NodesFilter <HealthStateFilter>]
[-ApplicationHealthPolicyMap <ApplicationHealthPolicyMap>]
[-ApplicationTypeHealthPolicyMap <ApplicationTypeHealthPolicyMap>]
[-NodeTypeHealthPolicyMap <NodeTypeHealthPolicyMap>]
[-ExcludeHealthStatistics]
[-TimeoutSec <Int32>]
[<CommonParameters>] 説明
Get-ServiceFabricClusterHealth コマンドレットは、Service Fabric クラスターの正常性情報を取得します。 Service Fabric は、次の正常性状態を報告します。
- OK です。 エンティティは正常性ガイドラインを満たしています。
- エラー。 エンティティは正常性ガイドラインを満たしていません。
- 警告。 エンティティは正常性ガイドラインを満たしていますが、いくつかの問題が発生しました。
クラスターの集計された正常性状態では、クラスター上のすべての正常性レポートと、すべての子の集計された正常性状態が再帰的に考慮されます。 正常性評価では、クラスターの正常性ポリシーと、クラスター内の各アプリケーションのアプリケーション正常性ポリシーが使用されます。
Service Fabric クラスターで操作を実行する前に、 Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。
例
例 1: クラスターの正常性を取得し、返された子をフィルター処理する
PS C:\> Get-ServiceFabricClusterHealth -NodesFilter Error -ApplicationsFilter 'Warning,Error'このコマンドは、クラスターの正常性を照会します。 正常性状態が Error のノードと、正常性状態が警告またはエラーのアプリケーションのみを返すフィルターを指定します。
例 2: カスタム正常性ポリシーを使用してクラスターの正常性を取得する
PS C:\> $defaultServiceTypeHealthPolicy = new-object -TypeName System.Fabric.Health.ServiceTypeHealthPolicy
$defaultServiceTypeHealthPolicy.MaxPercentUnhealthyPartitionsPerService = 20
$defaultServiceTypeHealthPolicy.MaxPercentUnhealthyServices = 10
$appHealthPolicy = New-Object -TypeName System.Fabric.Health.ApplicationHealthPolicy
$appHealthPolicy.ConsiderWarningAsError = $True
$appHealthPolicy.MaxPercentUnhealthyDeployedApplications = 20
$appHealthPolicy.DefaultServiceTypeHealthPolicy = $defaultServiceTypeHealthPolicy
$appHealthPolicyMap = New-Object -TypeName System.Fabric.Health.ApplicationHealthPolicyMap
$appUri1 = New-Object -TypeName System.Uri -ArgumentList "fabric:/app1"
$appHealthPolicyMap.Add($appUri1, $appHealthPolicy)
Get-ServiceFabricClusterHealth -ConsiderWarningAsError $True -MaxPercentUnhealthyNodes 10 -ApplicationHealthPolicyMap $appHealthPolicyMapこのコマンドは、クラスターの正常性を照会し、カスタム ポリシーを渡します。
例 3: アプリケーションの種類の正常性ポリシー マップを使用してクラスターの正常性を取得する
PS C:\> $AppTypeHealthPolicyMap = New-Object -TypeName "System.Fabric.Health.ApplicationTypeHealthPolicyMap"
PS C:\> $AppTypeHealthPolicyMap.Add("CriticalAppType", 0)
PS C:\> Get-ServiceFabricClusterHealth -ApplicationTypeHealthPolicyMap $AppTypeHealthPolicyMap -MaxPercentUnhealthyApplications 20このコマンドは、クラスターの正常性を照会し、アプリケーションの種類の正常性ポリシー マップに渡します。 アプリケーションの種類 CriticalAppType は、エラーを許容しません。 残りのアプリケーションは、20% の最大異常率を使用して評価されます。
例 4: 正常性イベントを使用せず、正常性統計を使用せずにクラスターの正常性を取得する
PS C:\> Get-ServiceFabricClusterHealth -EventsFilter None -ExcludeHealthStatisticsこのコマンドは、クラスターの正常性を照会します。 正常性イベントと正常性統計を除外するフィルターを指定します。
例 5: fabric:/System アプリケーション統計を含むクラスターの正常性を取得する
PS C:\> Get-ServiceFabricClusterHealth -EventsFilter None -IncludeSystemApplicationHealthStatisticsこのコマンドは、クラスターの正常性を照会します。 クラスターの正常性の一部として返される正常性統計には、ユーザー アプリケーションの統計情報に加えて、fabric:/System アプリケーション統計が含まれます。
パラメーター
-ApplicationHealthPolicyMap
一部またはすべてのアプリケーションのカスタム正常性ポリシーを含む ApplicationHealthPolicyMap オブジェクトを指定します。 このパラメーターを指定しない場合、正常性評価では、アプリケーション マニフェストまたは既定の正常性ポリシーで定義されているアプリケーション正常性ポリシーが使用されます。
| Type: | ApplicationHealthPolicyMap |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationsFilter
正常性状態に基づいて ApplicationHealthState 子のフィルターを指定します。 値は、 メンバーまたは HealthStateFilter のメンバーに対するビットごとの操作から取得できます。 フィルターに一致する子のみが返されます。 すべての子は、エンティティの集計された正常性状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。
| Type: | HealthStateFilter |
| Accepted values: | Default, None, Ok, Warning, Error, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationsHealthStateFilter
このパラメーターは非推奨になりました。 代わりに ApplicationsFilter パラメーターを指定します。
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationTypeHealthPolicyMap
アプリケーションの種類ごとに許可される異常なアプリケーションの最大割合を定義するマップを指定します。 このマップ内のアプリケーションの種類は、グローバル な MaxPercentUnhealthyApplications の割合ではなく、特定のパーセンテージを使用して評価されます。
たとえば、ある種類の一部のアプリケーションがクリティカルである場合、クラスター管理者はそのアプリケーションの種類のエントリをマップに追加し、値 0% を割り当てることができます (つまり、すべてのエラーは許容されません)。 他のすべてのアプリケーションは 、MaxPercentUnhealthyApplications を 20% に設定して評価して、数千のアプリケーション インスタンスからの一部の障害を許容できます。
アプリケーションの種類の正常性ポリシー マップは、クラスター マニフェストが HealthManager/EnableApplicationTypeHealthEvaluation の構成エントリを使用してアプリケーションの種類の正常性評価を有効にする場合にのみ使用されます。
| Type: | ApplicationTypeHealthPolicyMap |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConsiderWarningAsError
正常性評価中に警告正常性レポートをエラーとして扱うかどうかを示します。 この値は、ノードとクラスターの正常性レポートの評価に使用されます。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventsFilter
正常性状態に基づいてクラスターで報告される HealthEvents のコレクションのフィルターを指定します。 値は、 メンバーまたは HealthStateFilter のメンバーに対するビットごとの操作から取得できます。 フィルターに一致するイベントのみが返されます。 すべてのイベントは、クラスターの集計された正常性状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。
| Type: | HealthStateFilter |
| Accepted values: | Default, None, Ok, Warning, Error, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventsHealthStateFilter
このパラメーターは非推奨になりました。 代わりに EventsFilter パラメーターを指定します。
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeHealthStatistics
正常性統計をクエリ結果に含める必要があるかどうかを示します。 指定した場合、正常性統計はクエリ結果の一部として返されません。 それ以外の場合、クエリ結果にはクラスターの正常性統計が含まれます。これには、OK、警告、エラーの状態にあるエンティティの数に関する情報が含まれます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeSystemApplicationHealthStatistics
正常性統計に fabric:/System アプリケーションの情報を含める必要があるかどうかを示します。 指定した場合、アプリケーション、サービス、パーティション、レプリカ、デプロイされたアプリケーション、デプロイされたサービス パッケージの数には、システム エンティティが含まれます。 指定しない場合、正常性統計はユーザー アプリケーションに対してのみ正常性状態数を返します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxPercentUnhealthyApplications
異常なアプリケーションの最大許容パーセンテージを指定します。 正常性状態の集計が許容されるよりも多くのアプリケーションがエラーの場合、クラスターの正常性状態はエラーになります。 このパラメーターを指定しない場合、正常性評価ではクラスター マニフェストで指定された値が使用されます。
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxPercentUnhealthyNodes
異常なノードの最大許容パーセンテージを指定します。 正常性状態が集計されたエラーのノードが許容される数より多い場合、クラスターはエラーとして評価されます。 このパラメーターを指定しない場合、正常性評価ではクラスター マニフェストで指定された値が使用されます。
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NodesFilter
正常性状態に基づいて NodeHealthState 子のフィルターを指定します。 値は、 メンバーまたは HealthStateFilter のメンバーに対するビットごとの操作から取得できます。 フィルターに一致する子のみが返されます。 すべての子は、エンティティの集計された正常性状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。
| Type: | HealthStateFilter |
| Accepted values: | Default, None, Ok, Warning, Error, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NodesHealthStateFilter
このパラメーターは非推奨になりました。 代わりに NodesFilter パラメーターを指定します。
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NodeTypeHealthPolicyMap
特定のノード タイプの異常なノードの最大パーセンテージを持つマップを定義します。
ノードの種類の正常性ポリシー マップをクラスターの正常性評価時に使用して、特別なノードの種類を記述できます。 マップに含まれるノード タイプは、マップに含まれる割合に対して評価され、グローバルも使用されます (System.Fabric.Health.ClusterHealthPolicy.MaxPercentUnhealthyNodes を参照)。 マップで指定されたノード タイプのノードも、ノードのグローバル プールに対してカウントされます。これらは独立したチェックです。
| Type: | NodeTypeHealthPolicyMap |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeoutSec
操作のタイムアウト期間を秒単位で指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
None
出力
System.Object