healthcheck-configure

Configures the Healthcheck service.

This command is deprecated and will be removed in a future release as it has been replaced by the set-healthcheck-configuration command.

Synopsis

asadmin [asadmin-options] healthcheck-configure
[--help]
[--target target]
[--enabled={false|true}]
[--dynamic={false|true}]
[--historictraceenabled={false|true}]
[--historictracestore-size size]
[--historictracestore-timeout integer.value {s|m|h|d}]
[--setnotifiers notifiers]
[--enablenotifiers notifiers]
[--disablenotifiers notifiers]

Description

Enables and disables the HealthCheck service. This includes configuration for tracing historic health check events for later inspection.

Options

asadmin-options

Options for the asadmin utility. For information about these options, see the asadmin help page.

--help
-?

Displays the help text for the subcommand.

--target

This option helps specify the target on which you are configuring the Healthcheck service. Valid values are:

server

Applies to the default server instance. This is the default value.

cluster_name

Applies to every server instance in the cluster.

instance_name

Applies to a specified server instance.

--enabled

Defaults to false. Enables or disables the healthcheck service

--dynamic

Defaults to false. When set to true, applies the changes without a server restart.

--historictraceenabled

Defaults to false. Enables storing traces in a rolling store for later inspection.

--historictracestoresize

Defaults to 20. Sets the maximum number of health checks to store.

--historictracestoretimeout

Sets the time period after which a historic health check event entry is removed from history.

The time expression should consist of a number followed by a time unit; s for seconds, m for minutes, h for hours or d for days.

If no time unit is given the number specifies seconds.

If the parameter is zero or unspecified there is no timeout for entries.

--setnotifiers

Use the option to set the notifiers that will receive notifications generated by the Healthcheck Service.

A comma-separated list can be used to represent multiple notifiers.

This option will replace all the notifiers that have already been set to the HealthCheck Service.
--enablenotifiers

Use the option to enable one or more notifiers for the Healthcheck service.

A comma-separated list can be used to represent multiple notifiers.

--disablenotifiers

Use the option to disable one or more notifiers for the Healthcheck service.

A comma-separated list can be used to represent multiple notifiers.

Examples

Example 1 Basic Configuration

The following example will enable the Healthcheck service such that it will only activate from the next time the server is restarted.

It enables the log notifier and sets the historical trace store to retain 20 health checks.

asadmin healthcheck-configure
    --enabled=true
    --dynamic=false
    --notifierenabled=true
    --historicaltraceenabled=true
    --historicaltracestoresize=20

Exit Status

0

subcommand executed successfully

1

error in executing the subcommand

See Also