TrueNAS

https://www.truenas.com/docs
Admin
TrueNAS is a unified storage platform offering enterprise-grade and community editions for data...
Tokens:314,140
Snippets:2,834
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example NFS Export List

Source: https://www.truenas.com/docs/scale/23.10/gettingstarted/configure/setupsharing

An example output from the `showmount -e` command, illustrating how an NFS export list is displayed on a Unix-like system.

```bash
tmoore@ChimaeraPrime:~$ showmount -e 10.238.15.194
Export list for 10.238.15.194:
/mnt/pool1/testds (everyone)

```

--------------------------------

### Accessing TrueNAS Shell

Source: https://www.truenas.com/docs/core/13.0/gettingstarted/consolesetupmenu

This entry shows how to start a shell from the Console Setup menu for running FreeBSD commands. It details the command to enter and how to exit the shell.

```shell
/etc/netcli
```

--------------------------------

### Example NFS Mount Command

Source: https://www.truenas.com/docs/scale/23.10/gettingstarted/configure/setupsharing

An example of the `mount` command used to mount an NFS share on a Unix-like system, showing the IP address, dataset path, and local mount point.

```bash
tmoore@ChimaeraPrime:~$ sudo mount -t nfs 10.238.15.194:/mnt/pool1/testds nfstemp/

```

--------------------------------

### Example: Get Disk Instance Information (TrueNAS CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/storage/clidisk

An example of the `get_instance` command in action, showing the output format for a specific disk, including its various attributes and values.

```cli
[test1234] storage disk> get_instance id="{serial_lunid}N4G22WKK_5000cca24503ce58"
+----------------+-----------------------------------------+
|     identifier | {serial_lunid}N4G22WKK_5000cca24503ce58 |
|           name | sdl                                     |
|      subsystem | scsi                                    |
|         number | 2224                                    |
|         serial | N4G22WKK                                  |
|          lunid | 5000cca24503ce58                        |
|           size | 2000398934016                           |
|    description |                                         |
|   transfermode | Auto                                    |
|     hddstandby | ALWAYS ON                               |
|   advpowermgmt | DISABLED                                |
|    togglesmart | true                                    |
|   smartoptions |                                         |
|     expiretime | <null>                                  |
|       critical | <null>                                  |
|     difference | <null>                                  |
|  informational | <null>                                  |
|          model | HUS726020AL4210                         |
|   rotationrate | 7200                                    |
|           type | HDD                                     |
|       zfs_guid | 5249139309134546836                     |
|            bus | SCSI                                    |
|        devname | sdl                                     |
|      enclosure | <dict>                                  |
| supports_smart | <null>                                  |
|           pool | <null>                                  |
+----------------+-----------------------------------------+

```

--------------------------------

### Install Ventoy on USB via Linux CLI

Source: https://www.truenas.com/docs/scale/gettingstarted/install/installingscale

This code example illustrates how to install Ventoy on a USB drive using the command line interface in Linux. The `-r` tag is mentioned as a way to preserve space at the bottom of the disk during installation, which can be useful for creating additional partitions.

```bash
# Example command for installing Ventoy with space preservation
# Actual command would involve the Ventoy executable and its arguments
# ventoy_executable -i /dev/sdX -r <size_in_MB>
```

--------------------------------

### Start TrueNAS Console Setup Menu (CLI)

Source: https://www.truenas.com/docs/scale/22.12/gettingstarted/install/consolesetupmenuscale

This command is used to launch the Console Setup Menu (CSM) from the TrueNAS CLI or web shell. It requires root permissions. The CSM allows for system administration tasks such as network configuration and password changes.

```shell
/usr/bin/cli --menu
```

--------------------------------

### Install Ventoy on USB via Linux CLI

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This snippet shows how to install Ventoy on a USB drive using the command line in Linux. It specifically mentions using the `-r` tag with the Ventoy install string to preserve space at the bottom of the disk, which can be used for creating additional partitions during the Ventoy installation process.

```bash
Ventoy install string -r <value>
```

--------------------------------

### Jail Execution Commands Configuration

Source: https://www.truenas.com/docs/core/13.3/uireference/jailspluginsvms/pluginsscreens

Configure commands to be executed within the jail environment during its lifecycle. This includes starting, stopping, and pre/post actions.

```shell
exec_start: sh /etc/rc
exec_stop: sh /etc/rc.shutdown
exec_prestart: echo "Starting jail..."
exec_poststart: echo "Jail started."
exec_prestop: echo "Stopping jail..."
exec_poststop: echo "Jail stopped."
```

--------------------------------

### Install Ventoy on USB via Windows CLI

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/printpreview

This section refers to installing Ventoy on a USB drive using the Windows Command Line Interface (CLI). Specific commands and detailed steps are typically found in the official Ventoy documentation.

```bash
# Refer to Ventoy documentation for specific CLI commands.
# Example: Ventoy2Disk.exe -i /dev/sdX
```

--------------------------------

### Install Ventoy on USB via Linux CLI

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/printpreview

This snippet outlines the process of installing Ventoy on a USB drive using the command line in Linux. It mentions the use of the `-r` tag for preserving space during installation. Specific commands should be verified with Ventoy's official documentation.

```bash
# Example command to install Ventoy and preserve 2GB of space:
# sudo sh Ventoy2Disk.sh -i -r 2048 /dev/sdX
```

--------------------------------

### PGP ISO Verification with GnuPG (Linux/macOS)

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This snippet demonstrates how to import a public PGP key and verify an ISO image signature using the `gpg` command-line tool. It assumes you have GnuPG installed and the ISO and its signature file (`.gpg` or `.sig`) are in the current directory.

```bash
user@ubuntu /tmp> gpg --keyserver keys.gnupg.net --recv-keys 0xc8d62def767c1db0dff4e6ec358eaa9112cf7946
gpg: DBG: Using CREATE_BREAKAWAY_FROM_JOB flag
gpg: key 358EAA9112CF7946: public key "IX SecTeam <security-officer@ixsystems.com>" imported
gpg: DBG: Using CREATE_BREAKAWAY_FROM_JOB flag
gpg: Total number processed: 1
gpg:               imported: 1
user@ubuntu /tmp>
```

```bash
user@ubuntu /tmp>  gpg --verify TrueNAS-SCALE-21.04-ALPHA.1.iso
gpg: Signature made Thu May 27 10:49:02 2021 EDT using RSA key ID 12CF7946
gpg: Good signature from "IX SecTeam <security-officer@ixsystems.com>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: C8D6 2DEF 767C 1DB0 DFF4  E6EC 358E AA91 12CF 7946
user@ubuntu /tmp>
```

--------------------------------

### Create Ventoy Vlnk file in Windows with command line

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This shows how to use the VentoyVlnk.exe utility in Windows via the command line to generate a Vlnk file for booting ISO images. It allows specifying output file names directly.

```batch
VentoyVlnk.exe -i _filename_.iso -o _linkname_.vlnk.iso
```

--------------------------------

### Automate GRUB Boot with startup.nsh on TrueNAS VM

Source: https://www.truenas.com/docs/scale/23.10/scaletutorials/virtualization/creatingmanagingvmsscale

Instructions for creating a startup.nsh file in the root directory of a TrueNAS VM to ensure the GRUB bootloader runs automatically on VM startup. This involves using the shell editor to input the necessary commands.

```shell
edit startup.nsh
FS0:
cd EFI
cd Debian
grubx64.efi
# Use Control+s (Command+s for Mac) then Return to save.
# Use Control+q to quit.
```

--------------------------------

### Start SMB Service (TrueNAS CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaletutorials/scaletutorialsprint

Demonstrates how to start the SMB service on TrueNAS via the command line. This is typically done from the 'System Settings > Services' menu.

```bash
SMB toggle
```

--------------------------------

### TrueNAS API Client Interaction Example (Python)

Source: https://www.truenas.com/docs/scale/gettingstarted/scalereleasenotes

This snippet demonstrates how advanced users can interact with the TrueNAS API using the `midclt` command-line tool and Python. It showcases connecting to a TrueNAS instance and making API calls to manage the system. Ensure the TrueNAS API client is installed and configured.

```python
import midclt

# Connect to the local TrueNAS instance
client = midclt.client()

# Example: Get system information
# Replace 'system.info' with the actual API method you want to call
system_info = client.call('system.info')
print(f"System Info: {system_info}")

# Example: List available services
# Replace 'service.query' with the actual API method
services = client.call('service.query')
print(f"Services: {services}")

# Close the connection when done
client.close()
```

--------------------------------

### Create Ventoy Vlnk file in Linux

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This method demonstrates how to create a Ventoy Vlnk file using a shell script in a Linux environment. This allows Ventoy to boot ISO files stored on local or network drives without copying them to the USB.

```bash
sudo bash VentoyVlnk.sh -vc path/to/image.iso
```

--------------------------------

### Creating startup.nsh for Automatic GRUB Booting in TrueNAS VM

Source: https://www.truenas.com/docs/scale/25.04/scaletutorials/virtualmachines

This snippet demonstrates how to create a startup.nsh file within the VM's shell to ensure the GRUB bootloader starts automatically on VM startup. It involves navigating to the EFI directory and specifying the GRUB executable.

```shell
edit startup.nsh
FS0:
cd EFI
cd Debian
grubx64.efi
# Use Control+s to save, then Enter.
# Use Control+q to quit.
```

--------------------------------

### Mount NFS Share on Client (Unix-like)

Source: https://www.truenas.com/docs/scale/gettingstarted/configure/setupsharing

This command mounts an NFS share from a TrueNAS server to a local directory on a Unix-like client. It requires the TrueNAS IP address, the dataset path, and the local mount point. Ensure the dataset path is correct and accessible.

```bash
sudo mount -t nfs 10.238.15.194:/mnt/pool1/testds nfstemp/
```

--------------------------------

### Verify NFS Exports on Client (Unix-like)

Source: https://www.truenas.com/docs/scale/gettingstarted/configure/setupsharing

This command allows you to verify the NFS exports available from your TrueNAS system on a Unix-like client. It requires the IP address of the TrueNAS server.

```bash
showmount -e 10.238.15.194
```

--------------------------------

### Create Ventoy VTSI file with Rufus

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This process involves generating a VentoySparseImg.vtsi file and then using Rufus to write this file to a disk. Rufus has specific limitations regarding supported drive types.

```text
1. Enable **Option > Generate VTSI File** in Ventoy UI.
2. Click **Install** to create VentoySparseImg.vtsi.
3. Use Rufus (3.15+) to write the vtsi file to the disk.
   - Select the corresponding disk and vtsi file.
   - Leave other Rufus options at default.
   - Rufus supports USB or removable HDD with USB interface only; local HDD is not supported.
   - For removable HDD, press `Alt+F` to show drive options.
```

--------------------------------

### Example WireGuard Configuration File (/root/wg0.conf)

Source: https://www.truenas.com/docs/core/13.3/coretutorials/network/wireguard

This is a placeholder for the WireGuard configuration file. The actual content depends on your specific network setup and requirements. It defines the WireGuard interface and its connection parameters.

```ini
# Example configuration file. Replace with your actual WireGuard settings.
# See wg-quick manpage for details.
[Interface]
PrivateKey = <Your Private Key>
Address = 10.0.0.2/24

[Peer]
PublicKey = <Peer Public Key>
AllowedIPs = 10.0.0.0/24
Endpoint = <Peer IP Address>:51820
```

--------------------------------

### Example: Mount NFS Share (Basic)

Source: https://www.truenas.com/docs/scale/24.10/scaletutorials/shares/addingnfsshares

An example demonstrating how to mount an NFS share named 'NFS_Share' from a TrueNAS system at '10.239.15.110' to the local directory '/mnt'.

```bash
sudo mount -t nfs 10.239.15.110:/mnt/Pool1/NFS_Share /mnt
```

--------------------------------

### Get Short System Version via CLI

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The 'system version_short' command displays only the software version number of the TrueNAS SCALE system. This command, or 'version', helps in quickly identifying the installed SCALE release number.

```shell
system version_short
22.12.3

```

--------------------------------

### Get Full System Version via CLI

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The 'system version' command displays the full software version name and number for the TrueNAS SCALE system. This command, or 'version_short', can be used to identify the installed SCALE release.

```shell
system version
TrueNAS-SCALE-22.12.3

```

--------------------------------

### TrueNAS CRON Syntax Examples for Scheduling

Source: https://www.truenas.com/docs/scale/25.04/scaletutorials/dataprotection/smarttestsscale

Demonstrates various CRON syntax patterns and their corresponding TrueNAS schedule values for different task scheduling requirements. These examples help users create precise and flexible schedules.

```text
3 times a day (at midnight, 08:00 and 16:00):
  months=*; days=*; hours=0/8 or 0,8,16; minutes=0

Every Monday/Wednesday/Friday, at 8.30 pm:
  months=*; days=mon,wed,fri; hours=20; minutes=30

1st and 15th day of the month, during October to June, at 00:01 am:
  months=oct-dec,jan-jun; days=1,15; hours=0; minutes=1

Every 15 minutes during the working week (8am - 7pm) Monday to Friday (requires two tasks):
Task 1: months=*; days=mon-fri; hours=8-18; minutes=*/15
Task 2: months=*; days=mon-fri; hours=19; minutes=0
```

--------------------------------

### Install and Start iSCSI Service on Debian/Ubuntu

Source: https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/usingiscsishare

This code snippet installs the 'open-iscsi' utility on Debian/Ubuntu systems and starts the 'iscsid' service. Ensure the 'open-iscsi' package is available in your repositories.

```shell
sudo apt update && sudo apt install open-iscsi
sudo service iscsid start
```

--------------------------------

### Format USB drive with FAT32 using diskpart (Windows)

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/install/installingscale

This describes how to format a large USB drive with FAT32 in Windows using the `diskpart` utility, which is necessary for extracting Ventoy LiveCD files. It involves creating a small partition if a direct FAT32 option is unavailable.

```text
1. Open Command Prompt as administrator.
2. Type `diskpart` and press Enter.
3. Type `list disk` to identify the USB drive.
4. Type `select disk X` (replace X with the USB disk number).
5. Type `create partition primary size=4096` (for a 4GB partition).
6. Type `format fs=fat32 quick`.
7. Type `assign` to assign a drive letter.
8. Type `exit` to leave diskpart.
```

--------------------------------

### SFTP Debug File Download Example (CLI)

Source: https://www.truenas.com/docs/scale/24.10/gettingstarted/getting-support

This code snippet demonstrates how to use SFTP from a Windows command prompt to connect to a TrueNAS system, navigate to the user's home directory, download a debug file, and then exit the SFTP session.

```bash
PS C:\Users\tester> sftp admin@exampletruenas.net
Connected to exampletruenas.net.
sftp> cd /home/admin
sftp> get testdebug.tgz
Fetching /home/admin/testdebug.tgz to testdebug.tgz
/home/admin/testdebug.tgz			100% 7110KB	4.1MB/s	00.01
sftp> exit

```

--------------------------------

### Get Next Available User ID using TrueNAS CLI

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/account/cliuser

The `get_next_uid` command displays the next available user identification number (UID). It does not require any properties or values and defaults to starting identification numbers at 3000 for local users.

```bash
account user get_next_uid
# Example Output:
3003
```

--------------------------------

### Get Next GID Command

Source: https://www.truenas.com/docs/scale/22.12/scaleclireference/account/cligroup

The `get_next_gid` command retrieves the next available group identification (GID) number for local groups. By default, it starts GID assignment from 3000. This command is useful for ensuring unique GIDs when creating new groups.

```cli
account group get_next_gid
3000
```

--------------------------------

### Creating startup.nsh for Automatic GRUB Boot

Source: https://www.truenas.com/docs/scale/25.04/scaletutorials/scaletutorialsprint

Instructions for creating the 'startup.nsh' file within the VM's root directory to automate the GRUB boot process. This involves using the TrueNAS shell editor to input the necessary commands.

```shell
edit startup.nsh
FS0:
cd EFI
cd Debian
grubx64.efi
(Press Control+s, then Enter to save. Press Control+q to quit.)
```

--------------------------------

### Access NFS Share on Unix-like Systems

Source: https://www.truenas.com/docs/scale/22.12/gettingstarted/configure/setupsharing

This section provides commands for accessing NFS shares from Unix-like systems. It includes checking exported lists, creating a local mount point, and mounting the NFS share using the `showmount` and `mount` commands.

```bash
tmoore@ChimaeraPrime:~$ showmount -e 10.238.15.194
Export list for 10.238.15.194:
/mnt/pool1/testds (everyone)


```

```bash
tmoore@ChimaeraPrime:~$ sudo mkdir nfstemp/

```

```bash
tmoore@ChimaeraPrime:~$ sudo mount -t nfs 10.238.15.194:/mnt/pool1/testds nfstemp/

```

--------------------------------

### Get SMART Data - Example Command

Source: https://www.truenas.com/docs/references/drive_troubleshooting_flowchart

This command retrieves extended Self-Monitoring, Analysis, and Reporting Technology (SMART) data for a specified drive. It is crucial for diagnosing potential drive failures and understanding drive health. The output is used for interpretation and troubleshooting.

```bash
smartctl –x /dev/???
```

--------------------------------

### Import PGP Public Key using GnuPG

Source: https://www.truenas.com/docs/core/13.0/gettingstarted/install

This snippet demonstrates how to import the iXsystems PGP public key using `gpg` command-line tool. This is a prerequisite for verifying the PGP signature of the TrueNAS ISO file. Ensure you have GnuPG installed.

```bash
q5sys@athena /tmp>  gpg --keyserver keys.openpgp.org --recv-keys 0xc8d62def767c1db0dff4e6ec358eaa9112cf7946
gpg: requesting key 12CF7946 from hkp server keys.openpgp.org
gpg: key 358EAA9112CF7946: "IX SecTeam <security-officer@ixsystems.com>" not changed
gpg: Total number processed: 1
gpg:              unchanged: 1
q5sys@athena /tmp> 
```

--------------------------------

### SFTP Example for Downloading TrueNAS Debug File

Source: https://www.truenas.com/docs/scale/25.04/gettingstarted/getting-support

This example demonstrates how to use SFTP from a Windows command prompt to connect to a TrueNAS system, navigate to the user's home directory, download a debug file, and exit the SFTP session. This is a common method for retrieving system logs needed for troubleshooting.

```shell
PS C:\Users\tester> sftp admin@exampletruenas.net
Connected to exampletruenas.net.
sftp> cd /home/admin
sftp> get testdebug.tgz
Fetching /home/admin/testdebug.tgz to testdebug.tgz
/home/admin/testdebug.tgz			100% 7110KB	4.1MB/s	00.01
sftp> exit


```

--------------------------------

### Get System Information (CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The `info` command returns comprehensive system information, including SCALE version, host name, hardware details, serial number, uptime, timezone, and license status. This command does not require any arguments and outputs a table of details.

```bash
system info
```

--------------------------------

### Create startup.nsh for Automatic GRUB Boot

Source: https://www.truenas.com/docs/scale/24.04/scaletutorials/virtualization

This snippet demonstrates how to create the 'startup.nsh' file within the EFI system partition to ensure the GRUB bootloader runs automatically on VM startup. This automates the manual boot process.

```bash
#!/bin/sh
FS0:
cd EFI
cd Debian
grubx64.efi
```

--------------------------------

### Example: Mount NFS Share with nconnect

Source: https://www.truenas.com/docs/scale/24.10/scaletutorials/shares/addingnfsshares

An example demonstrating how to mount an NFS share with read/write permissions and nconnect enabled (16 connections) from a TrueNAS system at '10.239.15.110' to the local directory '/mnt'.

```bash
sudo mount -t nfs -o rw,nconnect=16 10.239.15.110:/mnt/Pool1/NFS_Share /mnt
```

--------------------------------

### TrueNAS API Error Example: `app_lifecycle.compose_action`

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/printpreview

This code snippet illustrates a common error encountered when manually installed Docker configurations conflict with native TrueNAS Apps configurations in versions 24.10 and later. The error `'group_add[0]' expected type 'string', got unconvertible type 'int', value: '568'` indicates a type mismatch during app lifecycle operations.

```json
{
  "error": {
    "code": 1005,
    "message": "app_lifecycle.compose_action: [middleware.exceptions.MiddlewareError]: [TOMLDecodeError]: group_add[0] expected type 'string', got unconvertible type 'int', value: '568'"
  }
}
```

--------------------------------

### Jail Execution Commands Example

Source: https://www.truenas.com/docs/core/13.0/uireference/uireferenceprint

Specifies commands to be executed during different stages of a jail's lifecycle. These commands can be run within the jail environment or the system environment, allowing for pre-start, start, stop, and post-stop actions. Ensure commands are valid for the specified environment.

```shell
sh /etc/rc
sh /etc/rc.shutdown
```

```shell
sh /etc/rc
```

```shell
sh /etc/rc.shutdown
```

--------------------------------

### TrueNAS Upgrade Paths with ISO Install Focus (Flowchart)

Source: https://www.truenas.com/docs/scale/26.04/gettingstarted/scalereleasenotes

This flowchart specifically highlights upgrade paths that include the 'ISO install' method for TrueNAS. It shows which versions can be reached via a fresh install with configuration restore, in addition to standard updates.

```mermaid
flowchart LR
              A["11.3-U5"] -->|update| B
              B["12.0-U8.1"] -->|update| C
              C["13.0-U6.8"] -->|ISO install| G
              C -->|update| E
              D["23.10.2 (Cobia)"] -->|update| E
              E["24.04.2.5 (Dragonfish)"]  -->|update| F
              F["24.10.2.4 (Electric Eel)"] -->|update| G
              G["25.04.2.4 (Fangtooth)"] -->|"(anticipated)"| H
            H["25.10 (Goldeye)"]
```

--------------------------------

### Set Dataset Compression (CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/storage/clidataset

This example demonstrates setting the compression algorithm for a dataset. Users can choose from various ZFS-supported compression options.

```bash
storage dataset create --name=tank/compressed_data --compression=LZ4
```

--------------------------------

### CRON Syntax Examples for TrueNAS Scheduling

Source: https://www.truenas.com/docs/scale/23.10/scaletutorials/dataprotection/smarttestsscale

This section details various CRON syntax components and their applications in TrueNAS scheduling. It covers wildcards, intervals, comma-separated values, and ranges for defining schedules across minutes, days, and months. These examples help users create precise and flexible task schedules.

```plaintext
Syntax| Meaning| Examples  
---|---|---
*| Every item.| * (minutes) = every minute of the hour.  
* (days) = every day.  
*/N| Every Nth item.| */15 (minutes) = every 15th minute of the hour.  
*/3 (days) = every 3rd day.  
*/3 (months) = every 3rd month.  
Comma and hyphen/dash| Each stated item (comma)  
Each item in a range (hyphen/dash).| 1,31 (minutes) = on the 1st and 31st minute of the hour.  
1-3,31 (minutes) = on the 1st to 3rd minutes inclusive, and the 31st minute, of the hour.  
mon-fri (days) = every Monday to Friday inclusive (every weekday).  
mar,jun,sep,dec (months) = every March, June, September, December.  
You can specify days of the month or days of the week.
```

```plaintext
Desired schedule| Values to enter  
---|---
3 times a day (at midnight, 08:00 and 16:00)| months=*; days=*; hours=0/8 or 0,8,16; minutes=0  
(Meaning: every day of every month, when hours=0/8/16 and minutes=0)  
Every Monday/Wednesday/Friday, at 8.30 pm| months=*; days=mon,wed,fri; hours=20; minutes=30  
1st and 15th day of the month, during October to June, at 00:01 am| months=oct-dec,jan-jun; days=1,15; hours=0; minutes=1  
Every 15 minutes during the working week, which is 8am - 7pm (08:00 - 19:00) Monday to Friday| Note that this requires two tasks to achieve:  
(1) months=*; days=mon-fri; hours=8-18; minutes=*/15  
(2) months=*; days=mon-fri; hours=19; minutes=0  
We need the second scheduled item, to execute at 19:00, otherwise we would stop at 18:45. Another workaround would be to stop at 18:45 or 19:45 rather than 19:00.
```

--------------------------------

### Run TrueCommand Docker Container (Latest Version)

Source: https://www.truenas.com/docs/truecommand/2.3/tcgettingstarted/install/installtcdocker

Fetches and runs the latest version of the TrueCommand Docker image. It maps host directories and ports for container data and web interface access. Ensure Docker is installed and prerequisites are met.

```bash
docker run \--detach -v "/hostdir:/data" -p port:80 -p ssl:443 ixsystems/truecommand:latest
```

--------------------------------

### TrueNAS API Error Example

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes

This snippet shows an example of an error that might occur due to conflicts between manually installed and native Docker configurations after upgrading TrueNAS. The error relates to group addition with an incorrect type.

```text
'group_add[0]' expected type 'string', got unconvertible type 'int', value: '568'
```

--------------------------------

### Show NFS Exports on Unix-Like Systems

Source: https://www.truenas.com/docs/scale/23.10/gettingstarted/configure/setupsharing

Display the NFS export list from a TrueNAS system on a Unix-like client. This command helps verify that the NFS share is correctly configured and accessible.

```bash
showmount -e <IPADDRESS>
```

--------------------------------

### FreeBSD VM Setup for TrueNAS Installation

Source: https://www.truenas.com/docs/core/solutions/integrations/awsdeploy

Commands to set up a virtual machine environment on FreeBSD for TrueNAS installation. This includes loading the vmm module, creating a tap interface, and configuring a bridge interface for network connectivity.

```bash
kldload -n vmm
ifconfig tap0 create
sysctl net.link.tap.up_on_open=1
ifconfig bridge0 create
ifconfig bridge0 addm re0 addm tap0
ifconfig bridge0 up
```

--------------------------------

### Get System Information - TrueNAS CLI

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The `system info` command retrieves comprehensive details about the TrueNAS system, including version, build time, hardware specifications, and uptime. It requires no arguments and outputs a formatted table of system attributes. This command is useful for system monitoring and diagnostics.

```bash
system info
+---------------- -------+-----------------------------------------+
|                version | TrueNAS-SCALE-22.12.3                   |
|              buildtime | 2023-06-12T15:32:03+00:00               |
|               hostname | mini-02                                 |
|                physmem | 83--793856                              |
|                  model | Intel(r) Atom(TM) CPU  C2750  @ 2.40GHz |
|                  cores | 8                                       |
|         physical_cores | 8                                       |
|                loadavg | 2.08                                    |
|                        | 1.15                                    |
|                        | 0.94                                    |
|                 uptime | 5 days, 20:01:40.210144                 |
|         uptime_seconds | 504100.210143554                        |
|          system_serial | A1-12345                                |
|         system_product | AMZ-FREENAS-MINII-XL-24TB-IXN           |
| System_product_version |To Be Filled By O.E.M.                   |
|                license | <dict>                                  |
|               boottime | 2023-06-14T18:54:41+00:00               |
|               datetime | 2023-06-14T14:56:21+00:00               |
|               birthday | <null>                                  |
|               timezone | America/New_York                        |
|    system_manufacturer | IXSYSTEMS                               |
|             ecc_memory | true                                    |
+---------------- -------+-----------------------------------------+
```

--------------------------------

### Start Service Command

Source: https://www.truenas.com/docs/scale/22.12/scaleclireference/service

The `start` command starts a specified service. It requires the 'service' option and returns true on success or false on failure.

```bash
start service=ssh
true
```

--------------------------------

### Start Service (CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/scalecliprint

The `start` command initiates the operation of a specified service. It requires the service name as an argument and returns `true` upon successful startup, or `false` if the service fails to start. This command is used to launch services that are not currently running.

```bash
service start service=ssh
true

```

--------------------------------

### TrueNAS API: Get User Information (Non-Admin)

Source: https://www.truenas.com/docs/truecommand/2.3/api/tc2api

This example shows the reply arguments for a non-administrator making a request to get user information. It details the user's administrative status, active status, username, and UUID.

```JSON
{
 "current_user_id": {
  "isAdministrator": false,
  "is_active": true,
  "username": "myuser",
  "uuid": "current_user_id"
 }
}
```

--------------------------------

### Create startup.nsh to Auto-Run Grub in TrueNAS VM

Source: https://www.truenas.com/docs/scale/22.12/scaletutorials/scaletutorialsprint

This code snippet outlines the process for creating a startup.nsh file within the TrueNAS VM shell. This file automates the execution of the grub file on VM startup, ensuring the OS boots correctly. It includes steps for editing the file and entering the necessary commands.

```shell
edit startup.nsh
FS0:
cd EFI
cd Debian
grubx64.efi
```

--------------------------------

### TrueNAS API: Get User Information (Admin)

Source: https://www.truenas.com/docs/truecommand/2.3/api/tc2api

This example shows the reply arguments for an administrator making a request to get user information. It includes details about allowed groups and servers, administrative status, and user contact information.

```JSON
{
 "user_id_1": {
  "allowed_groups": [
   [
    "group1",
    "r"
   ],
   [
    "group2",
    "r"
   ]
  ],
  "allowed_servers": [
   [
    "server1",
    "r/w"
   ],
   [
    "server2",
    "r"
   ]
  ],
  "create_alerts": false,
  "extra_info": {
   "email": "sysadmin1@somewhere.net",
   "full_name": "SysAdmin 1"
  },
  "isAdministrator": false,
  "is_active": true,
  "username": "user1",
  "uuid": "user_id_1"
 },
 "user_id_2": {
  "allowed_groups": [
   [
    "group1",
    "r/w"
   ],
   [
    "group2",
    "r/w"
   ]
  ],
  "allowed_servers": [
   [
    "server1",
    "r/w"
   ],
   [
    "server2",
    "r/w"
   ]
  ],
  "create_alerts": null,
  "extra_info": {
   "email": "sysadmin2@somewhere.net",
   "phone_number": "123-456-7890"
  },
  "isAdministrator": true,
  "username": "user2",
  "uuid": "user_id_2"
 }
}
```

--------------------------------

### Connect Temporarily to SMB Share on Windows

Source: https://www.truenas.com/docs/scale/scaletutorials/shares/smb

Instructions for temporarily connecting to an SMB share on Windows using File Explorer. This method prompts for credentials each time or after a system restart.

```batch
In Windows File Explorer, navigate to: \\_TrueNAS_name_\_share_name_
```

--------------------------------

### CRON Syntax Examples for TrueNAS Scheduling

Source: https://www.truenas.com/docs/scale/25.04/scaletutorials/scaletutorialsprint

Examples demonstrating how to use CRON syntax for defining various scheduling patterns in TrueNAS. This includes specifying minutes, hours, days, and months.

```text
* (minutes) = every minute of the hour.
* (days) = every day.
*/15 (minutes) = every 15th minute of the hour.
*/3 (days) = every 3rd day.
*/3 (months) = every 3rd month.
1,31 (minutes) = on the 1st and 31st minute of the hour.
1-3,31 (minutes) = on the 1st to 3rd minutes inclusive, and the 31st minute, of the hour.
mon-fri (days) = every Monday to Friday inclusive (every weekday).
mar,jun,sep,dec (months) = every March, June, September, December.
```

```text
months=*; days=*; hours=0/8 or 0,8,16; minutes=0  (3 times a day: midnight, 08:00 and 16:00)
months=*; days=mon,wed,fri; hours=20; minutes=30  (Every Monday/Wednesday/Friday, at 8.30 pm)
months=oct-dec,jan-jun; days=1,15; hours=0; minutes=1  (1st and 15th day of the month, October to June, at 00:01 am)
months=*; days=mon-fri; hours=8-18; minutes=*/15  (Every 15 minutes during the working week, 8am - 7pm Monday to Friday - Part 1)
months=*; days=mon-fri; hours=19; minutes=0  (Every 15 minutes during the working week, 8am - 7pm Monday to Friday - Part 2)
```

--------------------------------

### PGP Signature Verification with GnuPG

Source: https://www.truenas.com/docs/scale/25.04/gettingstarted/install/installingscale

Verifies the integrity of a TrueNAS ISO file using its PGP signature. This process involves importing the public key and then using `gpg --verify` to compare the signature file with the ISO. Requires GnuPG installed on the system.

```bash
user@ubuntu /tmp> gpg --keyserver keys.gnupg.net --recv-keys 0xc8d62def767c1db0dff4e6ec358eaa9112cf7946
gpg: DBG: Using CREATE_BREAKAWAY_FROM_JOB flag
gpg: key 358EAA9112CF7946: public key "IX SecTeam <security-officer@ixsystems.com>" imported
gpg: DBG: Using CREATE_BREAKAWAY_FROM_JOB flag
gpg: Total number processed: 1
gpg:               imported: 1
```

```bash
user@ubuntu /tmp>  gpg --verify TrueNAS-SCALE-21.04-ALPHA.1.iso
gpg: Signature made Thu May 27 10:49:02 2021 EDT using RSA key ID 12CF7946
gpg: Good signature from "IX SecTeam <security-officer@ixsystems.com>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: C8D6 2DEF 767C 1DB0 DFF4  E6EC 358E AA91 12CF 7946
```

--------------------------------

### Example Memory Allocation Input

Source: https://www.truenas.com/docs/scale/25.04/scaleuireference/virtualmachinesscreens

Demonstrates the human-readable format for specifying memory allocation for virtual machines. Units like GiB, M, and TB are supported, with a default of Mebibytes (MiB) if no unit is provided.

```text
50 GiB
```

```text
500M
```

```text
2 TB
```

--------------------------------

### Check Local Administrator Setup CLI Command

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/account/cliuser

The `has_local_administrator_set_up` command checks if a local administrator account is configured. It does not require any properties or values and can be executed from the main CLI prompt or the 'account' prompt. The command returns a boolean value indicating the setup status.

```bash
account user has_local_administrator_set_up
true
```

--------------------------------

### Run TrueCommand Docker Container (Nightly Version)

Source: https://www.truenas.com/docs/truecommand/2.3/tcgettingstarted/install/installtcdocker

Fetches and runs the nightly build of the TrueCommand Docker image. This is intended for testing purposes only and should not be used on production systems. Ensure Docker is installed and prerequisites are met.

```bash
docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ixsystems/truecommand:nightly
```

--------------------------------

### Configure Network Interface - Manual IPv4 Setup

Source: https://www.truenas.com/docs/core/13.3/gettingstarted/consolesetupmenu

This snippet demonstrates the manual configuration of a network interface in TrueNAS when DHCP is not used. It guides through setting up IPv4 addressing using CIDR notation or separate IP and Netmask values. This process is crucial for systems without DHCP or when static IP assignment is required.

```text
Enter an option from 1-12: 1
1) em0
Select an interface (q to quit): 1
Remove the current settings of this interface? (This causes a momentary disconnection of the network.) (y/n) n
Configure interface for DHCP? (y/n) n
Configure IPv4? (y/n) y
Interface name:     (press enter, the name can be blank)
Several input formats are supported
Example 1 CIDR Notation:
    192.168.1.1/24
Example 2 IP and Netmask separate:
    IP: 192.168.1.1
    Netmask: 255.255.255.0, or /24 or 24
IPv4 Address: 192.168.1.108/24
Saving interface configuration: Ok
Configure IPv6? (y/n) n
Restarting network: ok

...

The web user interface is at
http://192.168.1.108
```

--------------------------------

### TrueNAS Cron Syntax Examples

Source: https://www.truenas.com/docs/scale/24.04/scaletutorials/dataprotection/replication/advancedreplication

Examples of cron syntax for scheduling tasks in TrueNAS. Covers basic wildcards, intervals, and specific time/day/month combinations. Useful for defining precise task execution schedules.

```cron
* (minutes) = every minute of the hour.
* (days) = every day.
```

```cron
*/15 (minutes) = every 15th minute of the hour.
*/3 (days) = every 3rd day.
*/3 (months) = every 3rd month.
```

```cron
1,31 (minutes) = on the 1st and 31st minute of the hour.
1-3,31 (minutes) = on the 1st to 3rd minutes inclusive, and the 31st minute, of the hour.
mon-fri (days) = every Monday to Friday inclusive (every weekday).
mar,jun,sep,dec (months) = every March, June, September, December.
```

```cron
months=*; days=*; hours=0/8 or 0,8,16; minutes=0
```

```cron
months=*; days=mon,wed,fri; hours=20; minutes=30
```

```cron
months=oct-dec,jan-jun; days=1,15; hours=0; minutes=1
```

```cron
months=*; days=mon-fri; hours=8-18; minutes=*/15
```

```cron
months=*; days=mon-fri; hours=19; minutes=0
```

--------------------------------

### Verify TrueNAS ISO SHA256 Checksum by Operating System

Source: https://www.truenas.com/docs/scale/24.10/gettingstarted/install/installingscale

These commands demonstrate how to verify the SHA256 checksum of a TrueNAS ISO file across different operating systems. The generated checksum must match the one provided in the `sha256.txt` file for the installer to be considered uncorrupted. Using different checksums indicates a corrupted file.

```bash
# BSD:
sha256 isofile

# Linux:
sha256sum isofile

# Mac:
shasum -a 256 isofile

# Windows:
certutil -hashfile "path to sha256 file"
```

--------------------------------

### Configure External SMB Share with Earlier Release

Source: https://www.truenas.com/docs/scale/scaletutorials/shares/smb

Specific configuration for setting up external SMB shares between TrueNAS systems on different releases. Involves unique path formats for each system depending on the release.

```bash
TrueNAS 25.04 system: Path field: EXTERNAL:_ipaddress\sharename_
TrueNAS 25.10 system: Remote Path field: _ipaddress_ *sharename*
```

--------------------------------

### Simplified TrueNAS Installation Script for bhyve

Source: https://www.truenas.com/docs/core/solutions/integrations/awsdeploy

A shell script command that simplifies the bhyve VM execution for TrueNAS installation. It combines several parameters from the manual bhyve command, including memory, tap device, image file, and ISO path.

```bash
sh /usr/share/examples/bhyve/vmrun.sh -c 2 -m 4GB -t tap0 -d {TRUENAS}.img -i -I {TRUENAS-VERSION}.iso vm0
```

--------------------------------

### SFTP Connection String Example

Source: https://www.truenas.com/docs/scale/22.12/scaletutorials/systemsettings/services/sshservicescale

An example of how to construct an SFTP connection string for clients like FileZilla. This specifies the protocol, TrueNAS IP address, username, password, and port.

```plaintext
SFTP://{TrueNAS IP} {username} {password} {port 22}
```

--------------------------------

### Get System Environment (CLI)

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The `environment` command returns the current environment in which the product is running. Possible values are DEFAULT or EC2. This command does not require any arguments.

```bash
system environment
```

--------------------------------

### Create Directory for NFS Mount on Unix-Like Systems

Source: https://www.truenas.com/docs/scale/23.10/gettingstarted/configure/setupsharing

Create a local directory on a Unix-like system to serve as the mount point for an NFS share. This directory will be used to access the files on the TrueNAS share.

```bash
sudo mkdir nfstemp/
```

--------------------------------

### TrueNAS API Client Interaction Example (Python)

Source: https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes

Demonstrates how advanced users can interact with the TrueNAS API using the `midclt` command-line tool via Python. This allows for programmatic management of TrueNAS instances.

```python
# Example of using midclt for API calls (conceptual)
# from midclt.client import Client
# client = Client()
# result = client.call_sync('core.get_version')
# print(result)
```

--------------------------------

### Setup Individual SED Password with sedhelper

Source: https://www.truenas.com/docs/scale/24.10/scaletutorials/storage/disks/sedscale

Configures a specific Self-Encrypting Drive (SED) with an individual password, overriding any global password settings. This is useful for granular control over SED security.

```shell
root@truenas1:~ # sedhelper setup --disk <da1> <password>

```

--------------------------------

### Get Node Serial Number with dmidecode

Source: https://www.truenas.com/docs/hardware/legacyhardware/zseries/zseriesnode

This command retrieves the serial number of a node, which is crucial for identifying the correct component for replacement. It requires shell access to the TrueNAS system.

```shell
dmidecode -t1
```

--------------------------------

### Manually Boot GRUB EFI in TrueNAS VM

Source: https://www.truenas.com/docs/scale/22.12/scaletutorials/virtualization/creatingmanagingvmsscale

This snippet demonstrates the manual steps to execute the GRUB EFI bootloader from the TrueNAS VM shell when it does not start automatically. It requires navigating to the EFI directory and running the grubx64.efi file.

```shell
FS0:
cd EFI
cd Debian
grubx64.efi
```

--------------------------------

### Provision OTP URI - TrueNAS CLI

Source: https://www.truenas.com/docs/scale/22.12/scaleclireference/scalecliprint

The `provisioning_uri` command generates the OTP provisioning URI for authenticator app QR encoding. It requires no arguments and outputs the URI upon execution.

```bash
auth two_factor provisioning_uri
otpauth://totp/mysystems:truenas%50TrueNAS?secret=Noni&is...
```

--------------------------------

### Configure Network Interface - TrueNAS CLI Example

Source: https://www.truenas.com/docs/core/13.0/gettingstarted/coregettingstartedprint

This example demonstrates the command-line prompts and user inputs for configuring a network interface on TrueNAS. It covers setting up IPv4 addresses, netmasks, and restarting network services. The process involves selecting an interface, choosing whether to remove current settings, opting out of DHCP, and providing IPv4 details in CIDR or IP/Netmask format.

```text
Enter an option from 1-12: 1
1) em0
Select an interface (q to quit): 1
Remove the current settings of this interface? (This causes a momentary disconnection of the network.) (y/n) n
Configure interface for DHCP? (y/n) n
Configure IPv4? (y/n) y
Interface name:     (press enter, the name can be blank)
Several input formats are supported
Example 1 CIDR Notation:
    192.168.1.1/24
Example 2 IP and Netmask separate:
    IP: 192.168.1.1
    Netmask: 255.255.255.0, or /24 or 24
IPv4 Address: 192.168.1.108/24
Saving interface configuration: Ok
Configure IPv6? (y/n) n
Restarting network: ok

... 

The web user interface is at
http://192.168.1.108

```

--------------------------------

### Get Product Name - TrueNAS CLI

Source: https://www.truenas.com/docs/scale/23.10/scaleclireference/system

The `system product_name` command returns the name of the product, which is 'TrueNAS'. This command requires no arguments and is useful for confirming the system's product identity.

```bash
system product_name
TrueNAS
```

--------------------------------

### Mount SMB Share on Linux

Source: https://www.truenas.com/docs/scale/23.10/scaletutorials/shares/smb/addsmbshares

Instructions for mounting an SMB share on a Linux system. This requires CIFS packages and involves creating a mount point and using the mount command. User credentials can be provided if necessary.

```shell
sudo mkdir /mnt/smb_share
sudo mount -t cifs //computer_name/share_name /mnt/smb_share
sudo mount -t cifs -o username=your_username //computer_name/share_name /mnt/smb_share
```

--------------------------------

### Update TrueCommand Docker Container

Source: https://www.truenas.com/docs/truecommand/3.0/tcgettingstarted/install/installtcdocker

Shell commands for updating the TrueCommand Docker container. This process involves removing the existing container and starting a new one with the latest image while preserving the existing storage volume.

```shell
docker rm TrueCmd_contained
```

```shell
docker run --name <_the name to call the container_> -v "<_local host directory_>:/data" -p :80 :443 --detach ghcr.io/ixsystems/truecommand:_v3.0.2_
```

--------------------------------

### Creating Ventoy Vlnk Files in Windows

Source: https://www.truenas.com/docs/scale/gettingstarted/install/installingscale

This snippet shows how to create a Ventoy Vlnk file in Windows using the VentoyVlnk.exe utility. It allows for direct generation of the Vlnk file with specified ISO and link names, or interactive mode for saving the path after selecting the ISO.

```batch
VentoyVlnk.exe -i _filename_.iso -o _linkname_.vlnk.iso
```

```batch
VentoyVlnk.exe -s
```

--------------------------------

### Run Long NVMe Self-Test (SCALE)

Source: https://www.truenas.com/docs/references/drive_troubleshooting_flowchart

Starts a comprehensive long self-test for NVMe drives in TrueNAS SCALE. This command performs an extended diagnostic scan on the NVMe storage device.

```bash
nvme device-self-test /dev/nvme0 -s 2
```
Tokens:
Raw