FortiAuthenticator 6.2.0 VM Install Guide
FortiAuthenticator 6.2.0 VM Install Guide
Version 6.2.0
FORTINET DOCUMENT LIBRARY
https://docs.fortinet.com
FORTINET BLOG
https://blog.fortinet.com
NSE INSTITUTE
https://training.fortinet.com
FORTIGUARD CENTER
https://www.fortiguard.com
FEEDBACK
Email: [email protected]
Change Log 4
Introduction 5
Architecture 5
FortiAuthenticator-VM Overview 7
Licensing 7
System requirements 9
VM requirements 9
FortiAuthenticator-VM sizing guidelines 9
FortiAuthenticator-VM firmware 10
Register FortiAuthenticator-VM on FortiCloud 10
Download the FortiAuthenticator-VM software 15
MS Hyper-V deployment package contents 15
VMware ESXi deployment package contents 15
KVM deployment package contents 16
FortiAuthenticator-VM evaluation license 18
FortiAuthenticator-VM Deployment 19
Deploying FortiAuthenticator-VM on MS Hyper-V 19
Deploying FortiAuthenticator-VM on VMware 23
Deploying FortiAuthenticator-VM on KVM 27
Resizing the virtual disk 32
Configuring the number of virtual CPUs 33
Configuring the memory limit 33
Configure FortiAuthenticator-VM hardware settings 34
Resizing the virtual disk (vDisk) 34
Configuring the number of virtual CPUs (vCPUs) 35
Configuring the virtual RAM (vRAM) limit 36
Mapping the virtual NICs (vNICs) to physical NICs 37
Power on your FortiAuthenticator-VM 38
Initial Configuration 39
FortiAuthenticator-VM console access 39
Connect to the FortiAuthenticator-VM GUI 40
Upload the FortiAuthenticator-VM license file 40
Configure your FortiAuthenticator-VM 42
Introduction
Welcome, and thank you for selecting Fortinet products to protect your network.
FortiAuthenticator-VM is a virtual appliance designed specifically to provide authentication services for multiple devices,
including firewalls, SSL and IPsec VPNs, wireless access points, switches, routers, and servers. FortiAuthenticator
includes a RADIUS and LDAP server. Authentication servers are an important part of an enterprise network, controlling
access to protected network assets, and tracking users’ activities to comply with security policies.
FortiAuthenticator is not a firewall; it requires a FortiGate appliance to provide firewall-related services. Multiple
FortiGate units can use a single FortiAuthenticator appliance for Fortinet Single Sign On (FSSO) and other types of
remote authentication, two-factor authentication, and FortiToken device management. This centralizes authentication
and FortiToken maintenance.
FortiAuthenticator provides an easy-to-configure remote authentication option for FortiGate users. Additionally, it can
replace the FSSO Agent on a Windows AD network.
Whilst FortiAuthenticator is a hardened server it should be installed with adequate protection from the Internet.
Management protocols should be configured on private networks and only the resources required exposed to the
outside.
The FortiAuthenticator-VM delivers centralized, secure two-factor authentication for a virtual environment with a
stackable user license for the greatest flexibility. Supporting from 100 to 1 million+ users, the FortiAuthenticator-VM
supports the widest range of deployments, from small enterprise right through to the largest service provider.
This document includes an overview of the FortiAuthenticator-VM, its deployment with VMware vSphere, MS Hyper-V,
and KVM, and information on how to perform an initial configuration.
Architecture
FortiAuthenticator-VM requires the following connectivity for management. Inbound management using Telnet and
HTTP is not recommended. SSH is intended for initial configuration and diagnostics only. For more information, see the
FortiAuthenticator Administration Guide.
Inbound management:
Service Port
Telnet TCP 23
HTTP TCP 80
SSH TCP 22
Outbound management:
Service Port
DNSlookup UDP 53
FortiAuthenticator-VM Overview
Licensing
Fortinet offers the FortiAuthenticator-VM in a stackable license model. This model allows you to expand your VM
solution as your environment expands. When configuring your FortiAuthenticator-VM, make sure to configure hardware
settings as outlined in table three and consider future expansion. Contact your Fortinet Authorized Reseller for more
information.
FortiAuthenticator-VM license options:
SKU Description
Note that the FAC-VM-Base license is always required and that other licenses are upgrades to
the base license.
l KVM
l Microsoft Azure
SKU Description
After placing an order for FortiAuthenticator-VM, a license registration code is sent to the email address used in the
order form. Use the license registration code provided to register the FortiAuthenticator-VM with FortiCloud.
Upon registration, you can download the license file. You will need this file to activate your FortiAuthenticator-VM. For
more information on configuring basic network settings and applying your license, see the FortiAuthenticator
Administration Guide.
System requirements
Prior to deploying the FortiAuthenticator-VM virtual appliance, either VMware vSphere Hypervisor (ESX versions 4.0 or
4.1, ESXi versions 4/5/6), Microsoft Hyper-V Server (2010, 2012 R2, and 2016), or Virtual Machine Manager for KVM
must be installed and configured. Note that, Virtual Machine Manager version 1.3.2 was used for the purposes of this
document.
The installation instructions for FortiAuthenticator-VM assume you are familiar with both VM platforms and their related
terminology.
For more details on all platforms, refer to:
l http://www.vmware.com/products/vsphere-hypervisor/overview.html
l https://www.microsoft.com/en-ca/server-cloud/solutions/virtualization.aspx
l https://virt-manager.org/
The following table provides a detailed summary on FortiAuthenticator virtual machine (VM) system requirements.
Installing FortiAuthenticator-VM requires that you have already installed a supported VM environment.
VM requirements
The following table provides FortiAuthenticator-VM sizing guidelines based on typical usage. Actual requirements may
vary based on usage patterns.
1 - 500 1 2 GB 1 TB
500 to 2,500 2 4 GB 1 TB
2,500 to 7,500 2 8 GB 2 TB
7,500 to 25,000 4 16 GB 2 TB
25,000 to 75,000 8 32 GB 4 TB
75,000 to 250,000 16 64 GB 4 TB
*1TB is sufficient for any number of users if there is no need for long-term storage of logs onboard FortiAuthenticator.
FortiAuthenticator-VM firmware
To obtain the FortiAuthenticator-VM license file you must first register your FortiAuthenticator-VM on FortiCloud.
4. Enter the support contract number, product description, Fortinet Partner, and IP address.
FortiCloud does not currently support IPv6 for FortiAuthenticator-VM license validation.
You must specify an IPv4 address in both the support portal and the port management
interface.
6. Select the check box to indicate that you have read, understood, and accepted the service contract, and select
Next to continue.
The Verification page is displayed.
7. The verification page displays the product entitlement. Select the checkbox to indicate that you accept the terms
and select Confirm to submit the request.
The Registration Completed page is displayed.
8. In the Registration Completed page you can download the FortiAuthenticator-VM license file. Select the License
File Download link. You will be prompted to save the license file (.lic) to your management computer.
3. Select Edit to change the description, partner information, and IP address of your FortiAuthenticator-VM.
The Edit Product Information page opens.
You can change the IP address five (5) times on a regular FortiAuthenticator-VM license.
There is no restriction on a full evaluation license.
5. Select the License File Download link. You will be prompted to save the license file (.lic) to your management
computer.
Fortinet provides the FortiAuthenticator-VM software for 64-bit environments in two formats:
Upgrades: Download this firmware image to upgrade your existing FortiAuthenticator-VM installation.
l FAC_VM-vxxx-build0xxx-FORTINET.out:
New Installations: Download for a new FortiAuthenticator-VM installation. Choose the package relevant to your
environment.
l FAC_VM-vxxx-build0xxx-FORTINET.out.ovf.zip
l FAC_VM-vxxx-build0xxx-FORTINET.out.kvm.zip
l FAC_VM-vxxx-build0xxx-FORTINET.out.hyperv.zip
l FAC_VM-vxxx-build0xxx-FORTINET.out.xen.zip
The zip file is available in hyperv and OVF formats, for MS Hyper-V and VMware ESXi
respectively. The .out file can upgrade both.
For more information see the FortiAuthenticator product datasheet available on the Fortinet web site.
For compatibility of your VMware ESXi/ESX server and the various hardware types, see ESXi/ESX hosts and
compatible virtual machine hardware versions list (2007240).
The FAC_VM-vxxx-build0xxx-FORTINET.out.ovf.zip file contains the following files:
l datadrive.vmdk: Virtual machine disk format file used by the OVF file.
l fac.vmdk: Virtual machine disk format file used by the OVF file.
l FortiAuthenticator-VM.hw04.ovf: Open Virtualization Format file for VMware ESX 4.0 environments that support
hardware version 4.
l FortiAuthenticator-VM.hw07.ovf: Open Virtualization Format file for VMware ESX 4.0 environments that support
hardware version 7.
l FortiAuthenticator-VM.hw10.ovf: Open Virtualization Format file for VMware ESX 4.0 environments that support
hardware version 10.
l FortiAuthenticator-VM.hw13.ovf: Open Virtualization Format file for VMware ESX 4.0 environments that support
hardware version 13.
l FortiAuthenticator-VM.ovf: Open Virtualization Format file for VMware.
The FAC_VM_KVM-vxxx-build0216-FORTINET.out.kvm.zip file contains the following QCOW2 and XML files:
l datadrive.qcow2
l fackvm.file
l fackvm.xml
l fackvm.qcow2
l README.file
FortiAuthenticator-VM firmware images in the FortiCloud FTP directory are organized by firmware version, major
release, and patch release. The firmware images in the directories follow a specific naming convention and each
firmware image is specific to the device model. For example, the FAC_VM-v300-build0004-FORTINET.out.ovf.zip
image found in the v3.0 directory is specific to the FortiAuthenticator-VM VMware environment.
You can download the FortiAuthenticator Release Notes available on the Fortinet web site.
Note that the download steps below are for VMWare specifically. For other platforms, download the corresponding .ZIP
deployment package.
1. Log into FortiCloud, select Download in the toolbar, and select Firmware Images from the dropdown list.
The Firmware Images page opens.
4. Download the .ovf.zip file and FortiAuthenticator Release Notes, and save these files to your management
computer.
5. Select the .ovf.zip file on your management computer and extract the files to a new file folder.
FortiAuthenticator-VM includes a five-user evaluation license. No activation is required for the built-in evaluation license
and there is no expiration of this license.
Please contact your Fortinet Reseller should you require an extended evaluation, i.e. with
more users.
FortiAuthenticator-VM Deployment
For best performance, it is recommended that FortiAuthenticator-VM is installed on a “bare metal” hypervisor (such as
VMware ESXi or MS Hyper-V). Hypervisors that are installed as applications on top of a general purpose operating
system (such as Microsoft Windows, Mac OS X, or Linux) will have fewer computing resources available due to the host
OS’s own overhead.
The following sections detail deployments for MS Hyper-V, VMware ESX/ESXi, and Linux Virtual Machine Manager:
l Deploying FortiAuthenticator-VM on MS Hyper-V
l Deploying FortiAuthenticator-VM on VMware
l Deploying FortiAuthenticator-VM on KVM
l Configure FortiAuthenticator-VM hardware settings
l Power on your FortiAuthenticator-VM
Once you have downloaded the out.hyperv.zip file and extracted the package contents to a folder on your
management computer, you can deploy the VHD package to your MS Hyper-V environment.
1. As an administrator, launch the Hyper-V Manager and connect to your Hyper-V Server.
2. Select the server in the right-hand menu and select Import Virtual Machine.
The Import Virtual Machine page opens. Select Next to begin the VM Import process.
3. Enter the location of the VM to be imported. This is the location of the folder that you extracted the
FortiAuthenticator hyperv.zip file to.
5. For the import type, choose Copy the virtual machine and select Next.
6. Select Next if you wish to use the default storage location settings, or specify your own.
7. Select Next if you wish to use the default VM hard disk storage settings, or specify your own.
9. The VM will be installed and will be displayed in the Hyper-V Manager. Once complete, and before the VM is
started, the hardware settings can be modified. Right-click the new VM and select Settings....
Once you have downloaded the out.ovf.zip file and extracted the package contents to a folder on your
management computer, you can deploy it into your VMware environment.
1. Connect to your VMware ESXi server by visiting its URL in your browser. Enter your username and password, and
click Log in.
4. Enter a name for your VM and select the OVF (FortiAuthenticator-VM.ovf), firmware VMDK (fac.vmdk), and data
storage VMDK (datadrive.vmdk) files previously extracted to your management computer, and click Next.
5. Select which ESXi server's datastore to use for the deployment of FortiAuthenticator-VM, and click Next.
7. Select the appropriate network mappings, disk provisioning, and power on options for your deployment, and click
Next.
l Thin Provision: This option optimizes storage use at the cost of sub-optimal disk I/O rates. It allocates disk
space only when a write occurs to a block, but the total volume size is reported by VMFS to the OS. Other
volumes can take the remaining space. This allows you to float between your servers and expand storage
when your size monitoring indicates there is a problem.
Once a Thin Provisioned block is allocated, it remains in the volume regardless of whether you have deleted
data, etc...
l Thick Provision: This option has higher storage requirements, but benefits from optimal disk I/O rates. It
allocates the disk space statically. No other volumes can take the allocated space.
Once you have downloaded the out.kvm.zip file and extracted the virtual hard drive image file fackvm.qcow2, you
can create the virtual machine in your KVM environment.
4. Select Browse. If you saved the fackvm.qcow2 file to /var/lib/libvirt/images, it will be visible on the right. If you
saved it somewhere else on your server, select Browse Local, find it, and select Choose Volume.
5. Select the OS type and Version you are running (in this case Linux Ubuntu 16.04), and select Forward.
6. Specify the amount of memory and number of CPUs to allocate to this virtual machine. The amounts must not
exceed your license limits. For more information on your license limits, see Licensing.
Select Forward.
7. On the last page, enter a Name for the VM (in this case, FAC-VM).
A new virtual machine includes one network adapter by default. Set Network selection to Usermode networking.
Alternatively, set a specific MAC address for the virtual network interface by selecting Specify shared device
name.
To resize the disk, and adjust partitions, you must set up the libvirt guest filesystem utilities. The command used to
resize the disk, on an Ubuntu host with qcow2 file images, is virt-resize.
1. Open the VMM Terminal and enter the following command to install the libvirt file system utilities package:
sudo apt-get install libguestfs-tools
2. To see if the libvirt utility is functional, you will need to run a test. Enter the following command:
sudo apt-get install libguestfs-tools
If you see ===== TEST FINISHED OK =====, it is functional.
3. If you don't see the successful test-finished command return, you will need to repair it. In this case, enter the
following command:
sudo update-guestfs-appliance
4. Run the test again (the command from step two) to verify that it works.
By default, the virtual appliance is configured to use one (1) virtual CPU (vCPU).
Before powering on your FortiAuthenticator-VM you must configure the virtual memory, virtual CPU, and virtual disk
(VMDK) configuration, and map the virtual network adapters.
If you configure the virtual appliance’s storage repository to be internal (i.e. local, on its own vDisk), resize the vDisk
before powering on.
This step is not applicable if the virtual appliance will use external network file system (such as
NFS) datastores.
The FortiAuthenticator-VM package that you downloaded includes pre-sized VMDK (Virtual Machine Disk Format) files
of 1GB for disk 1 (for the OS) and 60GB for disk 2 data, which is large enough for most small deployments. This can be
extended if necessary. Resize the vDisk before powering on the virtual machine.
Before doing so, make sure that you understand the effects of your vDisk settings.
During the creation of a VM datastore, you have the following formatting options:
l 1MB block size - 256GB maximum file size
l 2MB block size - 512GB maximum file size
l 4MB block size – 1,024GB maximum file size
l 8MB block size – 2,048GB maximum file size
These options affect the possible size of each vDisk.
For example, if you have an 800GB datastore which has been formatted with 1MB block size, you cannot size a single
vDisk greater than 256GB on your FortiAuthenticator-VM.
Consider also that, depending on the size of your organization’s network, you might require more or less storage for the
user database and logging.
For more information on vDisk sizing, see http://communities.vmware.com/docs/DOC-11920.
1. In the VMware vSphere Client, right-click the name of the virtual appliance, and select Edit Settings.
The Virtual Machine Properties page is displayed.
By default, the virtual appliance is configured to use 2 vCPUs. FortiAuthenticator-VM is not restricted to how many
vCPUs can be configured so you can increase the number according to your requirements (e.g., you can allocate 2, 4, or
8 vCPUs).
If you need to increase or decrease the vCPUs after the initial boot, power off
FortiAuthenticator-VM, adjust the number of vCPUs, then power on the VM.
1. In the VMware vSphere Client, right-click the name of the virtual appliance, and select Edit Settings.
The Virtual Machine Properties page is displayed.
FortiAuthenticator-VM comes pre-configured to use 512MB of vRAM. You can change this value. The valid range is
from 512MB to 16GB.
1. In the VMware vSphere Client, right-click the name of the virtual appliance, and select Edit Settings.
The Virtual Machine Properties page is displayed.
Appropriate mappings of the FortiAuthenticator-VM ports to physical ports depends on your existing virtual environment.
Often, the default bridging vNICs work, and do not need to be changed.
If you are unsure of your network mappings, try bridging first before non-default vNIC modes such as NAT or host-only
networks. The default bridging vNIC mappings are appropriate where each of the host’s guest virtual machines should
have their own IP addresses on your network. The most common exceptions to this rule are for VLANs and the
transparent modes.
When you deploy the FortiAuthenticator-VM package, 4 bridging vNICs are created and automatically mapped to a port
group on 1 virtual switch (vSwitch) within the hypervisor. Each of those vNICs can be used by one of the 4 network
interfaces in FortiAuthenticator-VM.
Alternatively, if you prefer, some or all of the network interfaces may be configured to use the same vNIC. vSwitches are
themselves mapped to physical ports on the server.
Example network mapping:
Physical Network Network Mapping Virtual Network Network Interface Name in GUI and CLI
Adapter (vSwitch Port Adapter for FAC
Group) VM
1. In the VMware vSphere Client, right-click the name of the virtual appliance, and select Edit Settings.
The Virtual Machine Properties page is displayed.
2. Select the Hardware tab and select Network adapter 1.
3. From the Network Connection dropdown list, select the virtual network mapping for the virtual network adapter.
Repeat this step for the other three network adapters. The correct mapping varies by your virtual environment’s
network configuration.
4. Select OK to save the settings to Virtual Machine Properties.
You can now proceed to power on your FortiAuthenticator-VM. Select the name of the FortiAuthenticator-VM you
deployed in the inventory list and select Power on the virtual machine in the Getting Started tab. Optionally, you can
select the name of the FortiAuthenticator-VM you deployed, right-click and select Power > Power On.
Initial Configuration
Before you can connect to the FortiAuthenticator-VM GUI you must configure basic network settings via the console tab
in your vSphere client. Once configured, you can connect to the FortiAuthenticator-VM GUI and upload the
FortiAuthenticator-VM license file that you downloaded from FortiCloud.
The following topics are included in this section:
l FortiAuthenticator-VM console access on page 39
l Connect to the FortiAuthenticator-VM GUI on page 40
l Upload the FortiAuthenticator-VM license file on page 40
l Configure your FortiAuthenticator-VM on page 42
To enable GUI access to the FortiAuthenticator-VM you must configure basic network settings of the FortiAuthenticator-
VM in the vSphere Client Console tab.
1. In the Inventory list, select the FortiAuthenticator-VM that you deployed. In the Getting Started tab select Power
on the virtual machine. Optionally, you can right-click the FortiAuthenticator-VM, and select Power > Power On.
2. Select the Console tab.
The Console window appears.
3. At the FortiAuthenticator-VM login prompt enter the username admin and password. The default password is no
password.
4. The default Port1 IP address is set to 192.168.1.99/24. You can change this IP address with the following
CLI command:
config system interface
edit port1
set ip <ip-address>/<netmask>
set allowaccess https ssh gui
next
end
config router static
edit 0
set device port1
set dst 0.0.0.0/0
set gateway <ip-gateway>
next
end
FortiCloud currently does not support IPv6 for FortiAuthenticator-VM license validation.
You must specify an IPv4 address in both the support portal and the port1 management
interface.
Once you have configured the port1 IP address, network mask, and default gateway, launch a web browser and enter
the IP address you configured for port1.
To support HTTPS authentication, the FortiAuthenticator-VM includes a self-signed X.509 certificate, which it presents
to clients whenever they initiate an HTTPS connection to the FortiAuthenticator appliance. When you connect,
depending on your web browser and prior access of the FortiAuthenticator-VM, your browser might display two security
warnings related to this certificate:
The certificate is not automatically trusted because it is self-signed, rather than being signed by a valid certificate
authority (CA). Self-signed certificates cannot be verified with a proper CA, and therefore might be fraudulent. You must
manually indicate whether or not to trust the certificate. The certificate might belong to another web site. The common
name (CN) field in the certificate, which usually contains the host name of the web site, does not exactly match the URL
you requested. This could indicate server identity theft, but could also simply indicate that the certificate contains a
domain name while you have entered an IP address. You must manually indicate whether this mismatch is normal or
not.
Both warnings are normal for the default certificate. TLS v1.0, TLS v1.1, and TLS v1.2 are supported.
Verify and accept the certificate, either permanently (the web browser will not display the self-signing warning again) or
temporarily. You cannot log in until you accept the certificate.
For details on accepting the certificate, see the documentation for your web browser.
At the login page, enter the user name admin and password and select Login. The default password is no password.
The GUI will appear with an Evaluation License dialog box.
Every FortiAuthenticator-VM includes a 5-user evaluation license. During this time the FortiAuthenticator-VM operates
in evaluation mode. Before using the FortiAuthenticator-VM you must enter the license file that you downloaded from
FortiCloud upon registration.
Plan a maintenance window to apply the FortiAuthenticator-VM license as the VM will reboot.
As your organization grows, you can simply either allocate more resources or migrate your
virtual appliance to a physical server with more power, then upgrade your FortiAuthenticator-
VM license to support your needs.
3. Select Choose File and locate the license file (.lic) on your computer. Select OK to upload the license file.
4. The VM registration status appears as valid once the license has been validated.
5. If the IP address in the license file and the IP address configured in the FortiAuthenticator-VM do not match, you
will receive the following error message dialog box when you log back into the VM.
If this occurs, you will need to change the IP address in FortiCloud to match the management IP and re-download
the license file.
After an invalid license file is loaded to FortiAuthenticator-VM, the GUI will be locked until
a valid license file is uploaded.
Once the FortiAuthenticator-VM license has been validated you can begin to configure your device. For more
information on configuring your FortiAuthenticator-VM see the FortiAuthenticator Administration Guide on the Fortinet
Document Library.
In VM environments, it is recommended that you use the VMware Snapshot utility to backup
the VM instance. In the event of an issue with a firmware upgrade or configuration issue, you
can use the Snapshot Manager to revert the VM instance to a previous Snapshot. To create a
Snapshot, right-click the VM instance and select Snapshot > Take Snapshot.