The 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! api_key commands are based on API key creation and management functions found in the SCALE API and web UI. Use to create new API keys, delete or update existing keys, and locate information on one or all keys added to the system.
The API Keys option on the top toolbar Settings dropdown menu displays the API Keys screen. This screen displays a list of TrueNAS SCALE API keys on your system and allows you to add, edit, or delete keys.
Figure 1: API Keys Screen Click the icon to the right of an API key to display options for that key. API key options are Edit and Delete.
Use Add to add a new API key to your TrueNAS.
The API Keys option on the top right toolbar Settings (user icon) dropdown menu displays the API Keys screen. This screen displays a list of API keys added to your system and allows you to add, edit, or delete keys.
Figure 1: API Keys Screen To manage API keys in the TrueNAS SCALE CLI, use the auth api_key namespace. Adding an API Key Click Add to display a dialog window that lets users add a new API key.
Adding the First TrueNAS System with the TrueCommand UI Before adding a TrueNAS system, log into that system, then take note of the system host name or IP address (on the Network screen). Next, you need either a password or to obtain a system API key to use as a security credential. Create an API key in the TrueNAS system and copy the API key to the clipboard to paste into the Password/API Key field on the New System screen.
Truecommand Namespace The truecommand namespace has three commands and is based on TrueCommand management functions found in the SCALE API and web UI. It provides access to system TrueCommand setting methods through the truecommand commands.
Truecommand Commands The following truecommand commands allow you to update or view current TrueCommand configuration settings, add an API key, or enable/disable the TrueCommand connection in SCALE.
You can enter commands from the main CLI prompt or from the truecommand namespace prompt.
TrueNAS CORE
TrueNAS Enterprise
TrueNAS SCALE
Compare Editions
TrueCommand
Software Status
FreeNAS
Compare Systems
F-Series
M-Series
X-Series
R-Series
Mini Series
Download TrueNAS CORE
Download TrueNAS SCALE
Get TrueNAS Enterprise
Where to Buy