The Appliances page

Prev Next

An appliance is the virtual or physical instance on which the system is running. A group of appliances is referred to as the Collective. Each appliance is a stateless, configurable machine that can operate as one or a combination of the following:

  • Controller. The first appliance you configure. The Controller is the central point of administration for AppGate ZTNA. It is a stateless appliance with an internal database used to store system configuration.

  • Gateway. An enforcement point, responsible for controlling user access to protected resources.

  • Connection Broker. Handles NAT traversal in AppGate ZTNA.

  • Connector. Extends connectivity to remote sites and unmanaged resources without requiring the use of a standalone Client.

  • Portal. Hosts a web frontend, allowing browser-based access for multiple users without requiring the use of a standalone Client.

  • LogServer. Collects logs from other members of the Collective.

  • LogForwarder. Collects, groups, and securely distributes audit logs within an enterprise environment.

  • Metrics Aggregator. Collects, groups, and securely exports Prometheus metrics for an enterprise environment.

  • Telemetry Aggregator. Centralizes and manages the flow of observability data across the Collective.

The Appliances page contains all appliances you have configured in the Collective. You can switch between two layouts: Default and Stats. Each layout displays different information to help you monitor appliance configuration and health.


Default Layout

The Default layout includes the following columns:

  • Name. The name of the appliance.

  • Status. The current health status of the appliance. Possible values are: Healthy, Busy, Error, Not active, Offline, or Warning. Click the status to open Appliance Health Details.

  • Hostname. The appliance hostname.

  • Functions. The function or functions assigned to the appliance.

  • Site. The Site associated with the appliance.

  • Tags. Tags applied to the appliance.

  • Last Modified. The date and time when the appliance was last updated.


Stats Layout

The Stats layout includes the following columns:

  • Name. The name of the appliance.

  • Status. The current health status of the appliance. Can be Healthy, Busy, Error, Not active, Offline, or Warning.

  • Functions. The function or functions assigned to the appliance.

  • Site. The Site associated with the appliance.

  • Version. The AppGate ZTNA version running on the appliance.

  • Sessions. The number of active user sessions.

  • CPU. CPU usage as a percentage.

  • Memory. Memory usage as a percentage.

  • Disk. Disk usage as a percentage.


Appliance Health Details

Clicking an appliance status opens the Appliance Health Details window, which displays the following information:

  • Appliance name. The name of the selected appliance.

  • Appliance Health. The overall health status of the appliance:

    • Busy. The appliance is connected and performing an action, such as starting up.

    • Error. The appliance is connected but not healthy.

    • Healthy. The appliance is correctly configured and functioning.

    • Not active. The appliance has not yet been activated.

    • Offline. The appliance is activated but not connected to a Controller.

    • Warning. The appliance is connected but not healthy.

  • Function(s) Health. Health status for configured functions, such as Controller, Gateway, LogServer, LogForwarder, Portal, Connector, or Metrics Aggregator.

  • Upgrade Status. Displays Idle unless an upgrade is in progress.

  • Appliance Metrics. CPU, memory, and disk throughput (percent) for the busiest NIC and IP addresses.

NOTE

The system does not use a swap partition. If memory usage remains consistently high, upgrade the appliance or add another appliance. See the Instance sizing section for CPU, memory, and disk requirements.

  • Network. Displays the following network metrics:

    • RX speed

    • TX speed

    • Busiest NIC

    • Dropped inbound packets

    • Dropped outbound packets

    • IP addresses on eth0

  • Appliance Customization. The name of the currently active appliance customization.


Filtering and Sorting Appliances

Use the Search field to filter the Appliances page. For example, entering “healthy controller” displays appliances with the Controller function with a Healthy status.

Click on a column header to sort that column.

NOTE

If a customization is installed, it appears in the Version column with “(c)”.


Managing appliances

The Actions button provides the following bulk options:

  • Add Tag. Apply a tag to one or more appliances.

  • Remove Tag. Remove a tag from one or more appliances.

  • Configure from Source. Replace fields in a target appliance or appliances with settings from a source appliance. Select the target appliance(s), then select Configure from Source. In the window that appears, select the source appliance and the fields to copy. Select Replace Fields, and the selected settings are applied to all target appliances.

Configuration settings for bulk actions.

More appliance actions are available by selecting the three dots icon (Three circular shapes stacked vertically on a dark background, selected to access a menu.) next to each appliance. The actions are:

  • Reboot. Restarts the appliance.

  • Renew Certificate. Renews the appliance certificate. This is required after changing appliance settings.

NOTE

The appliance is temporarily deactivated until certificate renewal is completed. Active AppGate Client connections will be reconnect automatically.

NOTE

Changing the appliance hostname or IP automatically renews the certificate. The appliance status may briefly appear as Not Active.

  • Download Logs. Downloads a .zip file containing all the appliance’s daemon logs.

  • Deactivate. Deactivates the appliance and sets its status to Not Active. This removes all configurations and re-enables the Export seed file/ISO action.

NOTE

You cannot deactivate a functioning Controller. First disable the Controller function and wait for the status to become Healthy.

  • Suspend/Resume. Gateways only. Suspends and resumes new connections. The Gateway can also auto-suspend.

  • Run Commands. Opens the Run Commands window. You can run up to five commands concurrently from the following list:

    • addressshow

    • dig

    • ip route show

    • netcat

    • nptq

    • ping

    • tcpdump

    • traceroute

For commands with a Timeout field, specify the duration in seconds.

  • Export seed file/ISO. Available only when the appliance status is Not Active. Use this option to configure a new appliance using a seed file. See Activating an appliance for more information.