Send-​Service​Fabric​Node​Health​Report

Sends a health report on a Service Fabric node.

Syntax

Send-ServiceFabricNodeHealthReport
    [-NodeName] <String>
    [-Description <String>]
    -HealthProperty <String>
    -HealthState <HealthState>
    [-RemoveWhenExpired]
    [-SequenceNumber <Int64>]
    -SourceId <String>
    [-TimeoutSec <Int32>]
    [-TimeToLiveSec <Int32>]
    [<CommonParameters>]

Description

The Send-ServiceFabricNodeHealthReport cmdlet sends a health report on a Service Fabric node.

The node must already exist in the health store. To check whether it exists, use the Get-ServiceFabricNodeHealth cmdlet. Alternatively, you can use the Get-ServiceFabricNode cmdlet. If the cmdlet gets the node and the node has valid health state, then the node exists in the health store.

The cmdlet sends the report after an interval specified by the HealthReportSendIntervalInSec parameter of the Connect-ServiceFabricCluster cmdlet. The cluster connection must be kept alive during this time. The command is evaluated on the client without reference to running on the health store. The report may not be applied in health store even if the command returns success. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.

To see whether the report was applied in the health store, use the Get-ServiceFabricNodeHealth cmdlet and check that the report appears in the HealthEvents section.

To manage Service Fabric clusters, start Windows PowerShell by using the Run as administrator option. Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet and then the Get-ServiceFabricClusterConnection cmdlet.

Examples

Example 1: Report Error health report with infinite TTL

PS C:\> Send-ServiceFabricNodeHealthReport -NodeName "Node01" -SourceId "MyWatchdog" -HealthProperty "Firewall" -HealthState Error -Description "Firewall rules were not correctly applied"

This command sends a health report on the node named Node01 from the source named MyWatchdog. The health report contains information about the health property Firewall in an Error health state, with infinite TTL.

Example 2: Report Warning valid for specified TTL

PS C:\> Send-ServiceFabricNodeHealthReport -NodeName "Node01" -SourceId "MyWatchdog" -HealthProperty "CPU" -HealthState Warning -Description "CPU has been more than 90% for the last hour." -TimeToLiveSec 10 -RemoveWhenExpired

This command sends a health report on the node named Node01 from the source named MyWatchdog. The health report contains information about the health property CPU in a Warning health state. The command also gives a description for the warning, sets the TTL to 10 seconds, and configures the report to be removed when it expires.

Required Parameters

-HealthProperty

Specifies the property of the report. Together with the SourceId parameter, this property uniquely identifies the report. The report overrides any previous reports with the same values for the SourceId and HealthProperty parameters on the same entity.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-HealthState

Specifies a HealthState object that represents the reported health state.

Type:HealthState
Parameter Sets:Invalid, Ok, Warning, Error, Unknown
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NodeName

Specifies the name of a Service Fabric node. The cmdlet sends a health report on the node that you specify.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceId

Specifies the identifier of the source that triggered the report.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Description

Specifies human readable information about the condition that triggered the report. The SourceId, HealthProperty, and HealthState parameters fully describe the report.The maximum string length for the description is 4096 characters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RemoveWhenExpired

Indicates that the report is removed from the health store when it expires. If you do not specify this parameter, the entity is considered in Error state when the report time to live expires. The reports that are removed when expired can be used for conditions that are only valid for a period of time or for clearing reports from Health Store.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SequenceNumber

Specifies the sequence number associated with the health report. If you do not specify a value for this parameter, the sequence number is set automatically. If you specify a sequence number, that value must be higher than any previous sequence number set on the same SourceId and HealthProperty, or the report will be rejected due to staleness.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TimeToLiveSec

Specifies the Time to Live (TTL) of the report in seconds. When the TTL expires, the report is removed from the health store if the RemoveWhenExpired parameter is specified. Otherwise, the entity is evaluated at Error because of the expired report. The default value is Infinite.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String, System.Fabric.HealthState

Outputs

None