TrueNAS SCALE Documentation Archive
This content follows the TrueNAS SCALE 22.12 (Bluefin) releases. Archival documentation is provided for reference only and not actively maintained.
Use the Product and Version selectors above to view content specific to different TrueNAS software or major versions.
Service
6 minute read.
Last Modified 2024-03-19 08:47 EDTThe SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!
The service namespace has 10 commands and 12 child namespaces and is based on functions found in the SCALE API and web UI. It provides access to service configuration and validation methods for the 10 service commands. The 12 child namespaces have their own commands.
You can enter commands from the main CLI prompt or from the service namespace prompt.
The get_instance
command displays the id, name, and status of a service.
The query
command displays a simple overview of all services.
The reload
command reloads a specified service.
The restart
command restarts a specified service.
The start
command restarts a specified service.
The started
command verifies whether or not a start
command succeeded for a specified service.
Possible returns:
Property | Description |
---|---|
true | The service started successfully. |
false | The service did not start. |
The started_or_enabled
command displays whether or not a service starts automatically upon reboot or is running.
Possible returns:
Property | Description |
---|---|
true | The service restarts automatically and/or is running. |
false | The service is not running, nor does start automatically. |
The start
command restarts a specified service.
Possible returns:
Property | Description |
---|---|
false | The service stopped or is not running. |
The terminate_process
command forces a service to stop and disables it.
The command only returns with true
to show that the service stopped or is not running.
The update
command lets you decide whether or not you want a service to start automatically upon system reboot.