Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Enterprise Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS Enterprise TrueNAS SCALE TrueNAS CORE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series H-Series R-Series Mini Series
Contact Us iXsystems Careers Clients Reviews
TrueNAS GitHub Community Forum Discord TrueNAS Merch Store
Use Cases Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Surveillance Virtualization
Industry Education Government Healthcare Research / AI / ML Media & Entertainment
Enterprise Support Community Support Documentation TrueNAS Security FAQ ZFS Overview
TrueNAS Blog Solution Guides Datasheets Case Studies Videos TrueCommand Cloud
Download TrueNAS SCALE Download TrueNAS CORE Get TrueNAS Enterprise Compare TrueNAS Editions Contact an Enterprise Specialist
  1. TrueNAS SCALE 23.10
  2. /
  3. CLI Reference Guide
  4. /
  5. System
  6. /
  7. Device
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.

Device

  2 minute read.

Last Modified 2024-03-19 08:38 EDT

Device Namespace

The device namespace has two commands. It provides access to device information through the device commands.

Device Commands

The following device commands allow you to view properties for devices in your system.

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

The SCALE CLI guide 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!

Interactive Argument Editor (TUI)

Enter the -- flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).

Get_Info Command

The get_info command returns details for a specified device type.

Description

The get_info command has one property, type. Enter the type property argument using = to separate property and value. Enter the command string then press Enter. The command returns a table of device details when successful.

TypeDescription
SERIALReturns information for system serial ports.
DISKReturns information for system storage disks.
GPUReturns information for system GPUs.

Usage

From the CLI prompt, enter:

system device get_info type=TYPE

Where:

  • TYPE is the device type you want details for.
system device get_info type=SERIAL
+-------+-----------------------------+------------+-------------+-------+
| name  | location                    | drivername | description | start |
+-------+-----------------------------+------------+-------------+-------+
| ttyS1 | handle=\_SB_.PC00.LPC0.UAR2 | uart       | 16550A      | 0x2f8 |
| ttyS0 | handle=\_SB_.PC00.LPC0.UAR1 | uart       | 16550A      | 0x3f8 |
+-------+-----------------------------+------------+-------------+-------+

GPU_PCI_IDs_Choices Command

The gpu_pci_ids_choices retrieves choices for GPU PCI IDs in the system.

Description

The gpu_pci_ids_choices command has no required properties. Enter the commands then press Enter. The command returns a table of GPU PCI ID choices when successful.

Usage

From the CLI prompt, enter:

system device gpu_pci_ids_choices

+------------------------------------------------+--------------+
| ASPEED Technology, Inc. ASPEED Graphics Family | 0000:03:00.0 |
+------------------------------------------------+--------------+

Related CLI System Articles

Have more questions or want to discuss your specific configuration? For further discussion or assistance, see these resources:

Found content that needs an update? You can suggest content changes directly! To request changes to this content, click the Feedback button located on the middle-right side of the page (might require disabling ad blocking plugins).