High availability commands

Use high availability commands to monitor the status of all Management servers in your IBM® API Connect cloud.

Table 1.
Command name Action Syntax
ha list

Display the network, database, and runtime status for each management server in your IBM API Connect cloud.

The following information is displayed for each server:
Self
Displays the value Yes or No to indicate which server the command was issued from.
IP
The server IP address.
HA
Displays the value Yes or No to indicate whether the server can participate in high availability operations, and therefore whether it is able to be the Primary server and make decisions about which server should be the Primary server. A server that does not participate in high availability operations still receives database updates, and allows for load distribution. Change this setting by using the ha set host command.
Network
The network status. Displays the value Up or Down.
Role
The database role, which can take the following values:
  • Primary: the only server in the cloud that is responsible for writing to the database.
  • Active Arbitrator: the connection manager that decides which server to promote to the Primary server if the current Primary server becomes unavailable.
  • HDR: the high availability server that is constantly synced with the Primary server. API Connect does not use HDR outside of the main site feature.
  • RSS: a server that can be read from, and which forwards database write operations to the Primary server.
Runtime
The status of all applications on the server; for example, Cloud Manager and Developer Portal. Displays the value Up or Down, indicating whether the server processes are running correctly and are available for use.
FQDN
The fully qualified domain name of the server.
 ha list
ha list [timeout] [json]

Optional flags to define the maximum length of time you will wait for a server to respond before there is a timeout, and to convert your output into JSON.

ha list [timeout] [json]
ha make primary [host <host>] [force] Converts given server into Primary. Defaults to the local server.
Note: If cloud's current Primary is unavailable, this may result in data loss.
 ha make primary [host <host>] [force]
ha set host <host> <enabled|disabled> Configures server in cloud to allow/disallow it to become Primary or Active Arbitrator (AA). ha set host <host> <enabled|disabled>
ha set default <enabled|disabled> The high availability setting to use for new servers added to this cloud. ha set default <enabled|disabled>
ha show <default|host <host>> Output the current high availability setting of the cloud or given server. ha show <default|host <host>>

Example output

Self  IP        HA    Network     Role      Runtime  FQDN
Yes   1.2.3.4   Yes   Up          RSS/AA    Up       myserver1.com
No    1.2.3.5   Yes   Up          Primary   Up       myserver2.com
No    1.2.3.6   No    Up          RSS       Up       myserver3.com