FreeNAS^® 11.3-RELEASE User Guide

• 1. Introduction
  • 1.1. New Features in 11.3
  • 1.2. Path and Name Lengths
  • 1.3. Using the Web Interface
    • 1.3.1. Tables and Columns
    • 1.3.2. Advanced Scheduler
    • 1.3.3. Schedule Calendar
    • 1.3.4. Changing FreeNAS^® Settings
    • 1.3.5. Web Interface Troubleshooting
    • 1.3.6. Help Text
    • 1.3.7. Humanized Fields
  • 1.4. Hardware Recommendations
    • 1.4.1. RAM
    • 1.4.2. The Operating System Device
    • 1.4.3. Storage Disks and Controllers
    • 1.4.4. Network Interfaces
  • 1.5. Getting Started with ZFS
• 2. Installing and Upgrading
  • 2.1. Getting FreeNAS^®
    • 2.1.1. Checking Installer Integrity
      • 2.1.1.1. PGP Verification
      • 2.1.1.2. SHA256 Verification
  • 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
• 4. Accessing the Web Interface
  • 4.1. Web Interface Troubleshooting
• 5. Settings
  • 5.1. Change Password
  • 5.2. Preferences
    • 5.2.1. Web Interface Preferences
    • 5.2.2. Themes
      • 5.2.2.1. Create New Themes
  • 5.3. API Documentation
  • 5.4. About
• 6. Accounts
  • 6.1. Groups
  • 6.2. Users
• 7. System
  • 7.1. General
  • 7.2. NTP Servers
  • 7.3. Boot
    • 7.3.1. Operating System Device Mirroring
  • 7.4. Advanced
    • 7.4.1. Autotune
    • 7.4.2. Self-Encrypting Drives
      • 7.4.2.1. Deploying SEDs
      • 7.4.2.2. Check SED Functionality
      • 7.4.2.3. Managing SED Passwords and Data
  • 7.5. Email
  • 7.6. System Dataset
  • 7.7. Reporting
  • 7.8. Alert Services
  • 7.9. Alert Settings
  • 7.10. Cloud Credentials
  • 7.11. SSH Connections
    • 7.11.1. Manual Setup
    • 7.11.2. Semi-Automatic Setup
  • 7.12. SSH Keypairs
  • 7.13. Tunables
  • 7.14. Update
    • 7.14.1. Preparing for Updates
    • 7.14.2. Updates and Trains
    • 7.14.3. Checking for Updates
    • 7.14.4. Saving the Configuration File
    • 7.14.5. Applying Updates
    • 7.14.6. Manual Updates
    • 7.14.7. Update in Progress
  • 7.15. CAs
  • 7.16. Certificates
    • 7.16.1. ACME Certificates
  • 7.17. ACME DNS
  • 7.18. Support
• 8. Tasks
  • 8.1. Cron Jobs
  • 8.2. Init/Shutdown Scripts
  • 8.3. Rsync Tasks
    • 8.3.1. Rsync Module Mode
    • 8.3.2. Rsync over SSH Mode
  • 8.4. S.M.A.R.T. Tests
  • 8.5. Periodic Snapshot Tasks
  • 8.6. Replication
    • 8.6.1. Replication Creation Wizard
    • 8.6.2. Advanced Replication Creation
    • 8.6.3. Replication Tasks
    • 8.6.4. Limiting Replication Times
    • 8.6.5. Troubleshooting Replication
      • 8.6.5.1. SSH
      • 8.6.5.2. Compression
      • 8.6.5.3. Manual Testing
  • 8.7. Resilver Priority
  • 8.8. Scrub Tasks
  • 8.9. Cloud Sync Tasks
    • 8.9.1. Cloud Sync Example
• 9. Network
  • 9.1. Global Configuration
  • 9.2. Interfaces
    • 9.2.1. Network Bridges
    • 9.2.2. Link Aggregations
      • 9.2.2.1. LACP, MPIO, NFS, and ESXi
      • 9.2.2.2. Creating a Link Aggregation
      • 9.2.2.3. Link Aggregation Options
    • 9.2.3. VLANs
  • 9.3. IPMI
  • 9.4. Network Summary
  • 9.5. Static Routes
• 10. Storage
  • 10.1. Swap Space
  • 10.2. Pools
    • 10.2.1. Creating Pools
    • 10.2.2. Managing Encrypted Pools
      • 10.2.2.1. Encryption and Recovery Keys
      • 10.2.2.2. Encryption Operations
    • 10.2.3. Adding Cache or Log Devices
    • 10.2.4. Removing Cache or Log Devices
    • 10.2.5. Adding Spare Devices
    • 10.2.6. Extending a Pool
    • 10.2.7. Export/Disconnect a Pool
    • 10.2.8. Importing a Pool
    • 10.2.9. Viewing Pool Scrub Status
    • 10.2.10. Adding Datasets
      • 10.2.10.1. Deduplication
      • 10.2.10.2. Compression
    • 10.2.11. Adding Zvols
    • 10.2.12. Setting Permissions
    • 10.2.13. ACL Management
  • 10.3. Snapshots
    • 10.3.1. Browsing a Snapshot Collection
    • 10.3.2. Creating a Single Snapshot
  • 10.4. VMware-Snapshots
  • 10.5. Disks
    • 10.5.1. Replacing a Failed Disk
      • 10.5.1.1. Removing a Log or Cache Device
    • 10.5.2. Replacing Disks to Grow a Pool
  • 10.6. Importing a Disk
  • 10.7. Multipaths
• 11. Directory Services
  • 11.1. Active Directory
    • 11.1.1. Leaving the Domain
    • 11.1.2. Troubleshooting Tips
  • 11.2. LDAP
  • 11.3. NIS
  • 11.4. Kerberos Realms
  • 11.5. Kerberos Keytabs
  • 11.6. Kerberos Settings
• 12. Sharing
  • 12.1. Apple (AFP) Shares
    • 12.1.1. Creating AFP Guest Shares
  • 12.2. Block (iSCSI)
    • 12.2.1. iSCSI Wizard
    • 12.2.2. Target Global Configuration
    • 12.2.3. Portals
    • 12.2.4. Initiators
    • 12.2.5. Authorized Access
    • 12.2.6. Targets
    • 12.2.7. Extents
    • 12.2.8. Associated Targets
    • 12.2.9. Connecting to iSCSI
    • 12.2.10. Growing LUNs
      • 12.2.10.1. Zvol Based LUN
      • 12.2.10.2. File Extent Based LUN
  • 12.3. Unix (NFS) Shares
    • 12.3.1. Example Configuration
    • 12.3.2. Connecting to the Share
      • 12.3.2.1. From BSD or Linux
      • 12.3.2.2. From Microsoft
      • 12.3.2.3. From macOS
    • 12.3.3. Troubleshooting NFS
  • 12.4. WebDAV Shares
  • 12.5. Windows (SMB) Shares
    • 12.5.1. Configuring Unauthenticated Access
    • 12.5.2. Configuring Authenticated Access With Local Users
    • 12.5.3. User Quota Administration
    • 12.5.4. Configuring Shadow Copies
  • 12.6. Creating Authenticated and Time Machine Shares
    • 12.6.1. Setting SMB and AFP Share Quotas
    • 12.6.2. Client Time Machine Configuration
• 13. Services
  • 13.1. Configure Services
  • 13.2. AFP
    • 13.2.1. Troubleshooting AFP
  • 13.3. Dynamic DNS
  • 13.4. FTP
    • 13.4.1. Anonymous FTP
    • 13.4.2. FTP in chroot
    • 13.4.3. Encrypting FTP
    • 13.4.4. Troubleshooting FTP
  • 13.5. iSCSI
  • 13.6. LLDP
  • 13.7. NFS
  • 13.8. Rsync
    • 13.8.1. Configure Rsyncd
    • 13.8.2. Rsync Modules
  • 13.9. S3
  • 13.10. S.M.A.R.T.
  • 13.11. SMB
    • 13.11.1. Troubleshooting SMB
  • 13.12. SNMP
  • 13.13. SSH
    • 13.13.1. SCP Only
    • 13.13.2. Troubleshooting SSH
  • 13.14. TFTP
  • 13.15. UPS
    • 13.15.1. Multiple Computers with One UPS
  • 13.16. WebDAV
• 14. Plugins
  • 14.1. Installing Plugins
  • 14.2. Updating Plugins
  • 14.3. Uninstalling Plugins
  • 14.4. Create a Plugin
    • 14.4.1. Test a Plugin
  • 14.5. Asigra Plugin
• 15. Jails
  • 15.1. Jail Storage
  • 15.2. Creating Jails
    • 15.2.1. Jail Wizard
    • 15.2.2. Advanced Jail Creation
      • 15.2.2.1. Creating Template Jails
  • 15.3. Managing Jails
    • 15.3.1. Jail Updates and Upgrades
    • 15.3.2. Accessing a Jail Using SSH
    • 15.3.3. Additional Storage
  • 15.4. Jail Software
    • 15.4.1. Installing FreeBSD Packages
    • 15.4.2. Compiling FreeBSD Ports
    • 15.4.3. Starting Installed Software
• 16. Reporting
• 17. Virtual Machines
  • 17.1. Creating VMs
  • 17.2. Installing Docker
  • 17.3. Adding Devices to a VM
    • 17.3.1. CD-ROM Devices
    • 17.3.2. NIC (Network Interfaces)
    • 17.3.3. Disk Devices
    • 17.3.4. Raw Files
    • 17.3.5. VNC Interface
• 18. Display System Processes
• 19. Shell
• 20. Log Out, Restart, or Shut Down
  • 20.1. Log Out
  • 20.2. Restart
  • 20.3. Shut Down
• 21. Alert
• 22. Task Manager
• 23. Support Resources
  • 23.1. User Guide
  • 23.2. Website and Social Media
  • 23.3. Forums
  • 23.4. IRC
  • 23.5. Videos
  • 23.6. Professional Support
• 24. Contributing to FreeNAS^®
  • 24.1. Translation
    • 24.1.1. Translate with GitHub
    • 24.1.2. Download and Translate Offline
    • 24.1.3. Translation Pull Requests
• 25. Command Line Utilities
  • 25.1. Iperf
  • 25.2. Netperf
  • 25.3. IOzone
  • 25.4. arcstat
  • 25.5. tw_cli
  • 25.6. MegaCli
  • 25.7. freenas-debug
  • 25.8. tmux
  • 25.9. Dmidecode
  • 25.10. Midnight Commander
• 26. ZFS Primer
  • 26.1. ZFS Feature Flags
• 27. OpenStack Cinder Driver
• 28. VMware Recommendations
  • 28.1. FreeNAS^® as a VMware Guest
  • 28.2. Hosting VMware Storage with FreeNAS^®
  • 28.3. VAAI for iSCSI
• 29. Using the API
  • 29.1. A Simple API Example
  • 29.2. A More Complex Example

Index

• Index