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. Storage
Edit page

Storage

  2 minute read.

Last Modified 2023-11-30 10:15 EST

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.

Storage Namespace

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

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

Storage Namespaces

The following articles provide information on storage child namespaces:

  • Dataset: Provides information about the storage dataset namespace in the TrueNAS CLI. Includes command syntax and common commands.

    • Disk: Provides information about the storage disk namespace in the TrueNAS CLI. Includes command syntax and common commands.

      • Enclosure: Provides information about the storage enclosure namespace in the TrueNAS CLI. Includes command syntax and common commands.

        • Filesystem (Storage): Provides information about the storage filesystem namespace in the TrueNAS CLI. Includes command syntax and common commands.

          • Pool: Provides information about the storage pool namespace in the TrueNAS CLI. Includes command syntax and common commands.

            • Resilver: Provides information about the storage resilver namespace in the TrueNAS CLI. Includes command syntax and common commands.

              • Scrub: Provides information about the storage scrub namespace in the TrueNAS CLI. Includes command syntax and common commands.

                • Snapshot: Provides information about the storage snapshot namespace in the TrueNAS CLI. Includes command syntax and common commands.

                  • VMWare: Provides information about the storage vmware namespace in the TrueNAS CLI. Includes command syntax and common commands.