Adding a new appliance

Prev Next

AppGate ZTNA appliances are available as physical hardware or virtual machines. This topic covers how to install, verify, and add appliances to a Collective.

Before you begin, confirm which appliance type you are deploying. If this is the first appliance in a new Collective, complete the appliance installation first, then follow the steps in Configuring the first Controller.

This section covers the following:


Installing an appliance

Appliance installation covers physical and virtual machine types, including VMware and Hyper-V. If this is the first appliance in a Collective, see the Configuring the first Controller section after powering it up.

Physical appliance

The physical appliance sold by AppGate ships with AppGate ZTNA software pre-installed. Installation consists of racking the appliance and verifying connectivity. For specifications and connection details, see the Hardware appliance spec section. To update an existing appliance to the latest software version, see the Upgrading an appliance section.

Virtual appliance

Before building a virtual appliance, verify that your hypervisor meets the minimum version requirements.

For test instances, the following minimum resources are required for each test instance:

  • 2 CPUs

  • 4 GB of memory

  • 40 GB of storage

  • 1 network card

  • AES-NI support

NOTE

These parameters are not suitable for production use. For sizing details, see the Instance sizing section.

For production use, the following guidelines apply:

  • Controllers require 6 to 12 vCPUs.

  • Gateways require enough vCPUs for the required throughput. RAM requirements increase with the number of rules, users, and events.

  • The LogServer requires a dedicated appliance with sufficient disk space and RAM.

  • LogForwarders, Metrics Aggregators, and Connectors have low resource requirements.

  • Portals require RAM and vCPUs scaled to the number of users.

Virtualization platforms

Obtain the AppGate ZTNA software as an ISO file or disk image from the AppGate secure Download Center, where hypervisor minimum version requirements are also listed.

Separate installation guides are available for Hyper-V and VMware. You can follow a similar process for other virtualization platforms that use ISO files. The guides cover:

  • Installation prerequisites and recommended system settings

  • The first appliance installation, including creating a Controller

  • Installing subsequent appliances from the seed file generated when configuring another appliance in the Controller

See the installation guide for a virtual appliance on Hyper V.

See the installation guide for a virtual appliance on VMware.

NOTE

Random appliance lockups have been observed when VMware does not handle enabled but non-present CD devices, such as virtual ISO images, correctly. This behavior appears to be Linux build dependent. To prevent this, disable or remove CD devices from VMware guests after installation and seeding.

Checking the authenticity and integrity of downloaded files

The checksums.zip file is available alongside the software and includes the AppGate public key for verifying the authenticity of the .asc file. You can also download the AppGate public GPG key directly: appgate-inc.pub

Use the .asc file to verify the integrity of the software file. To check an .iso file on a Linux machine:

  1. Open the checksums.zip archive and extract the contents to a directory.

  2. Go to that directory.

  3. Import the public key file: gpg --import appgate-inc.pub

  4. Trust the key:
    gpg --import appgate-inc.pub    
    gpg --edit-key 5635CFCADCF8A718    
    gpg> trust    
    gpg> 5    
    gpg> quit

  5. Verify the relevant file (using 6.1.x.iso as an example):  gpg --verify Appgate-SDP-6.1.x.iso.asc Appgate-SDP-6.1.x.iso

The output should resemble the following:

gpg: Signature made Mon 20 Mar 2023 12:35:01 PM CET
gpg:                using RSA key 6F8421F574035654BAF6E51E5635CFCADCF8A718
gpg: Good signature from "Appgate Cybersecurity, INC."
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.

Adding an appliance

If you have not yet configured your first Controller, follow the steps in the Configuring the first Controller section before continuing.

After you have configured the first Controller, you can add additional appliances to the Collective.

Prerequisites

Before adding an appliance, verify that the following requirements are met:

  • The Controller is configured with a working NTP server. Confirm the time and date by running date from the command line.  

  • The Controller can receive inbound connections on ports 443 and 8443.

  • If you are not using the default Site, configure an additional Site. See Sites for more information.  

  • You have the required administrator privileges to add appliances. See Access Management for details.

Pre-configure the following:

  • DNS. The appliance hostname must be resolvable by the Controller.

  • Trusted Certificates. If you will forward logs using the LogForwarder, add the destination certificate to Trusted Certificates (System > Trusted Certificates).

  • Sites. If configuring a Gateway appliance, configure the Site first.

Defining the appliance

Before defining a new appliance, gather the following information:

  • Network interface and routing details

  • Log server details for receiving appliance logs

  • NTP server details, including key information if using secure NTP

You can define an appliance in one of the following ways:

  • Create a new appliance. In the Appliances page, select +Add to open the Add Appliance page.

  • Clone an existing appliance. In the Appliances page, select an existing appliance. In the Edit Appliance page, select Actions > Clone. The Add Appliance page opens with the cloned settings available for editing.

To define a new appliance:

  1. Go to the Appliances page (System > Appliances).

  2. Select +Add to open the Add Appliance page.

System Settings

In the System Settings tab, complete the following fields:

  • Name. Enter the appliance as it will appear in the Admin UI.

  • Notes. Optional. Enter descriptive notes about the appliance.

  • Tags. Select +Add to apply one or more tags.

Settings

  • Automatic Hostname/IP Assignment. Select Enabled to automatically assign a hostname or IP address during activation. This option is supported only for AWS, Azure, GCP, and OpenStack.

  • Appliance Hostname/IP. Enter a fully-qualified domain name or and IPv4 or IPv6 address. You cannot change the hostname of a Controller that is part of a multi-Controller group.

  • Interfaces. Select +Add to configure network interfaces on the appliance. Add one entry for each interface. The eth0 interface is enabled by default. For each interface, complete the following fields:

    • Name. Enter a name for the interface.

    • MTU. Optional. If not specified, the MTU defaults to 1500 unless set by DHCP. The maximum supported MTU for tunneled traffic is 1500.

    • IPv4 Static Addresses. Select +Add to enter an IPv4 address and subnet mask. If you use multiple IP aliases, you can add the address to the SNAT pool by selecting the SNAT Pool checkbox.

    • Enable IPv4 DHCP. Select this checkbox to enable DHCP and optionally configure:

      • DNS. Provide

      • Default Gateway.

      • NTP. If set to true, the DHCP client will ask for or use the provided NTP servers.

      • MTU. If set to true, the DHCP client will ask for or use the provided MTU value to set on the NIC.

    • IPv6 Static Addresses. Select +Add to enter an IPv6 address and subnet mask. If you use multiple IP aliases, you can add the address to the SNAT pool by selecting the SNAT Pool checkbox.

    • Enable IPv6 DHCP. Select this checkbox to enable DHCP and optionally configure:

      • DNS.

      • NTP. If set to true, the DHCP client will ask for or use the provided NTP servers.

      • MTU. If set to true, the DHCP client will ask for or use the provided MTU value to set on the NIC.

Select Done to save the interface configuration.

Routes

Select +Add to configure static routes for traffic that does not match any configured interface subnets.

For each route, configure the following fields:

  • Address. Enter an IPv4 or IPv6 host or network address.

  • Netmask Length. Optional. Use 32 (IPv4) or 128 (IPv6) for a single host.

  • Gateway. Enter the default Gateway IP address.

  • Network Interface. Optional. Specify the interface used to route traffic.

Select Done when finished to add the route.

Static routes are applied in the order shown. You can change the order using the arrows.

DNS and NTP Servers

  • DNS Servers. Select +Add to add DNS servers used internally by the appliance. These servers are used when DNS is not configured for a Site or when entitlement actions return hostnames. This configuration may not be required if DNS is provided through DHCP. For more information on how entitlement actions are resolved, refer to DNS and name resolution.

  • NTP Servers. Select +Add to add one or more NTP servers, unless they are provided through DHCP. To configure the NTP server. Configure the hostname, symmetric key type, key number (1-65535), and key value (case sensitive).

    • If you are using SHA256, SHA384, or SHA512 as your symmetric key type, you will also select the NTP protocol version.

    • If using a HEX value for the key value, add the prefix HEX:.

NOTE

If Protection Profile (PP) mode is enabled, do not use MD5, SHA1, or RMD160 for Symmetric Key Type.

NOTE

Accurate time synchronization is critical. Always check the Dashboard for NTP errors.

SSH Server

Enable Allow sign-in using SSH to permit administrator access to the appliance. Then configure the following options:

  • Password authentication. Enable to allow password-based authentication. If disabled, SSH keys are required. For details of how to add SSH keys to an appliance, refer to System security - best practices.

  • Port. The default is port 22.

  • Allowed Sources (through appliance firewall). Select +Add to add a source by adding the Address, Netmask Length, and the Network Interface. By default, the list contains two entries: address (0.0.0.0) and netmask 0 & address :: and netmask 0. If the list is empty, no SSH connections are allowed.

Matching behavior depends on whether an entry includes an address, netmask, interface, or a combination of these values.

Functions

In the Functions tab, select the appliance function and complete the required fields. See the Connections table below to view the ports that need to be open for all the functions found within a newly deployed Collective.

See the following sections for details on configuring each function:

Refer to the Connections table below for the required open ports for each function.

Miscellaneous

After configuring appliance functions, complete the fields in the Miscellaneous tab as needed:

  • Hosts File. Select +Add to define static hostname mappings used internally and for entitlement resolution.

  • Extra Hostnames in Certificate. Select +Add to add additional hostnames required for scenarios such as HA Gateways and Controllers.

  • Allow Ping Sources. Ping is disabled by default. Select +Add to configure allowed ICMP sources.

  • Appliance Customization. Use the dropdown to select a customization script to apply to the appliance. For more information, see the Appliance customizations section.

  • Rsyslog Destinations. Select +Add to configure external log forwarding, including support for JSON audit logs:

    • Selector. Add the Rsyslog FACILITY.PRIORITY selector(s).

    • Template. Optional. Enter the formatting template for each message sent. %KEYWORD% is replaced by the value of KEYWORD for each message. For example %syslogtag% %msg%

    • Destination. Enter the hostname or IP address, adding the prefix @ for UDP or @@ for TCP. For example, @192.168.1.25

NOTE

The connection will not be encrypted, so do this only on a secure network. For details of how to configure secure log transfer, refer to Configuring secure log transfer using Rsyslog.

  • SNMP Server. Enable SNMP monitoring and configure ports and allowed sources. The AppGate ZTNA appliance includes its own SNMP MIB which can be downloaded from Settings > Utilities.

  • Healthcheck Server. Enable a healthcheck service. It returns HTTP 200 if the system is healthy, or HTTP 503 if the system is unhealthy.

  • Prometheus Exporter. Configure metrics export, ports, HTTPS, and authentication options.. There is a table that provides full details of all the Prometheus metric types available in the AppGate ZTNA appliance.

Select Save to complete the appliance configuration. You can then activate the appliance.


Connections table

The table below provides a summary of the required network ports that must be open for all functions found in a Collective.

Destination

Source

Controller

Gateway

Connection Broker

LogServer

LogForwarder

Metrics Aggregator

Telemetry Aggregator

Connector

Portal

ZTP ( *.appgate.net)

Controller / Connection Broker

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

Gateway

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

LogServer

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

LogForwarder

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

Metrics Aggregator

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

Connector / Portal

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

Client

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

TCP 443

UDP 443

UDP 53

User's browser

TCP 443

Admin's browser / API

(restricted sources)

TCP 8443

TCP 22

TCP 22

TCP 22

TCP 22

TCP 22

TCP 22

TCP 22

TCP 22

The Interface schematic illustrates interface connections in a typical installation.