ltcluster daemon stop

ltcluster daemon stop — Stop the ltclusterd daemon on the local node

Description

This command stops the ltclusterd daemon on the local node.

By default, ltcluster will wait for up to 15 seconds to confirm that ltclusterd stopped. This behaviour can be overridden by specifying a diffent value using the --wait option, or disabled altogether with the --no-wait option.

Note

If LightDB is not running on the local node, under some circumstances ltcluster may not be able to confirm if ltclusterd has actually stopped.

Important

The ltcluster.conf parameter ltclusterd_service_stop_command must be set for ltcluster daemon stop to work; see section ltcluster daemon stop configuration for details.

Configuration

ltcluster daemon stop will execute the command defined by the ltclusterd_service_stop_command parameter in ltcluster.conf. This must be set to a shell command which will stop ltclusterd; if ltcluster was installed from a package, this will be the service command defined by the package.

Important

If ltcluster was installed from a system package, and you do not configure ltclusterd_service_stop_command to an appropriate service command, this may result in the system becoming confused about the state of the ltclusterd service; this is particularly the case with systemd.

Options

--dry-run

Check prerequisites but don't actually attempt to stop ltclusterd.

This action will output the command which would be executed.

-w
--wait

Wait for the specified number of seconds to confirm that ltclusterd stopped successfully.

Note that providing --wait=0 is the equivalent of --no-wait.

--no-wait

Don't wait to confirm that ltclusterd stopped successfully.

This is equivalent to providing --wait=0.

Configuration file settings

The following parameter in ltcluster.conf is relevant to ltcluster daemon stop:

ltclusterd_service_stop_command

ltcluster daemon stop will execute the command defined by the ltclusterd_service_stop_command parameter in ltcluster.conf. This must be set to a shell command which will stop ltclusterd; if ltcluster was installed from a package, this will be the service command defined by the package.

Important

If ltcluster was installed from a system package, and you do not configure ltclusterd_service_stop_command to an appropriate service command, this may result in the system becoming confused about the state of the ltclusterd service; this is particularly the case with systemd.

Exit codes

One of the following exit codes will be emitted by ltcluster daemon stop:

SUCCESS (0)

ltclusterd could be stopped.

ERR_BAD_CONFIG (1)

ltclusterd_service_stop_command is not defined in ltcluster.conf.

ERR_LTCLUSTERD_SERVICE (27)

ltclusterd could not be stopped.

See also

ltcluster daemon start, ltclusterd daemon, ltcluster service status, ltcluster service pause, ltcluster service unpause