Using the Management Console commands

Access Gateway Management Console is a command line interface to the Access Gateway instance that allows you to modify several configuration options 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 steps provided in this section walk you through each Management Console command available.

The following menus are available on the Management Console:

  • Network

  • Services

  • Kerberos

  • Monitor

  • System

  • Change Password

  • Change Web Console Password

  • Exit

Network

The Network menu contains options for checking the status of the network and modifying the network settings. For more information on the Network menu, see Access Gateway Management Console Overview.

Set up static networking

  1. Press 1 to select the Setup static networking option.

  2. Enter the IP address, and press Enter.

  3. Enter the netmask value, and press Enter.

  4. Enter the default gateway value, and press Enter.

  5. Enter the primary DNS server value, and press Enter.

  6. Enter the secondary DNS server value, and press Enter.

  7. Enter the search domainA domain is an attribute of an Okta organization. Okta uses a fully-qualified domain name, meaning it always includes the top-level domain (.com, .eu, etc.), but does not include the protocol (https). address, and press Enter.

  8. Press c to commit the changes.

  9. Review the network configuration, and press y and Enter to confirm the changes. Alternatively, press n and Enter to discard your changes and return to the Networking menu.

  10. After the change is complete, press any key to return to the Networking menu.

Set up DHCP networking

  1. Press 2 to enter the DHCP networking setup and enable DHCP.

  2. In this option, changes are written immediately and you do not need to commit the change later. The system prompts you to confirm each change.

  3. Press y and Enter to confirm, or press n and Enter to return to the main Networking menu.

  4. After the network interface is restarted, press Enter to continue.

Test network configuration

  1. Press 3 to begin the network configuration test.

  2. Next, the system attempts a connection to www.okta.com and displays the status. Press Enter to continue.

  3. Finally, the system checks the NGINX configuration and displays the status. Press Enter to return to the Networking menu.

Edit the /etc/hosts file

  1. Press 4 to edit the /etc/hosts file. This shows you the current entries in the hosts file by line number.

  2. Press a to add a new entry.

  3. Add the entry following the standard format of .

  4. To delete an entry, press d and enter the line number that corresponds to the entry you want to delete.

  5. Press c to commit the changes to the hosts file.

  6. Press x to return to the main Networking menu.

Set up NIC bonding

  1. Press 5 to set up NIC bonding.

  2. Enter the IP address, and press Enter.

  3. Enter the netmask value, and press Enter.

  4. Enter the default gateway value, and press Enter.

  5. Enter the primary DNS server value, and press Enter.

  6. Enter the secondary DNS server value, and press Enter.

  7. Enter the search domain address, and press Enter.

  8. Press c to commit the changes.

  9. Review the network configuration, and press y and Enter to confirm the changes. Alternatively, press n and Enter to discard your changes and return to the Networking menu.

  10. After the change is complete, press any key to return to the Networking menu.

Change interface

  1. Press 6 to change the network interface.

  2. Enter the network interface that you would like to use (such as, eth0, eth1, eth, etc.).

  3. Press Enter to return to the main Networking menu, and confirm that the interface has changed in the 6 — Change interface [interface name] menu option. The new interface should be listed in the menu option.

Proxy Settings

Configure a proxy

  1. Press 7 to set up or disable a proxy connection to the internet.

  2. Press 1 to configure the proxy.

  3. Enter the proxy hostname, and press Enter.

  4. Enter the proxy port, and press Enter.

  5. Enter the hostnames (separated by commas) that need to bypass the proxy.

  6. Press y to confirm the proxy settings.

  7. Press Enter to return to the proxy menu, and press Enter again to return to the main Networking menu.

Unset a proxy

  1. Press 7 to enter the proxy menu.

  2. Press 2 to remove the proxy configuration.

  3. Enter y to confirm.

  4. Press Enter to return to the proxy menu, and press Enter again to return to the main Networking menu.

Ping

The Ping option can be utilized to check if a destination host is reachable from the Access Gateway appliance.

  1. Press 8 to enter the ping menu.

  2. Enter the hostname or IP address for the destination host you want to ping, and press Enter.

  3. The system displays the ping results.

  4. Press Enter to return to the main Networking menu.

Connectivity Test

The Connectivity Test option can be utilized to validate a connection between the Access Gateway and any other system. This tool can also be used to validate if a backend application or server is reachable from the Access Gateway appliance.

  1. Select 9 from the Network menu.

  2. Enter the hostname or IP address of the machine you want to test, and press Enter.

  3. Enter the port number that needs to be tested, and press Enter.

  4. The system displays the connection results.

  5. Press Enter to return to the Networking menu.

Services

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, and NTP.
For more information on the Services menu, see Access Gateway Management Console Overview.

The NGINX, Access Gateway Admin, and NTP menus all contain the following commands:

  • Start : This option starts the selected service.

  • Stop : This option stops the selected service.

  • Restart : This option restarts the selected service.

  • Check status: This option displays the current status of the selected service, such as whether the service is running or stopped.

Regenerate SSL Certificate

  1. Press 1 to enter the NGINX menu.

  2. Press 5 in the NGINX menu.

  3. A self-signed certificate already exists on the appliance, so the system will prompt you to confirm the overwrite operation for the existing certificate. Press y to continue.

  4. Enter the domain name originally used to set up the Access Gateway appliance, and press Enter.

  5. Press y to confirm.

  6. Press Enter to return to the NGINX menu.

Kerberos

The Kerberos menu allows you to list or destroy Kerberos tickets. For more information on the Kerberos menu, see Access Gateway Management Console Overview.

  1. Press 3 on the Networking menu.

  2. The Kerberos menu contains 3 options:

  3. Press 1 to list the Kerberos principal and Kerberos ticket held in a credential cache or keytab file.

  4. Press 2 to destroy a user’s active Kerberos authorization tickets by overwriting and deleting the credential cache that contains them.

  5. Press x to return to the Networking menu.

Monitor

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

  1. Press 4 to enter the Monitoring menu.

  2. Press 1 to view the logs.

  3. After reviewing the logs, press Ctrl+C to return to the Monitoring menu.

  4. Press Enter.

System

The System menu allows you to change the hostname of the Access Gateway instance and reboot or shut down the Access Gateway instance.

Change Hostname

  1. Press 5 to enter the System menu.

  2. Press 1 in the System menu to change the hostname.

  3. Enter the new hostname, and press Enter.

  4. Press y to confirm.

  5. Press Enter to return to the System menu.

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.

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.

Exit

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

Top