Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Commercial Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS CORE TrueNAS Enterprise TrueNAS SCALE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series X-Series R-Series Mini Series
About iXsystems Our Clients Reviews Careers Awards iX Blog & News iX Website Contact Us
Community Forum Discord TrueNAS GitHub TrueNAS Merch Store
Application Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Video Surveillance Virtualization
Industry Automotive Education Gaming Government Healthcare MSP Manufacturing Research & AI Media & Entertainment
Download TrueNAS CORE Download TrueNAS SCALE Get TrueNAS Enterprise Compare TrueNAS Editions Where to Buy
  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. CLI Reference Guide
  6. /
  7. Task
Edit page
TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Task

  2 minute read.

Last Modified 2024-03-15 13:07 EDT

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!

Welcome to the TrueNAS SCALE Command Line Interface (CLI) guide!

The TrueNAS CLI in TrueNAS SCALE functions like a text-based version of the web UI with many functional areas grouped into parent and child namespaces that mirror the counterparts in the SCALE UI.

The underlying structure of the CLI namespaces and commands closely follows that of the SCALE API. For more information on API commands, arguments, options, and definitions go to API Keys and click on API Docs in the SCALE UI.

Task Namespace

The task namespace has six child namespaces and is based on functions found in the SCALE API and web UI. It provides access to task configuration methods through the child namespaces and their commands.

You can enter commands from the main CLI prompt or from the task namespace prompts.

Task Namespaces

The following articles provide information on task child authentication namespaces:

  • Cloud_Sync: Introduces the TrueNAS CLI task cloud_sync namespace, used to access the credentials child namespace and commands.

    • Credential: Provides information about the task cloud_sync credential namespace in the TrueNAS CLI. Includes command syntax and common commands.

  • Cron_Job: Provides information about the task cron_job namespace in the TrueNAS CLI. Includes command syntax and common commands.

    • Replication: Provides information about the task replication namespace in the TrueNAS CLI. Includes command syntax and common commands.

      • Rsync: Provides information about the task rsync namespace in the TrueNAS CLI. Includes command syntax and common commands.

        • Smart_Test: Provides information about the task smart_test namespace in the TrueNAS CLI. Includes command syntax and common commands.

          • Snapshot (Task): Provides information about the task snapshot namespace in the TrueNAS CLI. Includes command syntax and common commands.