Set up an on-premise gateway

You set up a gateway on ESXi in two stages:

• Download a gateway image (OVA file) and deploy it in ESXi.

• Add gateway settings in Sophos Central to generate an ISO file ("seed image") that you use to boot the gateway in ESXi.

You can set up a gateway cluster to ensure availability. To do this, you set up additional instances of the gateway, as described here.

If you're using a two-arm proxy, see Network configuration.

Download and deploy image

1. In Sophos Central, go to Protect Devices.

2. Find Zero Trust Network Access.

   1. Click the download link for a gateway image.
   2. Accept the license agreement and (if you're prompted) the software export compliance forms.
   3. The gateway image is downloaded. This is a generic OVA image of the ZTNA gateway for ESXi servers. You can reuse it as many times as you want.

   

3. Deploy the OVA image to your ESXi host. In VMware vSphere, right-click the host and select Deploy OVA Template. This runs an assistant to guide you through deployment.

   Warning

   Turn off the option for automatic power-on (the default on ESXi) or prevent the ZTNA gateway from booting after you finish. If you don't, the gateway will boot without the ISO files and you'll have to start again.

   

Add settings and boot gateway

1. Go back to Sophos Central and go to ZTNA > Gateways. Click Add Gateway.

   

2. For Gateway Mode, select On-premise.

   

3. In Add gateway, do as follows:

   1. Enter a gateway name and the gateway FQDN.
   2. Enter the domain for the resources (apps).
   3. In Platform type, select VMware ESXi.

   4. Select the Deployment mode.

      • One-arm uses the external interface for incoming and outgoing traffic.
      • Two-arm uses both external and internal interfaces.

   5. Enter the Interface settings.

      • If you select DHCP, set a reservation on the DHCP server.

        Warning

        The gateway can't handle changes in its IP address. You must set a reservation to ensure that it always keeps the initial IP address that DHCP assigns.

      • If you select Static IP, specify IP address, subnet, and DNS server settings.

      In a two-arm deployment, you must specify Static routes if you have apps hosted on multiple internal networks.

   6. Upload the certificates you created earlier.

   7. Click Save and generate file.

   Note

   Only a single, wildcard certificate is supported in this release.

   

4. On the Gateways page, the gateway's status is Waiting for Deployment.

   The seed image ISO is ready for download. You'll need it to boot the gateway and complete the registration process. The ISO is unique for each gateway. You can't reuse it.

   Note

   Before you download the image, we suggest that you create a gateway cluster. If you don't want a cluster, skip to step 6.

   .

5. Click your new gateway to open its details page. Click Add/Edit instances.

   

6. In Add/Edit instances, do as follows:

   1. Click Add another instance. Clustering turns on automatically.

   2. Enter a Cluster virtual IP. This is used for cluster management and load balancing. It must be in the same IP range as the gateway instances.

      In a two-arm deployment, the external cluster VIP is for load balancing only. If you use an external load balancer, leave this blank.

   3. Enter a VM name and Interface IP for the new instance.

      In a two-arm deployment, enter an internal and external interface IP.

   4. Repeat the process to add another instance.

   You must have at least three instances for a cluster. You can have up to nine instances, but you must always have an odd number.

   

7. Download each ISO file and mount it on your host. Then attach it to the gateway, as follows:

   1. Go to VMware vSphere.
   2. Right-click the gateway VM and select Edit Settings.
   3. On the Hardware tab, in CD/DVD drive, ensure the ISO file is shown and select Connect.
   4. In Status, select Connect at Power on.
   5. Click Save.

   If a serial device is listed in the virtual hardware, you can safely remove it.

   When the gateway boots with the ISO file, it'll contact Sophos Central to register.

   

8. Go back to Sophos Central. On the Gateways page, the gateway status changes to Awaiting Approval.

   When you're prompted, approve gateway registration.

   It can take up to ten minutes for approval to take effect. The gateway status then changes to Connected. You'll see an option to create a password if you want to.

You've finished setting up the on-premise gateway.

When a new virtual machine version is available, a green check mark shows in the version column. Click the version number to start or schedule an update. See Gateway updates in Gateways.

To set up a gateway on Microsoft Hyper-V, do as follows:

• Download and deploy the gateway VM image.

• Add gateway settings to generate an ISO file ("seed image").

• Download the ISO file and boot the gateway.

Download and deploy image

1. In Sophos Central, go to Protect Devices.

2. Under Zero Trust Network Access, click Download Gateway VM image for Hyper-V.

   A ZIP file containing the VM image is downloaded.

   

3. Extract the Hyper-V base image from the ZIP file you downloaded.

   This gives you the .vhdx file you need to set up the gateway. You can't use this file to deploy more than one VM, but you can make copies and use them for additional VMs.

4. In Hyper-V Manager, in the Virtual Machines list, in Actions, click New.

   

5. Enter a name for the VM.

   

6. Select the generation. Generation 1 supports both 32-bit and 64-bit operating systems.

   

7. In Assign Memory, enter at least 4096 MB of startup memory.

   

8. In Configure Networking, select a network adapter.

   

9. In Connect Virtual Hard Disk, select Use an existing virtual hard disk and browse to the .vhdx file that you extracted from the VM image download.

   

10. Click Finish.

    

11. Go to the Settings for the new VM.

    1. In Hardware > Processors, set Number of virtual processors to "2".

    2. If your gateway is in a two-arm deployment, go to Network adapter and add another adapter to the VM.

    

12. Click Apply and Save.

Add gateway settings

1. Go back to Sophos Central and go to ZTNA > Gateways. Click Add gateway.

   

2. For Gateway Mode, select On-premise.

   

3. In Add gateway, do as follows:

   1. Enter a gateway name and the gateway FQDN.
   2. Enter the domain for the resources (apps).
   3. In Platform type, select Hyper-V.

   4. Select the Deployment mode.

      • One-arm uses the external interface for incoming and outgoing traffic.
      • Two-arm uses both external and internal interfaces.

   5. Enter the Interface settings.

      • If you select DHCP, set a reservation on the DHCP server.

        Warning

        The gateway can't handle changes in its IP address. You must set a reservation to ensure that it always keeps the initial IP address that DHCP assigns.

      • If you select Static IP, enter an IP address, a subnet, and DNS server settings.

      In a two-arm deployment, you must specify Static routes if you have apps hosted on multiple internal networks.

   6. Upload the certificates you created earlier.

   7. Click Save and generate file.

   Note

   Only a single, wildcard certificate is supported in this release.

   

4. On the Gateways page, the new gateway's status is Waiting for Deployment. Click the gateway to see details.

   

5. In the gateway details, you can see that the ISO image is ready for download. You'll need it to boot the gateway. The ISO is unique for each gateway. You can't reuse it.

   Before you download the image, we suggest that you create a gateway cluster. If you don't want a cluster, skip to the 'Download ISO files and boot the gateway' section.

   

6. In the gateway details, click Add/Edit instances.

   

7. In Add/Edit instances, click Add another instance. Clustering turns on automatically.

   

8. Enter the details of the new instance as follows:

   1. Enter a Cluster virtual IP. This is used for cluster management and load balancing. It must be in the same IP range as the gateway instances.

      In a two-arm deployment, the external cluster VIP is for load balancing only. If you use an external load balancer, leave this blank.

   2. Enter a VM name and Interface IP for the new instance.

      In a two-arm deployment, enter an internal and external interface IP.

   3. Repeat the process to add another instance.

      Note

      You must have at least three instances for a cluster. You can have up to nine instances, but you must always have an odd number.

   

Next you download the ISO files and boot the gateway.

Download ISO files and boot the gateway

Download the ISO file for each instance, attach them to the gateway VM, and boot the gateway, as follows:

1. In the gateway details, go to each instance and click Download image.

   

2. In Hyper-V Manager, go to Settings for the VM. In DVD Drive, do as follows:

   1. In Controller, select IDE Controller 1.
   2. In Media, select Image file and enter the path to the seed ISO.
   3. Click Apply and Save.

   Note

   The ISO file must stay attached to the gateway. You can't unmount it after the gateway is booted.

   

3. Power on the gateway instances. Wait for a few minutes.

4. In Sophos Central, go to ZTNA > Gateways and click the new gateway to open its details page.

   The gateway status changes to Waiting for gateway approval. Click Approve.

   

5. The gateway's status changes to Active.

You've finished setting up the on-premise gateway.

When a new virtual machine version is available, a green check mark shows in the version column. Click the version number to start or schedule an update. See Gateway updates in Gateways.

To set up a ZTNA gateway in Amazon Web Services (AWS), do as follows:

1. In Sophos Central, go to ZTNA > Gateways.

   

2. On the Gateways page, click Add gateway.

   

3. For Gateway Mode, select On-premise.

   

4. In the Add gateway dialog, add your details as follows:

   1. Enter the gateway name and FQDN.
   2. Enter the domain for the resources (applications).
   3. In Platform type, select Amazon Web Services.
   4. In Identity provider, select the identity provider you set up earlier.
   5. Upload the certificates you created earlier.
   6. Click Save.

   

5. On the Gateways page, you now see the new gateway. Click the Launch stack link beside it.

   

Create a stack in AWS

In AWS, in CloudFormation, you see the Quick create stack template. We've already partly configured it. Follow the steps below to complete it.

1. On the Quick create stack page, do as follows:

   1. Select an AWS region (upper right of the screen).
   2. In Stack name, enter a custom name.

   

2. In Basic configuration, select two or three availability zones to ensure the gateway's availability.

   

3. In VPC network configuration, do as follows:

   1. Set the number of availability zones. This must match the number of zones you selected in the previous step.
   2. Ensure the subnets don't conflict with existing resources.
   3. In MaxNumberOfNodes, set the maximum number of nodes. By default, this is three.
   4. In NodeInstanceType, select the type of EC2 instance to use.
   5. In NumberOfNodes, set the number of nodes you want. The default is one for each availability zone.

   Auto-scaling isn't currently available for ZTNA.

   

4. Click Create stack and wait for the process to finish. This can take up to an hour. When it's finished, your new stack is in your AWS stack list, and the details look like this.

   

5. In Sophos Central, go to the new gateway. Click Approve.

   It can take up to ten minutes for approval to take effect. The gateway status then changes to Connected.

   

Configure your new VPC

Configure the VPC as follows:

1. In AWS, go to Virtual Private Cloud > Your VPCs.

   

2. Go to your new VPC and look for the VPC ID. You can use this ID to search for the other components that you’ve created.

   

3. Go to your EC2 instances and search for instances with the new VPC ID. This finds the instances that make up the ZTNA gateway cluster. Rename them.

   

4. In Load balancing, use the VPC ID to find the load balancer for ZTNA. Open its details and copy the DNS name. You need this to create a public DNS record (CNAME) for the gateway, which points to the load balancer.

   

Create a peering connection

The gateway is always in a new VPC, so you must use peering to connect it with the VPC where your applications are.

1. Go to VPC > Peering connections. Click Create peering connection and do as follows:

   1. In VPC ID (requester), select the ZTNA gateway's ID.
   2. In VPC ID (Accepter), select the VPC where your resources are.
   3. Click Create peering connection.

   

2. Go to Subnets and add your resources subnet and your gateway's private subnets to the route tables. This lets ZTNA use the peering connection to connect to resources.

   

You've finished setting up the on-premise gateway.

When a new virtual machine version is available, a green check mark shows in the version column. Click the version number to start or schedule an update. See Gateway updates in Gateways.