Send-ServiceFabricClusterHealthReport
Service Fabric クラスターの正常性レポートを送信します。
構文
Send-ServiceFabricClusterHealthReport
-HealthState <HealthState>
-SourceId <String>
-HealthProperty <String>
[-Description <String>]
[-TimeToLiveSec <Int32>]
[-RemoveWhenExpired]
[-SequenceNumber <Int64>]
[-Immediate]
[-TimeoutSec <Int32>]
[<CommonParameters>] 説明
Send-ServiceFabricClusterHealthReport コマンドレットは、Service Fabric クラスターの正常性レポートを送信します。
コマンドレットは、Connect-ServiceFabricCluster コマンドレットの HealthReportSendIntervalInSec パラメーターで指定された間隔の後にレポートを送信します。 この間、クラスター接続を有効にしておく必要があります。 このコマンドは、正常性ストアで実行されている参照なしでクライアントで評価されます。 コマンドが成功を返しても、正常性ストアにレポートが適用されない場合があります。 たとえば、正常性ストアは、古いシーケンス番号などの無効なパラメーターが原因でレポートを拒否する場合があります。
レポートが正常性ストアに適用されたかどうかを確認するには、 Get-ServiceFabricClusterHealth コマンドレットを使用して、レポートが [HealthEvents] セクションに表示されることを確認します。
Service Fabric クラスターを管理するには、[管理者として実行] オプションを使用してWindows PowerShellを開始します。 Service Fabric クラスターで操作を実行する前に、Connect-ServiceFabricCluster コマンドレットと Get-ServiceFabricClusterConnection コマンドレットを使用してクラスターへの接続を確立します。
例
例 1: TTL が無限のエラー正常性レポートを報告する
PS C:\> Send-ServiceFabricClusterHealthReport -SourceId "MyWatchdog" -HealthProperty "Availability" -HealthState Errorこのコマンドは、ソース MyWatchdog からクラスターの正常性レポートを送信します。 正常性レポートには、エラー正常性状態の正常性プロパティ の可用性 に関する情報が含まれています。TTL は無限です。
例 2: 指定された TTL に対して有効なレポート警告
PS C:\> Send-ServiceFabricClusterHealthReport -SourceId "MyWatchdog" -HealthProperty "EnoughNodes" -HealthState Warning -TimeToLiveSec 10 -RemoveWhenExpired -SequenceNumber 1344このコマンドは、ソース MyWatchDog からクラスターの正常性レポートを送信します。 正常性レポートには、警告の正常性状態の 正常性プロパティ EnoughNodes に関する情報が含まれています。 レポートは正常性ストアに 10 秒間とどまり、その後は自動的に削除されます。 このコマンドは SequenceNumber パラメーターを指定します。 シーケンス番号は、同じ SourceId と Property に対して以前に報告されたシーケンス番号よりも大きくする必要があります。または、古さが原因でレポートが拒否されます。
パラメーター
-Description
レポートをトリガーした条件に関する人間が判読できる情報を指定します。 SourceId、HealthProperty、および HealthState パラメーターは、レポートを完全に記述します。
この説明の文字列の最大長は 4,096 文字です。 指定された文字列が長い場合は、自動的に切り捨てられます。 切り捨てられると、説明はマーカー "[Truncated]" で終わり、切り捨てが発生したことをユーザーに示します。 合計文字列サイズは 4096 文字であるため、元の文字列から 4096 文字未満が保持されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthProperty
レポートのプロパティを指定します。 SourceId パラメーターと共に、このプロパティはレポートを一意に識別します。 このレポートは、同じエンティティの SourceId パラメーターと HealthProperty パラメーターと同じ値を持つ以前のレポートをオーバーライドします。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthState
報告される正常性状態を表す HealthState オブジェクトを指定します。
| Type: | HealthState |
| Accepted values: | Invalid, Ok, Warning, Error, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Immediate
レポートをすぐに正常性ストアに送信するかどうかを指定します。 これは、できるだけ早く送信する必要がある重要なレポートに役立ちます。 指定しない場合、正常性クライアント設定に基づいてレポートが送信されます。 その結果、HealthReportSendInterval の構成に従ってバッチ処理されます。 この設定が推奨されているのは、正常性クライアントが正常性ストアへの正常性レポート メッセージに加えて正常性レポート処理を最適化できるようになるためです。 既定では、Powershell ファブリック クライアントは HealthReportSentInterval を 0 に設定するため、レポートはすぐに送信されます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoveWhenExpired
レポートの有効期限が切れると、正常性ストアからレポートが削除されることを示します。 このパラメーターを指定しない場合、レポートの有効期限が切れると、エンティティはエラー状態と見なされます。 有効期限が切れたときに削除されるレポートは、一定期間だけ有効な条件や、正常性ストアからレポートをクリアするために使用できます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SequenceNumber
正常性レポートに関連付けられているシーケンス番号を指定します。 このパラメーターの値を指定しない場合、シーケンス番号は自動的に設定されます。 シーケンス番号を指定する場合、その値は、同じ SourceId と HealthProperty に設定されている以前のシーケンス番号よりも大きくする必要があります。または、古さが原因でレポートが拒否されます。
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceId
レポートをトリガーしたソースの識別子を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TimeoutSec
操作のタイムアウト期間を秒単位で指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeToLiveSec
レポートの Time to Live (TTL) を秒単位で指定します。 TTL の有効期限が切れると、 RemoveWhenExpired パラメーターが指定されている場合、レポートは正常性ストアから削除されます。 それ以外の場合、有効期限が切れたレポートのため、エンティティは Error で評価されます。 既定値は Infinite です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
System.Fabric.Health.HealthState
System.String
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Management.Automation.SwitchParameter
System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
出力
System.Object