TrueNAS Documentation Archive
This content follows the TrueNAS 23.10 (Cobia) 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 version.
Service
7 minute read.
Last Modified 2024-03-19 08:38 EDTThe TrueNAS CLI guide for SCALE 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 a start
command succeeded for a specified service.
The started_or_enabled
command displays whether a service starts automatically upon reboot or is running.
The stop
command stops a specified service.
The terminate_process
command forces a service to stop and disables it.
The update
command updates the service specified and lets you decide whether or not you want a service to start automatically upon system reboot.
The following articles provide information on service child namespaces:
- Cluster: Provides information about the service cluster namespace in the TrueNAS CLI. Includes command syntax and common commands.
- CTDB: Provides information about the service ctdb namespace in the TrueNAS CLI. Includes command syntax and common commands.
- FTP: Provides information about the service ftp namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Gluster: Provides information about the service gluster namespace in the TrueNAS CLI. Includes command syntax and common commands.
- IPMI: Provides information about the service ipmi namespace in the TrueNAS CLI. Includes command syntax and common commands.
- NFS: Provides information about the service nfs namespace in the TrueNAS CLI. Includes command syntax and common commands.
- SMB: Provides information about the service smb namespace in the TrueNAS CLI. Includes command syntax and common commands.
- SNMP: Provides information about the service snmp namespace in the TrueNAS CLI. Includes command syntax and common commands.
- SSH: Provides information about the service ssh namespace in the TrueNAS CLI. Includes command syntax and common commands.
- UPS: Provides information about the service ups namespace in the TrueNAS CLI. Includes command syntax and common commands.
- VM: Provides information about the service vm namespace in the TrueNAS CLI. Includes command syntax and common commands.
- SMART: Provides information about the service smart namespace in the TrueNAS CLI. Includes command syntax and common commands.