About this guide

This guide describes how to install and administer the API Gateway Appliance. It explains how to install and configure the physical appliance and virtual appliance form factors, and describes how to administer the API Gateway Appliance using the Web Administration Interface.

Who should read this guide

The intended audience for this guide is system engineers who are responsible for installing, configuring, and maintaining an API Gateway Appliance.

Before installing or using an API Gateway Appliance you should have an understanding of API Gateway concepts and features. For more information, see the API Gateway Concepts Guide.

Others who might find parts of this guide useful include network or systems administrators and other technical or business users.

How to use this guide

This guide should be used in conjunction with the other guides in the API Gateway documentation set.

Before you begin, review this guide thoroughly. The following is a brief description of the contents of each section:

About the Axway Appliance Platform – Introduces the Axway Appliance Platform.

Install your Axway virtual appliance and product – Provides an overview of how to install a virtual appliance.

Power up, connect to, reboot, and shut down the appliance – Describes how to power up the appliance, how to connect to it (including connecting to the Web Administration Interface), and how to reboot or shut down the appliance.

Configure additional hardware on the physical appliance – Describes how to configure the additional hardware on the physical API Gateway Appliance.

Configure Cassandra HA on the appliance – Describes how to configure Apache Cassandra for high availability (HA) on the API Gateway Appliance.

Get started with the API Gateway Appliance – Describes how to get up and running quickly with API Gateway on the appliance.

Configure API Gateway on the appliance – Describes how to configure API Gateway on all appliance form factors.

Administer your appliance using the Web Administration Interface – Describes how to administer the appliance using the Web Administration Interface.

Appliance console menu reference – Provides an overview of the menu options on the Axway Appliance Platform console.

Configure your appliance network settings – Describes how to configure the appliance network settings from the Axway Appliance Platform console.

Work with appliance passwords – Describes how to change passwords from the Axway Appliance Platform console.

Configure Linux audit framework – Describes how to configure the Linux audit framework from the Axway Appliance Platform console.

Manage your system – Describes how to manage system settings from the Axway Appliance Platform console.

Configure the DELL Remote Access Controller – Describes how to configure the RAC from the Axway Appliance Platform console.

Backup and restore hardware configuration and virtual appliance – Describes how to back up and restore from the Axway Appliance Platform console.

Upgrade the Axway Appliance Platform – Describes how to upgrade the Axway Appliance Platform on the appliance.

Update your appliance using zypper – Describes how to update system software and API Gateway software on the API Gateway Appliance.

Upgrade API Gateway on the appliance – Describes how to upgrade the API Gateway software on the appliance.

Upgrade API Gateway on a Vordel OEL-based physical appliance – Describes how to upgrade from an Oracle Enterprise Linux (OEL) hardware appliance (Vordel appliance) to the Axway Appliance Platform, a SuSE Linux Enterprise hardware appliance.

Monitor your appliance – Describes how to monitor your system hardware, CPU usage, and memory usage.

Troubleshooting your appliance – Provides information on troubleshooting the API Gateway Appliance.

Related topics

Related documentation

Related Links