Starting and Stopping the API Gateway

Contents

Overview
Setting passphrases
Starting the Node Manager
Starting the API Gateway Instance
Connecting to the API Gateway in Policy Studio
Stopping the API Gateway Instance
Stopping the Node Manager

Overview

This topic describes how to start and stop the Node Manager and API Gateway instance on all platforms. It also describes how to start the Policy Studio graphical tool. For details on launching API Service Manager in your browser, see the section called “Launching API Gateway Manager”. For details on API Gateway components and concepts, see the API Gateway Concepts Guide.

Setting passphrases

By default, data is stored unencrypted in the API Gateway configuration store. However, you can encrypt certain sensitive information, such as passwords and private keys using a passphrase. When the passphrase has been set, this encrypts the API Gateway configuration data. You must enter the passphrase when connecting to the API Gateway configuration data (for example, using the Policy Studio, or when the API Gateway starts up). For more details on configuring this passphrase, see Setting the Encryption Passphrase.

Starting the Node Manager

The following instructions describe how to start the Node Manager on the command line on Windows and UNIX:

Windows

Complete the following steps to start the Node Manager on Windows:

  1. Open a DOS prompt at the /Win32/bin directory of your API Gateway installation.

  2. Run the nodemanager.bat file.

  3. If you are using an encryption passphrase, you are prompted for this passphrase. Enter the correct encryption passphrase, and press Return. For more details, see Setting the Encryption Passphrase.

Linux/Solaris

To start the Node Manager on Linux/Solaris, complete the following instructions:

  1. Open a shell at the /posix/bin directory of your API Gateway installation.

  2. Run the nodemanager.sh file, for example: 

    prompt# ./nodemanager

  3. If you are using an encryption passphrase, you are prompted for this passphrase. Enter the correct encryption passphrase and press Return. For more details, see Setting the Encryption Passphrase.

Starting the API Gateway Instance

The following instructions describe how to start the API Gateway instance on the command line on Windows and UNIX:

Windows

Complete the following steps to start the API Gateway on Windows:

  1. Open a DOS prompt at the /Win32/bin directory of your API Gateway installation.

  2. Use the startinstance command to start the API Gateway, for example: 

    startinstance -n "my_server" -g "my_group"

  3. If you are using an encryption passphrase, you are prompted for this passphrase. Enter the correct encryption passphrase, and press Return. For more details, see Setting Passphrases.

  4. When the API Gateway has successfully started up, you can run the policystudio.exe file from your Policy Studio installation directory.

  5. When the Policy Studio is starting up, you are prompted for connection details for the API Gateway. For more details, see Connecting to the API Gateway.

Linux/Solaris

To start the API Gateway instance and the Policy Studio on Linux/Solaris, perform the following steps:

  1. Open a shell at the /posix/bin directory of your API Gateway installation.

  2. Use the startinstance command to start the API Gateway, for example: 

    startinstance -n "my_server" -g "my_group"

    [Note] Note

    You must ensure that the startinstance file has execute permissions.

  3. If you are using an encryption passphrase, you are prompted for this passphrase. Enter the correct encryption passphrase and press Return. For more details, see Setting Passphrases.

  4. When the API Gateway has successfully started up, run the policystudio.sh file in your Policy Studio installation directory. For example: 

    prompt# cd /usr/home/policystudio
prompt# ./policystudio

  5. When the Policy Studio is starting up, you are prompted for connection details for the API Gateway.

[Tip] Tip

You can enter the startinstance command without any arguments to display the servers registered on the machine. For example: 

INSTALL_DIR\Win32\bin>startinstance

usage: "startinstance [[-n instance-name -g group-name [instance-args]] | 
[directory-location [instance-args]]]"

The API Gateway instances listed below are available to run on this machine 
as follows:
   startinstance -n "server1" -g "group1"
   startinstance -n "server2" -g "group2"

If you have a single API Gateway instance on the host on which you run startinstance, that instance starts when you specify no arguments.

Connecting to the API Gateway in Policy Studio

When starting the Policy Studio, you are prompted for details on how to connect to the Admin Node Manager (for example, the server session, host, port, user name, and password). The default connection URL is: 

https://HOST:8090/api

where HOST points to the IP address or hostname of the machine on which the API Gateway runs. For more details, see Connection Details.

Stopping the API Gateway Instance

Linux/Solaris

To stop the API Gateway instance, you must specify the group and instance name to the startinstance command along with the -k option. For example: 

./startinstance -g "my_group" -n "my_server" -k

Windows

To stop the API Gateway instance, you can enter Ctrl-C on the command prompt. If the API Gateway instance is installed as a Windows service, you should use the Windows Services tool.

Stopping the Node Manager

Linux/Solaris

To stop the Node Manager, you must specify the nodemanager command along with the -k option. For example: 

./nodemanager -k

Windows

To stop the Node Manager, you can enter Ctrl-C on the command prompt. If the Node Manager is installed as a Windows service, you should use the Windows Services tool.

Prev  Up  Next
  Home