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 TrueCommand Compare Editions Software Status FreeNAS
Compare Systems M-Series X-Series R-Series Mini Series
Contact Us iXsystems Careers Clients Reviews
TrueNAS GitHub Community Forum Discord TrueNAS Merch Store
Application Backup and Archival Cloud Media Workflows Video Surveillance Virtualization
Industry Education Government Healthcare Research / AI / ML Media & Entertainment
Enterprise Support Community Support Documentation TrueNAS Security FAQ iX Blog TrueNAS Blog
Case Studies White Papers Solution Briefs iX Portal Plugins & Apps ZFS Videos
Download TrueNAS CORE Download TrueNAS SCALE Get TrueNAS Enterprise Where to Buy
  1. TrueNAS SCALE 23.10
  2. /
  3. CLI Reference Guide
  4. /
  5. Network
Edit page
TrueNAS SCALETrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

Network

  2 minute read.

Last Modified 2024-03-19 08:38 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.

Network Namespace

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

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

Network Child Namespace Contents

The following articles provide information on network child authentication namespaces:

  • DNS: Provides information about the network dns namespace in the TrueNAS CLI. Includes command syntax and common commands.

    • Configuration: Provides information about the network configuration namespace in the TrueNAS CLI. Includes command syntax and common commands.

      • General: Provides information about the network general namespace in the TrueNAS CLI. Includes command syntax and common commands.

        • Interface: Provides information about the network interface namespace in the TrueNAS CLI. Includes command syntax and common commands.

          • IPMI: Provides information about the network ipmi namespace in the TrueNAS CLI. Includes command syntax and common commands.

            • Route: Provides information about the network route namespace in the TrueNAS CLI. Includes command syntax and common commands.

              • Static_Route: Provides information about the network static_route namespace in the TrueNAS CLI. Includes command syntax and common commands.