Cisco ACE XML Gateway Administration Guide (Software Version 5.2)
Shell Menu Reference

Table Of Contents

Shell Menu Reference

Main Menu

Manage ACE XML Gateway Processes Menu

Network Configuration Menu

ACE XML Gateway Cluster Configuration Menu

Shutdown/Reboot Menu

Advanced Options Menu


Shell Menu Reference


The chapter provides an overview of the menus in the Shell interface. It covers these topics:

Main Menu

Manage ACE XML Gateway Processes Menu

Network Configuration Menu

ACE XML Gateway Cluster Configuration Menu

Shutdown/Reboot Menu

Advanced Options Menu

Main Menu

The main page of the console menu includes these items:

Manage ACE XML Gateway Processes displays the current operational status of the appliance, whether running or stopped. It also allows you to stop or start those processes.

Network Configuration contains the network settings for this ACE XML appliance.

ACE XML Gateway Cluster Configuration contains settings that control the operation mode of the appliance, whether it should act as a Manager, Gateway, or a standalone appliance.

Shutdown/Reboot shuts down or reboots this appliance. This option is the recommended method for shutting down and rebooting the system. Note that the shutdown -h shell command does not remove power to the system.

Advanced Options contains administrative settings for the ACE XML appliance, including SSL engine settings, Netegrity server settings, the root password, SNMP settings, and more. It also lets you access the bash shell on the appliance.

Logout logs out of the Shell Interface.


Note For information on logging into the Shell interface, see "About the Shell Interface" section on page 4-13.


Manage ACE XML Gateway Processes Menu

Use the Manage ACE XML Gateway Processes menu to display and change the operating status of the ACE XML Gateway and Manager. The menu has these items:

Display Current Status lists the operational status for the ACE XML Gateway and Manager. Each process is shown with a status of "running" or "stopped".

Restart All Configured Services restarts all currently enabled processes immediately.

Stop ACE XML Gateway halts the primary traffic listening process on the gateway. If you choose this option, the option changes to Start Gateway.


Note This item does not appear if the ACE XML appliance has never been configured, if the appliance is configured as a dedicated Manager, or if the appliance is configured as an inactive appliance; that is, the appliance must already be configured as a Gateway in order for this menu item to appear.


Stop ACE XML Manager halts the Manager process. If chosen, the option changes to Start ACE XML Manager.


Note This item does not appear if the ACE XML appliance has never been configured, if the appliance is configured as a dedicated Gateway, or if the appliance is configured as an inactive appliance. The appliance must be configured as a Manager in order for this menu item to appear.


Return to Main Menu displays the Main Menu.

Network Configuration Menu

This menu contains the network settings for the ACE XML appliance, such as its host name, IP address, name servers it may use, and the configuration of its Ethernet interfaces.

The Network Configuration menu has these items:

Hostname is the fully-qualified domain name of this ACE XML appliance.

IP Gateway identifies the IP address of the default TCP/IP gateway in the appliance's subnet.

Name Servers specifies by IP address domain name servers (DNS) that resolve IP addresses for this ACE XML appliance.

Interface eth0 sets parameters for the network interface, including its IP address, netmask, speed (10baseT, 100baseT, Gigabit, or auto), duplex (half, full, or auto), and static routes.

Your appliance may have anywhere from one to four network interfaces. Menu options for configuring the other interfaces have similar labels. For example, the second interface would be labeled Interface eth1, the third would be Interface eth2, and so on.

View Routing Table displays the IP routing table, as if you executed the shell's route command, passing no arguments.

Test Network Settings tests the validity of this appliance's current network settings, such as whether Ethernet interfaces are enabled, whether the current IP settings are well-formed and whether DNS servers and other ACE XML appliances can be pinged successfully.

Return to Main Menu exits the Network Configuration page and returns to the Main Menu.

ACE XML Gateway Cluster Configuration Menu

Use this option to configure the operating mode of the appliance, either as a Manager, Gateway, both (standalone), or inactive.

This menu has these items:

ACE XML Gateway Cluster Member sets the operating mode for this appliance as a Gateway, either operating as a single Gateway or within a cluster. If you choose this option, there must be at least one other ACE XML appliance in your system, the ACE XML Manager. To configure this mode, you need to set the IP address of the ACE XML Manager that is to control this Gateway appliance.

ACE XML Manager sets the operating mode for this appliance as an ACE XML Manager. A Manager appliance inspects, configures, and controls all Gateway appliances configured as members of its cluster.

Both Gateway and Manager configures the appliance to act as both Manager and Gateway. This configuration is known as a standalone mode.

Inactive Machine disables all non-console activity.

Shutdown/Reboot Menu

This menu item enables you to turn off the appliance safely, reboot it, or return to the Main Menu.

To reboot the appliance, choose the Reboot item.

To shut down the appliance, choose the Shutdown item.

Advanced Options Menu

The Advanced Options menu provides version information and other configuration options, such as hardware acceleration for SSL, configuration of SNMP monitoring, and Netegrity registration options. This menu has these items:

Time Settings enables or disables the use of one or more Network Time Protocol servers.

SSL Engine Configuration enables or disables a hardware-based SSL accelerator.

Boot Settings configures the logging destination of boot messages. The appliance can be configured to send boot messages to an attached video monitor (the default) or to the serial port.

Netegrity Configuration configures the appliance to work with a specified Netegrity SiteMinder or TrafficMinder server.

For more information, see the tech note titled Using Netegrity Authentication Sources.

Change root Password changes the root password for this ACE XML appliance. Specifying a secure root password for each of your ACE XML appliances is essential to protecting the security of your network.

SNMP Configuration configures SNMP settings for this ACE XML appliance.

For more information, see Chapter 12, "Monitoring the ACE XML Gateway Remotely."

Version Information provides version numbers of the currently-installed Gateway software, operating system kernel, and other components of the system.

MTA Configuration configures the message transfer agent (MTA) that supports ebXML messages.

Traffic Management enables use of optional Actional Looking Glass management adapters for monitoring the gateway.

Run Bash suspends the appliance shell temporarily and runs the bash shell.

Return to Main Menu exits the Advanced Options page and returns to the Main Menu.