Virtual appliance command line interface

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

1. From the command-line interface, log on the virtual appliance. The following message is displayed:

   Welcome to ISIM appliance
   Enter "help" for a list of available commands

2. To see a list of available commands, enter help at the command-line prompt. The help command provides detailed information about each command from the list.

The following example shows an ssh session used to access the virtual appliance.

usernameA@example.com> ssh -l admin isimva.example.com 
admin@isimva.example.com's password: 
Welcome to ISIM appliance 
Enter "help" for a list of available commands 
isimva.example.com> help
Current mode commands: 
fips                View FIPS 140-2 state and events. 
firmware            Work with firmware images. 
fixpacks            Work with fix packs. 
isim                Work with ISIM settings. 
license             Work with licenses. 
lmi                 Work with the local management interface. 
management          Work with management settings. 
snapshots           Work with policy snapshot files. 
support             Work with support information files. 
tools               Work with network diagnostic tools. 
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.
isimva.example.com:isim> 

We can also access the console using the appropriate VMware software. For example, VMware vSphere Client. The CLI contains only a subset of the function available from the graphical user interface.

Global commands

The following list describes a high-level overview of the global functions available in the command line interface.

back

Returns to the previous command mode.

exit

Logs off from the appliance.

help

Displays information for using the specified command.

reboot

Restarts the appliance.

shutdown

Ends system operations and turns off the power.

top

Returns to the top level.

Current mode commands

fips

View FIPS 140-2 state and events. FIPS commands are available only if FIPS mode is enabled.

firmware

Work with firmware images.

fixpacks

Work with fix packs.

isim

Work with ISIM settings. See IBM Security Identity Manager (ISIM) commands.

license

Work with licenses.

lmi

Work with the local management interface.

management

Work with management settings.

snapshots

Work with policy snapshot files.

support

Work with support information files.

tools

Work with network diagnostic tools.

• fips commands
  The fips command provides the option to view FIPS 140-2 state and events.
• firmware commands
  Use the firmware commands to work with firmware images.
• fixpacks commands
  The fixpacks command provides options to work with the fix packs. The corresponding task can be completed using the graphical user interface. Go to Manage > Updates and Licensing > Fix Packs.
• license commands
  The license command provides options to work with the licenses.
• lmi commands
  The lmi command provides options to work with the local management interface.
• management command
  The management command provides options to work with management settings.
• snapshots command
  The snapshots command provides options to work with the snapshots. We can also complete the corresponding task using the graphical user interface. Go to Manage > System Settings > Snapshots.
• support command
  The function generates the support files. The corresponding task can be completed using the graphical user interface. Go to Manage > System Settings > Support Files.
• tools command
  The tools command provides options to work with network diagnostic tools.