System menu

The System menu allows you to change the hostname, install or remove a package, perform an update, reboot, shutdown, or reset the Access Gateway instance.

Select 5 to open the System submenu.

System commands

  1. Change Hostname: Change the hostame of the Access Gateway instance.
  2. Configure High Availability: Configure and manage Access Gateway high availability.
  3. Install Package: Install a named packaged.
  4. Remove Package: Remove a named package.
  5. Update: Update the system.
  6. Reboot: Reboot the system.
  7. Shutdown: Shut down the system.
  8. Reset: Reset the system to original default settings.

Change Hostname

  1. Press 1 to change the hostname.
    The current hostname is displayed.
  2. Enter the new hostname, and press Enter.
  3. Press y to confirm.
  4. Press Enter to return to the System menu.

Configure High Availability

The High Availability menu displays the current role of a Access Gateway node. Roles can be:

  • Not Set: The node hasn't been configured as a Worker or an Admin.
  • Admin: The node has been configured as an Admin for High Availability.
  • Worker: The node has been configured as a Worker for High Availability.

  1. Press 1 to reset node keys.
  2. Press 2 to Prepare an administration node to connect to a new Worker node.
  3. Press 3 to Prepare a node to become a worker node.
  4. Press 4 to List all known Worker nodes. Only applicable on the Admin node.
  5. Press 5 to remove a known Worker node. Only applicable on the Admin node.
  6. Press 6 to check High Availability status.
  7. Press 7 to perform a rolling upgrade using Cluster manager.

For complete details of configuring high availability, see Configure and manage high availability.

For a reference on performing rolling upgrades see Perform admin renomination.

Cluster manager

The cluster management menu appears:

Copy 
Access Gateway Cluster Manager (Worker)
1 - Authorize Node Nomination
2 - Authorize Node as Admin node

X- Exit
Choice:

Selecting 1-Authorize Node Nomination on a worker node results in an error: Operation not supported on worker node, press any key to continue.

Attempting to run the Authorize Node Nomination process while another authorization process is in progress results in an error: Admin Nomination in progress for node - <nominatedNode Hostname>.

  1. Authorize node nomination.
    1. Select 1 - Authorize Node Nomination.

      Selecting 2-Authorize Node as Admin node on an admin node results in an error: Operation not supported on admin node, press any key to continue.

      Attempting to run the Authorize Node as Admin node process when another authorization is in progress results in this error: Admin Nomination in progress.

    2. The current admin node displays this message:

      Copy
      NOTE: Please ensure that the admin node is ready for setup and you have the authorization 
      token displayed on the on the worker node. 

      Enter the authorization token displayed on the nominated admin node:

      Press the Enter key when complete.

      The renomination process begins.

  2. Authorize node as Admin node.

    1. Select 2 - Authorize Node as Admin node.

    2. The worker node then presents a confirmation dialog box. Enter Y to continue or N to abort.

      If the Cluster manager package isn't installed or supported on the admin node, an error message appears:

      Copy
      Cluster Manager package was not found on Admin Node - OAG Version - 2020.7.0

      Upgrade the admin node before continuing.

    3. The worker node generates and displays an authorization code, which you must provide to the admin node.

      Copy the following authorization code:

      Copy

      The authorization token required to initiate setup for nominated admin node: worker-c:8ba1c123-715d-4b70-ab5d-0e41493bef73
      Copy the token and paste it on the admin node when prompted.
      Press enter to continue

Install Package

  1. Press 2 to install a new package.
  2. Enter a package name, and press Enter.
  3. Press y to confirm.
  4. Press Enter to return to the System menu.

Remove Package

  1. Press 3 to remove an existing package.
  2. Enter a package name, and press Enter.
  3. Press y to confirm.
  4. Press Enter to return to the System menu.

Update

See Upgrade Access Gateway for a detailed discussion on upgrading Access Gateway.

Available in Access Gateway 2021.8.0 and earlier.

  1. Press 4 to begin the update process.
  2. Confirm you're ready to update and press y to proceed or n to cancel.
  3. Press y to confirm package downloads. Updates start downloading and the update begins.
  4. Press Enter to return to the System menu.

Access Gateway selective upgrade supports both updating from a version of Access Gateway to a later version, and upgrade to the latest version.

See Selective upgrade workflow for a detailed discussion on upgrading Access Gateway.

Available since Access Gateway version 2021.9.3

Upgrade to the latest Access Gateway version

On the node to upgrade:

  1. Connect to the target instance Access Gateway Management console.

    >ssh oag-mgmt@[node.tld]

  2. Select 5 - System.
  3. Select 4- Upgrade.
    The upgrade menu will display and resemble:
    Upgrade Access Gateway
    1 - Upgrade to the latest Access Gateway version. . . 2 - View list of Access Gateway versions to upgrade. . . x - Exit
  4. Enter 1 - Upgrade to the latest Access Gateway version. . .
  5. The upgrade confirmation dialog will display and resemble:
    Enter 1 to confirm and begin upgrade.
    Enter X to exit, and cancel upgrade.Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg NOTE: Confirming the operation will start the upgrade process. The system configuration will be automatically backed up before theupdate. It is strongly recommended that to take a system snapshot before proceeding. 1 - Confirm X - Exit Choice:
  6. Enter 1 to continue.

    Entering X aborts the upgrade and returns to the prior menu.

  7. The upgrade begins and shows results resembling the following: Update in progress... okta-datastores-202X.Y.Z-abcdefg.x86 64 . . . Installed: okta-monitoring-rest-202X.Y.Z-abcdefg.x86_64 Complete! Dependencies resolved. . . . Complete! Upgrade to Okta Access Gateway 202X.Y.Z-abcdefg successful. Press any key to continue to results review.
  8. The view yum page will display:
    Enter y to view the yum upgrade log.
    Enter x - to exit and return to the main upgrade menu.

Upgrade to the selected Access Gateway version

On the node to upgrade:

  1. Connect to the target instance Access Gateway Management console.

    >ssh oag-mgmt@[node.tld]

  2. Select 5 - System.
  3. Select 4- Upgrade.
    The upgrade menu will display and resemble:
    Upgrade Access Gateway
    1 - Upgrade to the latest Access Gateway version. . . 2 - View list of Access Gateway versions to upgrade. . . x - Exit
  4. Select 2 - View list of Access Gateway versions .... This displays the list of available versions, similar to the following:

    Available versions Okta Access Gateway 2021.A.x-abcdefg Okta Access Gateway 2021.B.x-abcdefg Okta Access Gateway 2021.C.x-abcdefg Okta Access Gateway 2021.D.x-abcdefg Okta Access Gateway 2021.E.x-abcdefg Up/Down - scroll list Return - select x - exit

  5. Use the arrows to select a target and hit return to begin the upgrade process.

Reboot

  1. Press 5 to reboot.

  2. Enter y to proceed or n to cancel.

  3. The system reboots.

Shutdown

  1. Press 6 to shut down.

  2. Enter y to proceed or n to cancel.

  3. The system shuts down.

Reset

  1. Press 7 to reset.

  2. Enter y to proceed or n to cancel.

  3. The system returns all settings to their default values.

The gateway appliance shuts down after being reset and must be restarted.