FreeNAS^® 11.2-RC1 User Guide

• 1. Introduction
  • 1.1. New Features in 11.2
  • 1.2. Path and Name Lengths
  • 1.3. Hardware Recommendations
    • 1.3.1. RAM
    • 1.3.2. The Operating System Device
    • 1.3.3. Storage Disks and Controllers
    • 1.3.4. Network Interfaces
  • 1.4. Getting Started with ZFS
• 2. Installing and Upgrading
  • 2.1. Getting FreeNAS^®
  • 2.2. Preparing the Media
    • 2.2.1. On FreeBSD or Linux
    • 2.2.2. On Windows
    • 2.2.3. On macOS
  • 2.3. Performing the Installation
  • 2.4. Installation Troubleshooting
  • 2.5. Upgrading
    • 2.5.1. Caveats
    • 2.5.2. Initial Preparation
    • 2.5.3. Upgrading Using the ISO
    • 2.5.4. Upgrading From the Web Interface
    • 2.5.5. If Something Goes Wrong
    • 2.5.6. Upgrading a ZFS Pool
  • 2.6. Virtualization
    • 2.6.1. VirtualBox
    • 2.6.2. VMware ESXi
• 3. Booting
  • 3.1. Obtaining an IP Address
  • 3.2. Logging In
• 4. Settings
  • 4.1. Edit root Account
  • 4.2. Change Password
  • 4.3. Preferences
    • 4.3.1. Web Interface Preferences
    • 4.3.2. Themes
      • 4.3.2.1. Theme Selector
      • 4.3.2.2. Create New Themes
  • 4.4. About
  • 4.5. Legacy Web Interface
• 5. Accounts
  • 5.1. Groups
  • 5.2. Users
• 6. System
  • 6.1. General
  • 6.2. NTP Servers
  • 6.3. Boot Environments
    • 6.3.1. Mirroring the Boot Device
  • 6.4. Advanced
    • 6.4.1. Autotune
    • 6.4.2. Self-Encrypting Drives
  • 6.5. Email
  • 6.6. System Dataset
  • 6.7. Alert Services
  • 6.8. Alert Settings
  • 6.9. Cloud Credentials
  • 6.10. Tunables
  • 6.11. Update
    • 6.11.1. Preparing for Updates
    • 6.11.2. Updates and Trains
    • 6.11.3. Checking for Updates
    • 6.11.4. Applying Updates
    • 6.11.5. Manual Updates
  • 6.12. CAs
  • 6.13. Certificates
  • 6.14. Support
• 7. Tasks
  • 7.1. Cron Jobs
  • 7.2. Init/Shutdown Scripts
  • 7.3. Rsync Tasks
    • 7.3.1. Rsync Module Mode
    • 7.3.2. Rsync over SSH Mode
  • 7.4. S.M.A.R.T. Tests
  • 7.5. Periodic Snapshot Tasks
  • 7.6. Replication Tasks
    • 7.6.1. Examples: Common Configuration
      • 7.6.1.1. Alpha (Source)
      • 7.6.1.2. Beta (Destination)
    • 7.6.2. Example: FreeNAS^® to FreeNAS^® Semi-Automatic Setup
    • 7.6.3. Example: FreeNAS^® to FreeNAS^® Dedicated User Replication
    • 7.6.4. Example: FreeNAS^® to FreeNAS^® or Other Systems, Manual Setup
      • 7.6.4.1. Encryption Keys
    • 7.6.5. Replication Options
    • 7.6.6. Replication Encryption
    • 7.6.7. Limiting Replication Times
    • 7.6.8. Troubleshooting Replication
      • 7.6.8.1. SSH
      • 7.6.8.2. Compression
      • 7.6.8.3. Manual Testing
  • 7.7. Resilver Priority
  • 7.8. Scrub Tasks
  • 7.9. Cloud Sync Tasks
    • 7.9.1. Cloud Sync Example
• 8. Network
  • 8.1. Global Configuration
  • 8.2. Interfaces
  • 8.3. IPMI
  • 8.4. Link Aggregations
    • 8.4.1. LACP, MPIO, NFS, and ESXi
    • 8.4.2. Creating a Link Aggregation
    • 8.4.3. Link Aggregation Options
  • 8.5. Static Routes
  • 8.6. VLANs
• 9. Storage
  • 9.1. Pools
    • 9.1.1. Creating Pools
    • 9.1.2. Managing Encrypted Pools
    • 9.1.3. Adding Cache or Log Devices
    • 9.1.4. Removing Cache or Log Devices
    • 9.1.5. Adding Spare Devices
    • 9.1.6. Extending a Pool
    • 9.1.7. Detaching a Pool
    • 9.1.8. Importing a Pool
    • 9.1.9. Viewing Pool Scrub Status
    • 9.1.10. Adding Datasets
      • 9.1.10.1. Deduplication
      • 9.1.10.2. Compression
    • 9.1.11. Adding Zvols
    • 9.1.12. Setting Permissions
    • 9.1.13. View Multipaths
  • 9.2. Snapshots
    • 9.2.1. Browsing a Snapshot Collection
  • 9.3. VMware-Snapshots
  • 9.4. Disks
    • 9.4.1. Replacing a Failed Disk
      • 9.4.1.1. Replacing an Encrypted Disk
      • 9.4.1.2. Removing a Log or Cache Device
    • 9.4.2. Replacing Disks to Grow a Pool
  • 9.5. Importing a Disk
• 10. Directory Services
  • 10.1. Active Directory
    • 10.1.1. Troubleshooting Tips
    • 10.1.2. If the System Will not Join the Domain
  • 10.2. LDAP
  • 10.3. NIS
  • 10.4. Kerberos Realms
  • 10.5. Kerberos Keytabs
  • 10.6. Kerberos Settings
• 11. Sharing
  • 11.1. Apple (AFP) Shares
    • 11.1.1. Creating AFP Guest Shares
    • 11.1.2. Creating Authenticated and Time Machine Shares
  • 11.2. Unix (NFS) Shares
    • 11.2.1. Example Configuration
    • 11.2.2. Connecting to the Share
      • 11.2.2.1. From BSD or Linux
      • 11.2.2.2. From Microsoft
      • 11.2.2.3. From macOS
    • 11.2.3. Troubleshooting NFS
  • 11.3. WebDAV Shares
  • 11.4. Windows (SMB) Shares
    • 11.4.1. Configuring Unauthenticated Access
    • 11.4.2. Configuring Authenticated Access Without a Domain Controller
    • 11.4.3. Configuring Shadow Copies
  • 11.5. Block (iSCSI)
    • 11.5.1. Target Global Configuration
    • 11.5.2. Portals
    • 11.5.3. Initiators
    • 11.5.4. Authorized Accesses
    • 11.5.5. Targets
    • 11.5.6. Extents
    • 11.5.7. Target/Extents
    • 11.5.8. Connecting to iSCSI
    • 11.5.9. Growing LUNs
      • 11.5.9.1. Zvol Based LUN
      • 11.5.9.2. File Extent Based LUN
• 12. Services
  • 12.1. Configure Services
  • 12.2. AFP
    • 12.2.1. Troubleshooting AFP
  • 12.3. Domain Controller
    • 12.3.1. Samba Domain Controller Backup
  • 12.4. Dynamic DNS
  • 12.5. FTP
    • 12.5.1. Anonymous FTP
    • 12.5.2. FTP in chroot
    • 12.5.3. Encrypting FTP
    • 12.5.4. Troubleshooting FTP
  • 12.6. iSCSI
  • 12.7. LLDP
  • 12.8. Netdata
  • 12.9. NFS
  • 12.10. Rsync
    • 12.10.1. Configure Rsyncd
    • 12.10.2. Rsync Modules
  • 12.11. S3
  • 12.12. S.M.A.R.T.
  • 12.13. SMB
    • 12.13.1. Troubleshooting SMB
  • 12.14. SNMP
  • 12.15. SSH
    • 12.15.1. SCP Only
    • 12.15.2. Troubleshooting SSH
  • 12.16. TFTP
  • 12.17. UPS
    • 12.17.1. Multiple Computers with One UPS
  • 12.18. WebDAV
• 13. Plugins
  • 13.1. Install
  • 13.2. Update
  • 13.3. Delete
  • 13.4. Create a Plugin
    • 13.4.1. Test a Plugin
  • 13.5. Official Plugins
• 14. Jails
  • 14.1. Jail Storage
  • 14.2. Creating Jails
    • 14.2.1. Jail Wizard
    • 14.2.2. Advanced Jail Creation
  • 14.3. Managing Jails
    • 14.3.1. Jail Updates and Upgrades
    • 14.3.2. Accessing a Jail Using SSH
    • 14.3.3. Additional Storage
  • 14.4. Jail Software
    • 14.4.1. Installing FreeBSD Packages
    • 14.4.2. Compiling FreeBSD Ports
    • 14.4.3. Starting Installed Software
  • 14.5. Using iocage
    • 14.5.1. Managing iocage Jails
• 15. Virtual Machines
  • 15.1. Creating VMs
  • 15.2. Adding Devices to a VM
    • 15.2.1. CD-ROM Devices
    • 15.2.2. NIC (Network Interfaces)
    • 15.2.3. Disk Devices
    • 15.2.4. Raw Files
    • 15.2.5. VNC Interface
    • 15.2.6. Virtual Serial Ports
  • 15.3. Running VMs
  • 15.4. Deleting VMs
  • 15.5. Docker Hosts
    • 15.5.1. Docker Host Requirements
    • 15.5.2. Creating Docker Host
    • 15.5.3. Start the Docker Host
    • 15.5.4. SSH into the Docker Host
    • 15.5.5. Installing and Configuring the Rancher Server
• 16. Reporting
• 17. Display System Processes
• 18. Shell
• 19. Log Out, Restart, or Shut Down
  • 19.1. Log Out
  • 19.2. Restart
  • 19.3. Shut Down
• 20. Alert
• 21. Support Resources
  • 21.1. Website and Social Media
  • 21.2. Forums
  • 21.3. IRC
  • 21.4. Videos
  • 21.5. Professional Support
• 22. Contributing to FreeNAS ^®
  • 22.1. Translation
    • 22.1.1. Translate with GitHub
    • 22.1.2. Download and Translate Offline
    • 22.1.3. Translation Pull Requests
• 23. Command Line Utilities
  • 23.1. Iperf
  • 23.2. Netperf
  • 23.3. IOzone
  • 23.4. arcstat
  • 23.5. tw_cli
  • 23.6. MegaCli
  • 23.7. freenas-debug
  • 23.8. tmux
  • 23.9. Dmidecode
  • 23.10. Midnight Commander
• 24. ZFS Primer
• 25. VAAI
  • 25.1. VAAI for iSCSI
• 26. Using the API
  • 26.1. A Simple API Example
  • 26.2. A More Complex Example

Index

• Index