Command-line interface

Access the command-line interface (CLI) of the appliance by using either an ssh session or the console.

The following example shows the transcript of using an ssh session to access the appliance:

usernameA@example.ibm.com>ssh -l admin webapp.vwasp.gc.au.ibm.com
admin@webapp.vmasp.gc.au.ibm.com's password:
Welcome to the IBM Security Access Manager Appliance
Enter "help" for a list of available commands
webapp.vwasp.gc.au.ibm.com>isam
webapp.vwasp.gc.au.ibm.com:isam> help
Current mode commands:
admin           Start an administration session which can be used to administer
                the ISAM security policy.
dscadmin        Start an administration session which can be used to administer
                the Distributed Session Cache.
logs            Work with the ISAM log files.
mga             Work with the Mobile Gateway settings.
Global commands:
back            Return to the previous command mode.
exit            Log off from the appliance.
help            Display information for using the specified command.
reboot          Reboot the appliance.
shutdown        End system operation and turn off the power.
top             Return to the top level.

Tip: Use the help command to display usage notes about a specific command.

The following example shows the options available under the logs menu.

webapp.vwasp.gc.au.ibm.com:logs> help
Current mode commands:
archive         Archive the log files to a USB device.
delete          Delete the log files which have been rolled over by the system.
delete_trace    Delete the trace files (trace, stats, translog) from the system.
monitor         Monitor log files on the system.

The following example shows the options available under the mga menu.

webapp.vwasp.gc.au.ibm.com:mga> help
Current mode commands:
config          Start a session which can be used to configure a Web Reverse
                Proxy instance so that it can act as a point of contact for
                ISAM for Mobile.
unconfig        Start a session which can be used to unconfigure a Web Reverse
                Proxy instance so that it can no longer act as a point of
                contact for ISAM for Mobile.

The following example shows the options available under the tools menu:

webapp.vwasp.gc.au.ibm.com:tools> help
Current mode commands:
connect         Test network connection to a certain port on a specified host.
connections     Display the network connections for the appliance.
nslookup        Query internet domain name servers.
ping            Send an ICMP ECHO_REQUEST to network hosts.
traceroute      Trace a packet from a computer to a remote destination, showing
                how many hops the packet required to reach the destination and
                how long each hop took.

The method to access the console differs between the hardware appliance and the virtual appliance:

For the hardware appliance, a serial console device must be used. For more information about attaching a serial console device to the hardware, see Connecting a serial console to the appliance.
For the virtual appliance, you can access the console by using the appropriate VMWare software.
For example, VMWare vSphere Client.

Note: The CLI contains only a subset of the functionality available from the local management interface. The following list gives a high-level overview of the functions available from the command-line interface:

Work with firmware images.
Work with fix packs.
Work with hardware settings.
Work with licenses.
Work with the local management interface.
Work with management settings.
Work with policy snapshot files.
Work with support information files.
Work with network diagnostic tools.
Work with firmware and security updates.