Configure the Appliance Gateway

This topic describes how to configure a Hardware Appliance or a Virtual Appliance Gateway. For instructions on installing and configuring a Software Gateway, see  instead.
gateway94
This topic describes how to configure a Hardware Appliance or a Virtual Appliance Gateway. For instructions on installing and configuring a Software Gateway, see Configure the Software Gateway instead.
The Gateway appliance comes preconfigured with the most common settings and requires only minimal additional configuration before use.
 Review the Network Deployment Guide first to gain a better understanding of the various network configurations. This knowledge will help you better configure your Gateways.
Contents:
 
 
Configure a Hardware Appliance
Configure Hardware Appliance
Configure Hardware Appliance
 
Prerequisites:
 
Ensure that you have the appropriate cables and peripherals for your server type:
The Oracle X5-2 and X4-2 servers are equipped with several USB ports and a VGA port. This allows you to connect a monitor and peripherals.
The Oracle X7-2 server is shipped with only a single USB port and no VGA port. To connect to this server, you must use the Oracle ILOM (Integrated Lights Out Manager). For information on using ILOM, refer to the Oracle user documentation.
  1.  
    (For X7-2 only)
     Use the Serial management port to obtain the ILOM IP address (see Connect Using Serial Management Port).
  2.  
    (For X7-2 only)
     Once you have obtained the ILOM IP address, use ILOM to connect to the appliance.
  3. Access the Gateway main menu on the Gateway machine being configured.
     The Gateway main menu contains many options. When setting up an appliance for the first time, you only need to run a few of the options. The other options are used for maintaining and administering your Gateway.
  4. Select 
    1
     (Configure system settings) and then 
    1
     (Configure networking and system time settings). If you use a non-standard keyboard layout, then run option 
    3
     (Configure keyboard layout) as well. 
    Reference:
     Gateway System Settings (Appliance).
  5. Return to the top level of the main menu. Select option 
    2
     (Display CA API Gateway configuration menu) and then option 
    2
     (Create a new CA API Gateway database) to create your first (or only) Gateway database node. 
    Reference:
     Gateway Configuration Menu (Appliance).
  6. If you need to add a new processing node to a cluster, select option 
    3
     (Configure the CA API Gateway). 
    Reference:
     Gateway Configuration Menu (Appliance).
  7. If you intend to have your Gateway managed remotely using the 
    API Gateway
     - Enterprise Service Manager:
    1. Return to the top level of the main menu.
    2. Run option 
      7
       (Display Enterprise Service Manager configuration menu). 
      Reference:
       Configure the Enterprise Service Manager.
    3. Run option 
      5
       (Display Remote Management configuration menu). 
      Reference:
       Configure the Gateway for Remote Access.
  8. Return to the top level of the main menu. Select option 
    6
     (Manage HSM) to configure a Hardware Security Module that safeguards and manages your digital keys. 
    Reference:
     Configure Hardware Security Modules (HSM).
  9. Install the Gateway license. 
    Reference:
     Manage Gateway Licenses.
Configure a Virtual Appliance
The Virtual Appliance is almost identical to the Hardware Appliance. This section provides a high level overview of the configuration process for the Virtual Appliance. For detailed information, see the 
CA API Gateway Virtual Appliance Getting Started, Rev 2.3.pdf
 in the Release Notes.
Configure Virtual Appliance
Configure Virtual Appliance
  1. Start the ESXi or Workstation *.ova image.
  2. Ensure that the virtual machine settings are set correctly:
    • Memory should be at least 768MB. The more the better.
    • Network Adapter is set correctly.
  3. If using the ESXi Server, map the virtual network interface to the appropriate virtual network switch.
  4. Power on the Virtual Machine.
  5. Log in as 
    ssgconfig
     with password 
    7layer
    . Change the password when prompted.
     Refer to "Password rules" in Troubleshooting Password Issues for tips when creating your new password.
  6. Access the Gateway main menu. 
  7. Select 
    1
     (Configure system settings) and then 
    1
     (Configure networking and system time settings). If you use a non-standard keyboard layout, then run option 
    3
     (Configure keyboard layout) as well. 
    Reference:
     Gateway System Settings (Appliance).
  8. Select option 
    2
     (Display CA API Gateway configuration menu) and then option 
    2
     (Create a new CA API Gateway database) to create your first (or only) Gateway database node. 
    Reference:
     Gateway Configuration Menu (Appliance).
  9. If you need to add a new processing node to a cluster, select option 
    3
     (Configure the CA API Gateway). 
    Reference:
     Gateway Configuration Menu (Appliance).
  10. If you intend to have your Gateway managed remotely using the 
    API Gateway
     - Enterprise Service Manager:
    1. Return to the top level of the main menu.
    2. Run option 
      7
       (Display Enterprise Service Manager configuration menu). 
      Reference:
       Configure the Enterprise Service Manager.
    3. Run option 
      5
       (Display Remote Management configuration menu). 
      Reference:
       Configure the Gateway for Remote Access.
  11. Install the Gateway license. 
    Reference: 
     Manage Gateway Licenses.