Skip to content
CA API Gateway - 9.3
Documentation powered by DocOps

Gateway Main Menu (Appliance)

Last update May 16, 2018

The CA API Gateway main menu is used to configure networking and application settings. Additionally, it provides access to the privileged (root) shell and other administrative tasks.

To access the Gateway main menu:

  1. Is there network connectivity to the Gateway appliance?
    • If NO, proceed with step 2.
    • If YES, proceed to step 3.
  2. At the machine (networking not yet set up):
    If networking is not yet set up, you must either be physically at the Gateway appliance or have remote serial console access. You can access the console of the hardware appliance in those ways:
    For more information on using a serial connection, see Connect Using Serial Management Port.
  3. At the login screen, log in as user ssgconfig using the default password 7layer. The main menu appears.

    WARNING: You are prompted to change the password the first time you log in as the ssgconfig user. The new password must adhere to the rules described under "Password Rules" in  Troubleshooting Password Issues. The ssgconfig account is locked after five (5) unsuccessful login attempts (for standard Gateways as shipped from CA Technologies; lockout counters on custom appliances may differ). To reset this account, see "Unlocking the SSGCONFIG Account" in in  Troubleshooting Password Issues.
  4. Remotely (networking has been set up):
    If networking has been set up, you can either log in locally (as described in step 2 above) or remotely connect via SSH to the Gateway as user ssgconfig. For example:
    • Linux: ssh ssgconfig@<SSG_host>
    • Windows: Use PuTTY or a similar utility
    Note: SSH is possible only through eth0, not eth1.

    Note that not all options are available in every system; for example, option 6 (Manage HSM) is displayed only if a Hardware Security Module (HSM) is present.
    The following is the Gateway main menu. Note that the top of the menu shows the Gateway version and the underlying operating system (for example, RHEL or CentOS) and version. When downloading patches for upgrading, be sure to download the patches for the correct operating system.

Welcome to the CA API Gateway - x.x.xx
running on CentOS release x.x (Final)

This user account allows you to configure the appliance
What would you like to do?

1) Configure system settings
2) Display CA API Gateway configuration menu
3) Use a privileged shell (root)
4) Change the Master Passphrase
5) Display Remote Management configuration menu
6) Manage HSM
7) Display Enterprise Service Manager configuration menu
8) Display Patch Management menu
9) Display Log Viewing menu
R) Reboot the CA API Gateway appliance (apply the new configuration)
X) Exit (no reboot)

Please make a selection: 1

The following table describes each option in the main menu:

Option Description
1) Configure system settings Use this option to view or configure system settings on the Gateway appliance. These settings must be set up before you can configure the Gateway application. For details, see Gateway System Settings.
2) Display CA API Gateway configuration menu Use this option to configure the Gateway application before starting it. For details, see Gateway Configuration Menu.
3) Use a privileged shell (root) Use this option to open a command shell with root user privileges. You will need this to perform certain administrative tasks in the Gateway. For more information, see Privileged Shell for Root Commands. The default password is 7layer.

4) Change the Master Passphrase

(not for nShield HSM)

Use this option to change the master passphrase that is used to encrypt the Gateway’s database and keystore passwords.

If the master passphrase has been changed from the default, you must enter the current passphrase before specifying a new passphrase.

The master passphrase must be between 6 and 128 characters in length. You will be prompted to enter the new master passphrase twice. Hint: It is best to create a lengthy, easy-to-remember phrase using common words. Store the phrase in a safe location.

The default master passphrase is 7layer.

The "Change the Master Passphrase" option does not apply if you have a Thales nShield HSM enabled on the CA API Gateway. To change the master passphrase in this instance, simply disable and then re-enable the nShield HSM.

5) Display Remote Management configuration menu

Use this option to configure the Gateway node to be managed remotely. This configuration is required only if the node will be managed by the CA API Gateway - Enterprise Service Manager. Reboot the Gateway (using option R below) to apply any configuration changes.

For details, see Configure the Gateway for Remote Access.

6) Manage HSM

This option is displayed only if an internal Hardware Security Module (HSM) is present.

Select this option to create or program into a security world using nCipher.

For details, see Configure Hardware Security Modules.

7) Display Enterprise Service Manager configuration menu

Use this option to configure the CA API Gateway- Enterprise Service Manager (if installed).

For details, see Configure the Enterprise Service Manager.

8) Display Patch Management menu

Use this option to manage patches on the Gateway appliance.

For details, see Understand Gateway Patches.

9) Display Log Viewing menu

Use this option to view the various logs available in the system.

For details, see View Logs for the Gateway.

R) Reboot the CA API Gateway appliance (apply the new configuration)

Use this option to exit the menu and reboot the appliance. Any configuration changes made will take effect when the Gateway appliance restarts.

X) Exit (no reboot) Use this option to exit the menu without rebooting. If you have made configuration changes, they take effect after a reboot.
Was this helpful?

Please log in to post comments.