Managing Services with smartserverctl

Owned by Nina Cardillo
26-Jan-2024
2 min read

This section applies to SmartServer 4.0 and higher. SmartServer 4.0 and higher uses smartserverctl to manage components that are running as a service. SmartServer 3.6 and prior uses supervisorctl to manage custom applications that run as a service. See also Service and System Management.

smartserverctl is utility that unifies service management of SmartServer components under systemd. smartserverctl is wrapper around the systemctl command and shares most of the interface.

This section describes how to manage services with smartserverctl and consists of the following:

Using smartserverctl

When using smartserverctl, consider the following:

  • smartserverctl requires administrator privileges. If you are not logged in as root user, then use sudo at the prompt to gain the privileges.

  • All services can be referenced by the full prefixed name. A common prefix is smartserver- (e. g., smartserver-alarm or its alias alarm).

  • smartserverctl does not show the group name before the name of the service in its output and does not require the group name to work with the service. This behavior is different than the supervisorctl command that is used with SmartServer 3.6 and prior. With smartserverctl, groups act like any other service. It is not necessary to use the semicolon ( : ) in the group names. When working with a group, it acts as single unit and will not show any information about individual services.

Commands

The sections that follow describe smartserverctl commands and provide examples.

start

This command starts specified services or groups.

# smartserverctl start service [service ...]

stop

This command stops specified services or groups.

# smartserverctl stop service [service ...]

restart

This command restarts specified services or groups.

# smartserverctl restart service [service ...]

enable

This command enables automatic start on boot of specified services or groups. To enable a service, use the prefixed name (e.g., smartserver-alarm).

# smartserverctl enable service [service ...]

disable

This command disables automatic start on boot of specified services or groups.

# smartserverctl disable service [service ...]

status

This command prints the status of specified services or groups. When no argument is specified, this command prints the status of all components in alphabetical order.

When a group name is specified, this command prints only the overall status of the group, and not the status of the group members.

# smartserverctl status alarm lon lte ltx
alarm ACTIVE 1h 50min
lon ACTIVE 6min
lte INACTIVE 20min
ltx FAILED 20min

reload

This command reloads the systemd configuration.

Use caution when applying this command. Most scenarios do not require a reload of the systemd configuration.

This action is required when changes have been made in the systemd configuration files, which are located in /lib/systemd/system/smartserver-service-name.service. In these cases, a reload is required before a service can be restarted in order for changes to be applied.

# smartserverctl reload