Startup Instructions

Overview

This topic describes how to start the Node Manager and API Gateway on all platforms in console mode . It also describes how to start the Policy Studio. For details on launching API Service Manager in your browser, see Introduction to API Service Manager. For details on API Gateway components and concepts, see the Oracle API Gateway Architecture.

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 in console mode on Windows and UNIX systems:

Windows

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

  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 API Gateway and the Policy Studio on Linux/Solaris systems, 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

The following instructions describe how to start the API Gateway on the command line in console mode on Windows and UNIX systems:

Windows

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

  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 and the Policy Studio on Linux/Solaris systems, complete the following instructions:

  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"

Connecting to the API Gateway

When starting up the Policy Studio, you are prompted for details on how to connect to the API Gateway. These include details such as 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 is running. For more information on configuring these settings, see Connection Details.