| external help file | Module Name | online version | schema |
|---|---|---|---|
EventSentry-help.xml |
EventSentry |
2.0.0 |
{{ Sets notes or custom heartbeat properties for a host }}
Set-ESHostProperty [-Group] <String> [-Hostname] <String> [-EnableAgent <Boolean>] [-EnablePing <Boolean>]
[-PacketCount <Int32>] [-PacketSize <Int32>] [-SuccessPercentage <Int32>] [-RoundTrip <Int32>]
[-TcpPorts <String>] [-RequirePing <Boolean>] [-RequiredErrorCount <Int32>] [-RepeatFailed <Boolean>]
[-CollectPingStats <Boolean>] [-Notes <String>] [-IPAddress <String>] [<CommonParameters>]
{{ Sets notes or custom heartbeat properties for a host }}
PS C:\> {{ Set-ESHostProperty "Network Devices" FIREWALL -EnableAgent 0 -PacketCount 8 -TcpPorts 80:443 }}{{ Sets the following custom heartbeat properties for host FIREWALL in group "Network Devices": Agent check is disabled, ICMP packet count is set to 8 and TCP ports 80 and 443 are monitored. }}
{{ Collect ping response times in database }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Enable EventSentry agent check }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Enable ICMP ping check }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Name of the group host is a member of }}
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Name of the host for which properties should be set }}
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Sets the IP address for a host. Specify empty value to remove IP address. }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Sets the notes for the host. Specify empty value to remove notes. }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Number of packets to send when performing a ping check on the host }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ ICMP packet size when performing a ping check on the host }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Toggle option to retry a failed host check before the next monitoring interval }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Sets whether a successful PING check is required for TCP and/or EventSentry agent checks }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Number of errors that are required before a host check is considered failed }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Max allowed ping roundtrip time in ms }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Percentage of ICMP packets that need to be replied to in order to consider the check successful }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ TCP ports to check, multiple ports can be separated with colon (:) }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.