Access Gateway Command Line Management Console Reference

Access Gateway Command Line Management Console is a command line interface to the Access Gateway instance that allows you to modify configuration that are not available in the AdminAn abbreviation of administrator. This is the individual(s) who have access to the Okta Administrator Dashboard. They control the provisioning and deprovisioning of end users, the assigning of apps, the resetting of passwords, and the overall end user experience. Only administrators have the Administration button on the upper right side of the My Applications page. UI Console.

The purpose of this reference is to list the current Access Gateway Command line console commands available within the oag-mgmt user account. These commands can be used to configure and monitor Access Gateway Management.

The following menus are available on the Management Console:

First Login

The first time you log in to the Access Gateway Management Console, we highly recommend that you change the password for the oag-mgmt user. Note: When using SSH to access the Access Gateway Management Console some features may be disabled.

  1. Start the Access Gateway VM and open a terminal window. Default credentials are given below:

    1. Username: oag-mgmt

    2. Password: OkgaMgmt@123

    The first time you log in to the Access Gateway Management Console, we highly recommend that you change the password for the the oag-mgmt account. See the Change Password section for more information

     

Once logged in, the Access Gateway appliance will provide you with various menu options similar to those shown below.

Management Console Main Page

Select 6 Change password to change the command line console password.

Select 7 Change Access Gateway Password to change the Admin UI Password.

See Access Gateway password policies for more information and general password policy.

Jump_to_top_↑

Network

The Network menu contains options for checking the status of the network and modifying the network settings.

Network command Overview

  1. Setup static networking: Enter the sub-menu to configure static networking for the Access Gateway appliance.

  2. Setup dhcp networking: Enter the sub-menu to configure DHCP networking for the Access Gateway appliance.

  3. Test network configuration: Enter the sub-menu to attempt connection to several websites and also checks the NGINXNginx is a web server which can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache. configuration and status.

  4. Edit /etc/hosts: Allows you to edit the /etc/hosts file on the Access Gateway appliance.

  5. Setup NIC bonding: Enter the sub-menu to configure a NIC bonding configuration similar to a static network configuration.

  6. Change interface (eth0): Enter the sub-menu to select a different network interface.

  7. Proxy settings: Enter the sub-menu to set up a proxy connection for the Access Gateway appliance, or remove a proxy configuration from the appliance.

  8. Ping: Determines if a destination host is reachable from the Access Gateway appliance.

  9. Connectivity test: Validates a connection between the Access Gateway appliance and any other system. Use this tool to valide if a backend application or server is able to reach the Access Gateway.

  10. s — Show running configuration: Displays the current configuration of the Access Gateway appliance.

  11. v — View configuration change plan: Displays the configuration change plan.

  12. c — Commit changes to system: Commit any unsaved changes to the Access Gateway appliance.

  13. r — Restart Networking: Restart the networking services on the Access Gateway appliance.

  14. x — Exit: Exit to the Management Console.

Jump_to_top_↑

Service

The Services menu allows you to start, stop, and restart services on the Access Gateway appliance, as well as check the status of the running services and regenerate an SSL certificate. The available services you can view are NGINX, Access Gateway Admin, NTP and Session Cache.

Kerberos

The Kerberos menu allows you to list or destroy Kerberos tickets.

When listing a ticket, the software provides the Kerberos principal and Kerberos ticket held in the credential cache or keytab file.

Destroying a user’s active Kerberos authorization is achieved by overwriting and deleting the credential cache that contains them.

Press 3 to select the Kerberos sub-menu.

Kerberos command overview

  1. List: List credential caches.
  2. Destroy: Destroy all credential caches.
  3. Exit: exit the Kerberos sub-menu.

Jump_to_top_↑

Monitor

The Monitor menu allows you to view the Access Gateway logs.

Press 4 to enter the Monitoring sub-menu.

  1. Monitor Logs: Display the monitor log. Enter [ctrl][c] to exit Monitor Logs.
  2. Enable Debug: Enable debug for all services.
  3. Disable Debug: Disable debug for all services.
  4. Exit: exit the monitor sub-menu.

Jump_to_top_↑

System

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. .

System command overview

  1. Change Hostname: Change the hostame of the Access Gateway instance.
  2. Install Package: Install a named packaged.
  3. Remove Package: Remove a named package.
  4. Update: Update the system.
  5. Reboot: Reboot the system.
  6. Shutdown: Shutdown the system.
  7. Reset: Reset the system to original default settings.

Jump_to_top_↑

Change Password

The Change Password menu allows you to change the password for the oag-mgmt user. You will be asked to confirm the current password and enter/confirm the new password to successfully change the password.

See Access Gateway password policies for more information on acceptable passwords.

  1. Press 6 on the main menu to change the password.

  2. Enter the current password for the oag-mgmt user.

  3. Enter a new password.

  4. Confirm the new password.

  5. The system displays a Password reset successful message if the password is accepted; alternatively, an error is displayed if the password fails to meet the minimum requirements.

  6. Press Enter to return to the main menu.

Jump_to_top_↑

Change Web Console Password

The Change Web Console Passord menu allows you to change the password for the administrator on the Access Gateway Admin UI. You will be asked to confirm the current password and enter/confirm the new password to successfully change the password.

See Access Gateway password policies for more information on acceptable passwords.

  1. Press 7 on the main menu to change the password.

  2. Enter the current password for the admin user for the Admin UI Console.

  3. Enter a new password.

  4. Confirm the new password.

  5. The system displays a Password reset successful message if the password is accepted; alternatively, an error is displayed if the password fails to meet the minimum requirements.

  6. Press Enter to return to the main menu.

Jump_to_top_↑

Content Update

The Content Update menu allows you to create and manage GIT repositories on your Access Gateway application. Note that only one repository is supported at a time.

Content update command overview

  1. Setup Repository:Setup a GIT repository
  2. Create Branch: Create branch.
  3. Review Changes: Review all changes.
  4. Update Content: Push the content update to the repository.
  5. Rollback Latest Change: Rollback the latest change.

Jump_to_top_↑

Support Connection

The Support Connection menu option allows you to enable and disable support connections.

Support Connection command overview

  1. Enable Support Connection: Enable support connection functionality
  2. Disable Support Connection:Disable support connection functionality.

Jump_to_top_↑

Exit

The Exit menu option exits the Access Gateway Management Console to the main operating system login.

Jump_to_top_↑

Top