Setup Access Gateway using VMWare/ESXi

Overview

The purpose of this guide is to describe the process of installing the Access Gateway virtual appliance using VMware Player or vSphere ESXi.

For a complete list of all supported installation targets see Setup Access Gateway Using an OVA Image

See Okta Access Gateway Supported Technologies for a complete list of all supported technologies and versions.

To download the latest Okta Access Gateway OVA Image

Download the Okta Access Gateway image from the Settings > Downloads page in Okta.
When prompted save the file to an appropriate location.

Import to VMware Workstation Player

To Import an OVA to VMWare Workstation Player:

Open VMware Workstation Player.
Select Open a Virtual Machine.
Browse to the Okta-Access Gateway OVA file, and click Open.
Enter a name for the virtual machine, and click Import.
VMware will start importing the OVA file.
Once the VM has imported, click Play virtual machine to start the VM and open a terminal.

Import to VMware vSphere/ESXi

To Import to VMWare ESXi/vSphere:

Note: Older versions (before 6.5) of VMWare ESXi, vSphere and vSphere Client do not support SHA-256OVF Files.
To Convert from SHA256 to SHA1

$ ovftool --shaAlgorithm=SHA1 /path/to/the/original/ova_file.ova /path/to/the/new/ova/file-SHA1.ova

Download and install VMware vSphere ClientEssentially, a client is anything that talks to the Okta service. Within the traditional client-server model, Okta is the server. The client might be an agent, an Okta mobile app, or a browser plugin. from the ESXi/vSphere server.
Open VMware vSphere Client.
Enter the server name or IP address and credentials in the respective fields, and click Login.
In the vSphere Client window, select File > Deploy OVF Template.
In the Deploy OVF Template window, click Browse.
Select the Okta-Access Gateway OVA file, and click Open.
Click Next.
Review the template details provided, and click Next.
When prompted to accept the Access Gateway License agreement. Click Accept and then click Next.
Enter a name for the Access Gateway template, and click Next.
On the next page, select a storage location, and click Next.
Select the appropriate disk format option based on your requirements, and click Next.
Click Finish.

vSphere Client will begin the deployment process.
Click Close in the confirmation dialog box when the deployment is complete.
In the vSphere Client window, click Inventory.
Select the Virtual Machines tab to display the VMs that are currently deployed to the server.
Select the Access Gateway VM, and click Power On (symbolized by a green play icon) in the toolbar.
Right-click the VM, and click Open Console to log in to the VM.

After Okta Access Gateway has been installed there are a number of common post installation tasks that should be performed.
Including:

See Okta Access Gateway Post Installation for a complete task list.
See Access Gateway Command Line Management Console Reference for a complete list of management console commands.
See Access Gateway Admin UI Console Overview for an overview of the Access Gateway UI console.

Post-installation configuration

To monitor the logs, restart services, or edit the hosts file on the appliance, refer to the Access Gateway Command Line Management Console Reference for more information.

Top