iXsystems TrueNAS 11.3-U5 User manual

TrueNAS®11.3-U5 User Guide

Note: Starting with version 12.0, FreeNAS and TrueNAS are unifying (https://www.ixsystems.com/blog/freenas-
truenas-unification/.) into “TrueNAS”. Documentation for TrueNAS 12.0 and later releases has been unified and
moved to the TrueNAS Documentation Hub (https://www.truenas.com/docs/).
Copyright iXsystems 2011-2020
TrueNAS®and the TrueNAS®logo are registered trademarks of iXsystems.

CONTENTSWelcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Typographic Conventions ................................................ 9
1 Introduction 10
1.1 Contacting iXsystems ............................................... 10
1.2 Path and Name Lengths ............................................. 10
1.3 Using the Web Interface ............................................. 12
1.3.1 Tables and Columns ........................................... 12
1.3.2 Advanced Scheduler ........................................... 12
1.3.3 Schedule Calendar ............................................ 13
1.3.4 Changing TrueNAS®Settings ...................................... 13
1.3.5 Web Interface Troubleshooting ..................................... 14
1.3.6 Help Text ................................................. 14
1.3.7 Humanized Fields ............................................ 14
1.3.8 File Browser ................................................ 14
2 Initial Setup 15
2.1 Hardware Setup .................................................. 15
2.2 Console Setup Menu ............................................... 15
2.3 Accessing the Web Interface ........................................... 17
2.3.1 Web Interface Troubleshooting ..................................... 19
3 Settings 20
3.1 Change Password ................................................. 20
3.2 Preferences .................................................... 20
3.2.1 Web Interface Preferences ....................................... 20
3.2.2 Themes .................................................. 21
3.2.2.1 Create New Themes ....................................... 21
3.3 API Documentation ................................................ 23
3.4 About ........................................................ 23
3.5 Legacy Web Interface ............................................... 23
4 Accounts 24
4.1 Groups ....................................................... 24
4.2 Users ........................................................ 27
5 System 32
5.1 General ....................................................... 32
5.2 NTP Servers .................................................... 35
5.3 Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.3.1 Operating System Device Mirroring .................................. 38
5.4 Advanced ...................................................... 39
5.4.1 Autotune ................................................. 41
5.4.2 Self-Encrypting Drives .......................................... 41
3

5.4.2.1 Deploying SEDs ......................................... 42
5.4.2.2 Check SED Functionality .................................... 43
5.4.2.3 Managing SED Passwords and Data .............................. 44
5.5 View Enclosure .................................................. 45
5.6 Email ........................................................ 47
5.7 System Dataset .................................................. 48
5.8 Reporting ...................................................... 50
5.9 Alert Services ................................................... 50
5.10 Alert Settings .................................................... 52
5.11 Cloud Credentials ................................................. 53
5.12 SSH Connections ................................................. 57
5.12.1 Manual Setup ............................................... 59
5.12.2 Semi-Automatic Setup .......................................... 60
5.13 SSH Keypairs .................................................... 61
5.14 Tunables ...................................................... 61
5.15 Update ....................................................... 64
5.15.1 Preparing for Updates .......................................... 64
5.15.2 Updates and Trains ........................................... 65
5.15.3 Checking for Updates .......................................... 65
5.15.4 Saving the Configuration File ...................................... 67
5.15.5 Applying Updates ............................................. 68
5.15.6 Manual Updates ............................................. 68
5.15.7 Update in Progress ............................................ 69
5.15.8 Updating from the Shell ......................................... 69
5.15.9 Updating an HA System ......................................... 69
5.15.10If Something Goes Wrong ........................................ 71
5.15.11Upgrading a ZFS Pool .......................................... 71
5.16 CAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
5.17 Certificates ..................................................... 76
5.18 Failover ....................................................... 81
5.19 Support ....................................................... 84
5.19.1 License Information ........................................... 85
5.19.2 Proactive Support ............................................ 85
5.19.3 Contact Support ............................................. 86
6 Tasks 87
6.1 Cron Jobs ...................................................... 87
6.2 Init/Shutdown Scripts ............................................... 89
6.3 Rsync Tasks .................................................... 90
6.3.1 Rsync Module Mode ........................................... 93
6.3.2 Rsync over SSH Mode .......................................... 93
6.4 S.M.A.R.T. Tests .................................................. 96
6.5 Periodic Snapshot Tasks ............................................. 97
6.5.1 Snapshot Autoremoval ......................................... 99
6.6 Replication .....................................................100
6.6.1 Replication Creation Wizard .......................................100
6.6.2 Advanced Replication Creation .....................................103
6.6.3 Replication Tasks .............................................107
6.6.4 Limiting Replication Times ........................................107
6.6.5 Replication Topologies and Scenarios .................................108
6.6.5.1 Star Replication .........................................108
6.6.5.2 Tiered Replication ........................................108
6.6.5.3 N-way Replication ........................................108
6.6.5.4 Disaster Recovery ........................................108
6.6.6 Troubleshooting Replication ......................................109
6.6.6.1 SSH ................................................109
6.6.6.2 Compression ...........................................109

6.6.6.3 Manual Testing ..........................................109
6.7 Resilver Priority ..................................................110
6.8 Scrub Tasks ....................................................111
6.9 Cloud Sync Tasks .................................................113
6.9.1 Cloud Sync Example ...........................................116
7 Network 119
7.1 Global Configuration ...............................................119
7.2 Interfaces .....................................................121
7.2.1 Network Bridges .............................................124
7.2.2 Link Aggregations ............................................124
7.2.2.1 LACP, MPIO, NFS, and ESXi ...................................125
7.2.2.2 Creating a Link Aggregation ..................................125
7.2.2.3 Link Aggregation Options ....................................125
7.2.3 VLANs ...................................................126
7.3 IPMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
7.4 Network Summary ................................................128
7.5 Static Routes ....................................................128
8 Storage 130
8.1 Swap Space ....................................................130
8.2 Pools ........................................................130
8.2.1 Creating Pools ..............................................131
8.2.2 Managing Encrypted Pools .......................................133
8.2.2.1 Encryption and Recovery Keys .................................135
8.2.2.2 Encryption Operations .....................................135
8.2.3 Adding Cache or Log Devices ......................................136
8.2.4 Removing Cache or Log Devices ....................................137
8.2.5 Adding Spare Devices ..........................................137
8.2.6 Extending a Pool .............................................137
8.2.7 Export/Disconnect a Pool ........................................137
8.2.8 Importing a Pool .............................................139
8.2.9 Viewing Pool Scrub Status ........................................141
8.2.10 Adding Datasets .............................................142
8.2.10.1 Compression ...........................................145
8.2.11 Adding Zvols ...............................................145
8.2.12 Setting Permissions ...........................................147
8.2.13 ACL Management .............................................148
8.3 Snapshots .....................................................152
8.3.1 Browsing a Snapshot Collection ....................................153
8.3.2 Creating a Single Snapshot .......................................154
8.4 VMware-Snapshots ................................................155
8.5 Disks ........................................................156
8.5.1 Replacing a Failed Disk ..........................................158
8.5.1.1 Removing a Log or Cache Device ...............................161
8.5.2 Replacing Disks to Grow a Pool .....................................161
8.6 Importing a Disk ..................................................162
8.7 Multipaths .....................................................163
9 Overprovisioning 164
10 Directory Services 165
10.1 Active Directory ..................................................165
10.1.1 Leaving the Domain ...........................................170
10.1.2 Troubleshooting Tips ...........................................170
10.2 LDAP ........................................................170
10.3 NIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
10.4 Kerberos Realms .................................................174

10.5 Kerberos Keytabs .................................................175
10.6 Kerberos Settings .................................................176
11 Sharing 177
11.1 Apple (AFP) Shares ................................................178
11.1.1 Creating AFP Guest Shares .......................................180
11.2 Block (iSCSI) ....................................................183
11.2.1 iSCSI Wizard ................................................184
11.2.2 Target Global Configuration .......................................185
11.2.3 Portals ...................................................186
11.2.4 Initiators ..................................................187
11.2.5 Authorized Access ............................................189
11.2.6 Targets ...................................................190
11.2.7 Extents ...................................................192
11.2.8 Associated Targets ............................................194
11.2.9 Fibre Channel Ports ...........................................196
11.2.10Connecting to iSCSI ............................................198
11.2.11Growing LUNs ..............................................199
11.2.11.1Zvol Based LUN .........................................199
11.2.11.2File Extent Based LUN ......................................200
11.3 Unix (NFS) Shares .................................................201
11.3.1 Example Configuration .........................................204
11.3.2 Connecting to the Share .........................................204
11.3.2.1 From BSD or Linux ........................................204
11.3.2.2 From Microsoft .........................................205
11.3.2.3 From macOS ...........................................205
11.3.3 Troubleshooting NFS ...........................................206
11.4 WebDAV Shares ..................................................207
11.5 Windows (SMB) Shares ..............................................209
11.5.1 Configuring Unauthenticated Access ..................................215
11.5.2 Configuring Authenticated Access With Local Users .........................216
11.5.3 User Quota Administration .......................................218
11.5.4 Configuring Shadow Copies .......................................218
11.6 Creating Authenticated and Time Machine Shares ..............................218
11.6.1 Setting SMB and AFP Share Quotas ..................................220
11.6.2 Client Time Machine Configuration ...................................221
12 Services 222
12.1 Configure Services ................................................222
12.2 AFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
12.2.1 Troubleshooting AFP ...........................................225
12.3 Dynamic DNS ...................................................225
12.4 FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
12.4.1 Anonymous FTP .............................................229
12.4.2 FTP in chroot ...............................................230
12.4.3 Encrypting FTP ..............................................231
12.4.4 Troubleshooting FTP ...........................................231
12.5 iSCSI ........................................................231
12.6 LLDP ........................................................231
12.7 NFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
12.8 Rsync ........................................................234
12.8.1 Configure Rsyncd .............................................234
12.8.2 Rsync Modules ..............................................235
12.9 S3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
12.10S.M.A.R.T. ......................................................238
12.11SMB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
12.11.1Troubleshooting SMB ..........................................242

12.12SNMP ........................................................242
12.13SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
12.13.1SCP Only ..................................................246
12.13.2Troubleshooting SSH ...........................................246
12.14TFTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
12.15UPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
12.15.1Multiple Computers with One UPS ...................................251
12.16WebDAV ......................................................251
13 Plugins 254
13.1 Installing Plugins .................................................254
13.2 Updating Plugins .................................................256
13.3 Uninstalling Plugins ................................................257
13.4 Asigra Plugin ....................................................258
14 Jails 260
14.1 Jail Storage .....................................................260
14.2 Creating Jails ....................................................261
14.2.1 Jail Wizard .................................................261
14.2.2 Advanced Jail Creation ..........................................263
14.2.2.1 Creating Template Jails .....................................271
14.3 Managing Jails ...................................................271
14.3.1 Jail Updates and Upgrades .......................................273
14.3.2 Accessing a Jail Using SSH ........................................273
14.3.3 Additional Storage ............................................275
14.4 Jail Software ....................................................278
14.4.1 Installing FreeBSD Packages .......................................278
14.4.2 Compiling FreeBSD Ports ........................................279
14.4.3 Starting Installed Software .......................................282
15 Reporting 285
16 Virtual Machines 288
16.1 Creating VMs ....................................................290
16.2 Installing Docker ..................................................293
16.3 Adding Devices to a VM ..............................................293
16.3.1 CD-ROM Devices .............................................294
16.3.2 NIC (Network Interfaces) .........................................295
16.3.3 Disk Devices ................................................296
16.3.4 Raw Files ..................................................297
16.3.5 VNC Interface ...............................................298
17 vCenter Plugin 300
18 Additional Options 301
18.1 Display System Processes ............................................301
18.2 Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
18.3 Log Out, Restart, or Shut Down .........................................303
18.3.1 Log Out ..................................................303
18.3.2 Restart ...................................................303
18.3.3 Shut down .................................................304
18.4 Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
19 Task Manager 308
20 ZFS Primer 309
20.1 ZFS Feature Flags .................................................312

21 VMware Recommendations 313
21.1 TrueNAS®as a VMware Guest ..........................................313
21.2 Hosting VMware Storage with TrueNAS®....................................313
21.3 VAAI for iSCSI ...................................................314
22 Using the API 315
22.1 A Simple API Example ...............................................316
22.2 A More Complex Example ............................................317
23 User Guide 319
24 Appendix A: End-User License Agreement 320
25 Appendix B: TrueNAS®Product Catalog 324
25.1 TrueNAS®Unified Storage Arrays ........................................324
25.1.1 X-Series ..................................................324
25.1.2 M-Series ..................................................325
25.2 Expansion Shelves ................................................325
25.2.1 ES12 ....................................................325
25.2.2 ES24 ....................................................326
25.2.3 ES60 ....................................................326
WelcomeWelcome to the TrueNAS®User Guide.
TrueNAS®and the TrueNAS®logo are registered trademarks of iXsystems.
Active Directory®is a registered trademark or trademark of Microsoft Corporation in the United States and/or other
countries.
Apple, Mac and Mac OS are trademarks of Apple Inc., registered in the U.S. and other countries.
Asigra Inc. Asigra, the Asigra logo, Asigra Cloud Backup, Recovery is Everything, Recovery Tracker and Attack-Loop
are trademarks of Asigra Inc.
Chelsio®is a registered trademark of Chelsio Communications.
Cisco®is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and
certain other countries.
FreeBSD®and the FreeBSD®logo are registered trademarks of the FreeBSD Foundation®.
Linux®is a registered trademark of Linus Torvalds.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
UNIX®is a registered trademark of The Open Group.
VMware®is a registered trademark of VMware, Inc.
Wikipedia®is a registered trademark of the Wikimedia Foundation, Inc., a non-profit organization.
Windows®is a registered trademark of Microsoft Corporation in the United States and other countries.
8

TypographicConventionsTypographic Conventions
The TrueNAS®Administrator Guide uses these typographic conventions:
Table 1: Text Format Examples
Item Visual Example
Graphical elements: buttons, icons, fields, columns,
and boxes
Click the Import CA button.
Menu selections Select System →Information.
Commands Use the scpcommand.
File names and pool and dataset names Locate the /etc/rc.conffile.
Keyboard keys Press the Enterkey.
Important points This is important.
Values entered into fields, or device names Enter 127.0.0.1 in the address field.
Table 2: TrueNAS®Icons
Icon Usage
ADD Add a new item.
(Settings) Show a settings menu.
(Options) Show an Options menu.
(Browse) Shows an expandable view of system directories.
(Power) Show a power options menu.
(Show) Reveal characters in a password field.
(Hide) Hide characters in a password field.
(Configure) Edit settings.
襁(Launch) Launch a service.
(Start) Start jails.
(Stop) Stop jails.
(Update) Update jails.
(Delete) Delete jails.
(Encryption Options) Encryption options for a pool.
(Pin) Pin a help box to the screen.
(Close) Close a help box.
9

CHAPTERONEINTRODUCTIONThis Guide provides information about configuring and managing the TrueNAS®Unified Storage Array. Your iXsys-
tems support engineer will assist with the initial setup and configuration of the array. After becoming familiar with
the configuration workflow, this document can be used as a reference guide to the many features provided by
TrueNAS®.
1.1ContactingiXsystemsFor assistance, please contact iX Support:
Contact Method Contact Options
Web https://support.ixsystems.com
Email [email protected]Telephone Monday - Friday, 6:00AM to 6:00PM Pacific Standard Time:
• US-only toll-free: 855-473-7449 option 2
• Local and international: 408-943-4100 option 2
Telephone After Hours (24x7 Gold Level Support only):
• US-only toll-free: 855-499-5131
• International: 408-878-3140 (international calling rates will
apply)
1.2PathandNameLengthsNames of files, directories, and devices are subject to some limits imposed by the FreeBSD operating system. The
limits shown here are for names using plain-text characters that each occupy one byte of space. Some UTF-8 char-
acters take more than a single byte of space, and using those characters reduces these limits proportionally. System
overhead can also reduce the length of these limits by one or more bytes.
10

Table 1.2: Path and Name Lengths
Type Maximum
Length
Description
File Paths 1023 bytes Total file path length (PATH_MAX). The full path includes directory
separator slash characters, subdirectory names, and the name
of the file itself. For example, the path /mnt/tank/mydataset/mydirectory/myfile.txtis 42 bytes long.
Using very long file or directory names can be problematic. If a path
with long directory and file names exceeds the 1023-byte limit, it pre-
vents direct access to that file until the directory names or filename
are shortened or the file is moved into a directory with a shorter total
path length.
File and Directory Names 255 bytes Individual directory or file name length (NAME_MAX).
Mounted Filesystem
Paths
88 bytes Mounted filesystem path length (MNAMELEN). Longer paths can pre-
vent a device from being mounted.
Device Filesystem Paths 63 bytes devfs(8) (https://www.freebsd.org/cgi/man.cgi?query=devfs) device
path lengths (SPECNAMELEN). Longer paths can prevent a device from
being created.
Note: 88 bytes is equal to 88 ASCII characters. The number of characters varies when using Unicode.
Warning: If the mounted path length for a snapshot exceeds 88 bytes, the data in the snapshot is safe but
inaccessible. When the mounted path length of the snapshot is less than the 88 byte limit, the data will be
accessible again.
The 88 byte limit affects automatic and manual snapshot mounts in slightly different ways:
•Automatic mount: ZFS temporarily mounts a snapshot whenever a user attempts to view or search the files
within the snapshot. The mountpoint used will be in the hidden directory .zfs/snapshot/namewithin the
same ZFS dataset. For example, the snapshot mypool/dataset/snap1@snap2is mounted at /mnt/mypool/dataset/.zfs/snapshot/snap2/. If the length of this path exceeds 88 bytes the snapshot will not be au-
tomatically mounted by ZFS and the snapshot contents will not be visible or searchable. This can be resolved
by renaming the ZFS pool or dataset containing the snapshot to shorter names (mypoolor dataset), or by
shortening the second part of the snapshot name (snap2), so that the total mounted path length does not
exceed 88 bytes. ZFS will automatically perform any necessary unmount or remount of the file system as part
of the rename operation. After renaming, the snapshot data will be visible and searchable again.
•Manual mount: The same example snapshot is mounted manually from the Shell (page 302) with mount-tzfsmypool/dataset/snap1@snap2/mnt/mymountpoint. The path /mnt/mountpoint/must not ex-
ceed 88 bytes, and the length of the snapshot name is irrelevant. When renaming a manual mountpoint, any
object mounted on the mountpoint must be manually unmounted with the umountcommand before renam-
ing the mountpoint. It can be remounted afterwards.
Note: A snapshot that cannot be mounted automatically by ZFS can still be mounted manually from the Shell
(page 302) with a shorter mountpoint path. This makes it possible to mount and access snapshots that cannot
be accessed automatically in other ways, such as from the web interface or from features such as “File History” or
“Versions”.
11

1.3UsingtheWebInterface1.3.1TablesandColumnsTables show a subset of all available columns. Additional columns can be shown or hidden with the COLUMNS button.
Set a checkmark by the fields to be shown in the table. Column settings are remembered from session to session.
The original columns can be restored by clicking Reset to Defaults in the column list.
Each row in a table can be expanded to show all the information by clicking the (Expand) button.
1.3.2AdvancedSchedulerWhen choosing a schedule for different TrueNAS®Tasks (page 87), clicking Custom opens the custom schedule dialog.
Fig. 1.1: Creating a Custom Schedule
Choosing a preset schedule fills in the rest of the fields. To customize a schedule, enter crontab
(https://www.freebsd.org/cgi/man.cgi?query=crontab&sektion=5) values for the Minutes/Hours/Days.
12

These fields accept standard cronvalues. The simplest option is to enter a single number in the field. The task
runs when the time value matches that number. For example, entering 10means that the job runs when the time
is ten minutes past the hour.
An asterisk (*) means “match all values”.
Specific time ranges are set by entering hyphenated number values. For example, entering 30-35in the Minutes
field sets the task to run at minutes 30, 31, 32, 33, 34, and 35.
Lists of values can also be entered. Enter individual values separated by a comma (,). For example, entering 1,14in the Hours field means the task runs at 1:00 AM (0100) and 2:00 PM (1400).
A slash (/) designates a step value. For example, while entering *in Days means the task runs every day of the
month, */2means the task runs every other day.
Combining all these examples together creates a schedule running a task each minute from 1:30-1:35 AM and
2:30-2:35 PM every other day.
There is an option to select which Months the task will run. Leaving each month unset is the same as selecting ev-
ery month.
The Days of Week schedules the task to run on specific days. This is in addition to any listed Days. For example, en-
tering 1in Days and setting Wfor Days of Week creates a schedule that starts a task on the first day of the month
and every Wednesday of the month.
Schedule Preview shows when the current schedule settings will cause the task to run.
1.3.3ScheduleCalendarThe Schedule column has a calendar icon (). Clicking this icon opens a dialog showing scheduled dates and times
for the related task to run.
Fig. 1.2: Example Schedule Popup
Scrub Tasks (page 111) can have a number of Threshold days set. The configured scrub task continues to follow the
displayed calendar schedule, but it does not run until the configured number of threshold days have elapsed.
1.3.4ChangingTrueNAS®SettingsIt is important to use the web interface or the Console Setup menu for all configuration changes. TrueNAS®
stores configuration settings in a database. Commands entered at the command line do not modify the settings
database. This means that changes made at the command line will be lost after a restart and overwritten by the
values in the settings database.
13

1.3.5WebInterfaceTroubleshootingIf the web interface is shown but seems unresponsive or incomplete:
• Make sure the browser allows cookies, Javascript, and custom fonts from the TrueNAS®system.
• Try a different browser. Firefox (https://www.mozilla.org/en-US/firefox/all/) is recommended.
If a web browser cannot connect to the TrueNAS®system by IP address, DNS hostname, or mDNS name:
• Check or disable proxy settings in the browser.
• Verify the network connection by pinging the TrueNAS®system by IP address from another computer on the
same network. For example, if the TrueNAS®system is at IP address 192.168.1.19, enter ping192.168.1.19on the command line of the other computer. If there is no response, check network configuration.
1.3.6HelpTextMost fields and settings in the web interface have a (Help Text) icon. Additional information about the field or
setting can be shown by clicking (Help Text). The help text window can be dragged to any location, and will re-
main there until (Close) or (Help Text) is clicked to close the window.
1.3.7HumanizedFieldsSome numeric value fields accept humanized values. This means that the field accepts numbers or numbers fol-
lowed by a unit, like Mor MiBfor megabytes or Gor GiBfor gigabytes. Entering 1048576or 1Mare equivalent.
Units of KiB, MiB, GiB, TiB, and PiB are available, and decimal values like 1.5GiBare supported when the field
allows them. Some fields have minimum or maximum limits on the values which can restrict the units available.
1.3.8FileBrowserCertain sections of the web interface have a built in file browser. The file browser is used to traverse through di-
rectories and choose datasets on the system. Datasets that have complex ACL permissions (page 148) are tagged so
they can be distinguished from non-ACL datasets.
14

CHAPTERTWOINITIALSETUP2.1HardwareSetupBasic Setup Guides for TrueNAS®systems and expansion shelves are included with the hardware and also available
in the iX Information Library (https://www.ixsystems.com/blog/knowledgebase_category/truenas/). These guides
provide detailed instructions on included components, controls, ports, rack installation, drive loading, and cable
connections.
Complete hardware installation before continuing.
Note: Always perform the initial TrueNAS®setup in consultation with your iXsystems Support Representative.
iXsystems Support can be contacted at [email protected]. Be sure to have all TrueNAS®hard-
ware serial numbers on hand. The serial numbers are located on the back of each chassis.
2.2ConsoleSetupMenuThe Console Setup menu, shown in Figure 2.1, appears at the end of the boot process. If the TrueNAS®system
has a keyboard and monitor, this Console Setup menu can be used to administer the system.
Note: When connecting to the TrueNAS®system with SSH or the web Shell (page 302), the Console Setup menu
is not shown by default. It can be started by the root user or another user with root permissions by typing /etc/netcli.
The Console Setup menu can be disabled by unchecking Enable Console Menu in System →Advanced.15

Fig. 2.1: Console Setup Menu
Note: On HA systems, some of these menu options are not available unless HA has been administratively dis-
abled.
The menu provides these options:
1) Configure Network Interfaces provides a configuration wizard to set up the system’s network interfaces. If the sys-
tem has been licensed for High Availability (HA), the wizard prompts for IP addresses for both “This Controller” and
“TrueNAS Controller 2”.
2) Configure Link Aggregation is for creating or deleting link aggregations.
3) Configure VLAN Interface is used to create or delete VLAN interfaces.
4) Configure Default Route is used to set the IPv4 or IPv6 default gateway. When prompted, enter the IP address of
the default gateway.
5) Configure Static Routes prompts for the destination network and gateway IP address. Re-enter this option for
each static route needed.
6) Configure DNS prompts for the name of the DNS domain and the IP address of the first DNS server. When
adding multiple DNS servers, press Enterto enter the next one. Press Entertwice to leave this option.
7) Reset Root Password is used to reset a lost or forgotten rootpassword. Select this option and follow the
prompts to set the password.
8) Reset Configuration to Defaults Caution! This option deletes all of the configuration settings made in the admin-
istrative GUI and is used to reset a TrueNAS®system back to defaults. Before selecting this option, make a full
backup of all data and make sure all encryption keys and passphrases are known! After this option is se-
lected, the configuration is reset to defaults and the system reboots. Storage →Pools →Import Pool can be used to
re-import pools.
9) Shell starts a shell for running FreeBSD commands. To leave the shell, type exit.
10) Reboot reboots the system.
11) Shut Down shuts down the system.
16

Note: The numbering and quantity of options on this menu can change due to software updates, service agree-
ments, or other factors. Please carefully check the menu before selecting an option, and keep this in mind when
writing local procedures.
During boot, TrueNAS®automatically attempts to connect to a DHCP server from all live interfaces. If it success-
fully receives an IP address, the address is displayed so it can be used to access the graphical user interface. In the
example seen in Figure 2.1, the TrueNAS®system is accessible at http://10.0.0.102.
Some TrueNAS®systems are set up without a monitor, making it challenging to determine which IP address has
been assigned. On networks that support Multicast DNS (mDNS), the hostname and domain can be entered into
the address bar of a browser. By default, this value is truenas.local.
If the TrueNAS®server is not connected to a network with a DHCP server, use the console network configuration
menu to manually configure the interface as shown here. In this example, the TrueNAS®system has one network
interface, em0.
Enteranoptionfrom1-12:11)em0Selectaninterface(qtoquit):1Removethecurrentsettingsofthisinterface?(Thiscausesamomentarydisconnectionofthenetwork.)(y/n)nConfigureinterfaceforDHCP?(y/n)nConfigureIPv4?(y/n)yInterfacename:(pressenter,thenamecanbeblank)SeveralinputformatsaresupportedExample1CIDRNotation:192.168.1.1/24Example2IPandNetmaskseparate:IP:192.168.1.1Netmask:255.255.255.0,or/24or24IPv4Address:192.168.1.108/24Savinginterfaceconfiguration:OkConfigureIPv6?(y/n)nRestartingnetwork:ok...Thewebuserinterfaceisathttp://192.168.1.1082.3AccessingtheWebInterfaceThe IP address of the TrueNAS®graphical web interface is provided on the TrueNAS®sales order or configuration
sheet. Please contact iX Support (page 10) if the TrueNAS®web interface IP address has not been provided with
these documents or cannot be identified from the TrueNAS®system console.
On a computer that can access the same network as the TrueNAS®system, enter the IP address in a web browser
to connect to the web interface. The password for the root user is requested.
17

Fig. 2.2: Login Screen
The High Availability (HA) (page 81) status and information about the active TrueNAS controller is displayed on this
screen. Log in with:
•Username:root•Password:abcd1234Note: The default root password can be changed to a more secure value by going to Accounts →Users. Expand
the entry for root and click EDIT. Enter the new password in the Password and Confirm Password fields and click
SAVE. The new password is used for subsequent logins.
On the first login, the EULA found in Appendix A: End-User License Agreement (page 320) is displayed, along with a
box where the license key for the TrueNAS®array can be pasted. Read the EULA and paste in the license key. High
Availability (HA) systems must have both active and standby TrueNAS controllers running before the license key
for the HA TrueNAS®system can be entered. The key is entered on the active TrueNAS controller. Click OK to save
the license key and access the web interface.
18

Fig. 2.3: Dashboard
The Dashboard shows details about the system. These details are grouped into sections about the hardware com-
ponents, networking, storage, and other categories.
2.3.1WebInterfaceTroubleshootingIf the user interface is not accessible by IP address from a browser, check these things:
• Are proxy settings enabled in the browser configuration? If so, disable the settings and try connecting again.
• If the page does not load, make sure that a pingreaches the TrueNAS®system’s IP address. If the address is
in a private IP address range, it is only accessible from within that private network.
If the UI becomes unresponsive after an upgrade or other system operation, clear the site data and refresh the
browser.
The rest of this User Guide describes the TrueNAS®web interface in more detail. The layout of this User Guide
follows the order of the menu items in the tree located in the left frame of the web interface.
Please contact iXsystems Support (page 10) for initial setup and configuration assistance.
Warning: It is important to use the web interface or the console setup menu for all configuration changes. Do
not make changes from the command line unless directed by an iXsystems Support Engineer.
19

CHAPTERTHREESETTINGSThe (Settings) menu provides options to change the administrator password, set preferences, and view system
information.
3.1ChangePasswordTo change the rootaccount password, click (Settings) and Change Password. The current rootpassword must
be entered before a new password can be saved.
3.2PreferencesThe TrueNAS®User Interface can be adjusted to match the user preferences. Go to the Web Interface Preferences
page by clicking the (Settings) menu in the upper-right and clicking Preferences.
3.2.1WebInterfacePreferencesThis page has options to adjust global settings in the web interface, manage custom themes, and create new
themes. Figure 3.1 shows the different options:
20