IBM Support

Accessing the IBM MessageSight Command Line Interface

Question & Answer


Question

How do I access the command line interface of an IBM MessageSight appliance?

Cause

The IBM MessageSight appliance provides an extensive command line interface which includes a number of utilities and diagnostic tools not available through the web UI. You can access the IBM MessageSight command line locally using a KVM console, or over the network.

Answer



Accessing the Command Line using a KVM Console

If you are physically in the room with the IBM MessageSight appliance, you can access its command line if you know an administrator name and password.



Turn on the KVM (Keyboard, Video, Mouse) console which was used to install the IBM MessageSight appliance. If you are using a KVM switch, select the appliance in order to display its login prompt, then log in with the administrator name and password as shown in this video:



    IBM MessageSight KVM Console



You can use the console to display the machine type and serial number. Compare these values against those on the front panel of the IBM MessageSight appliance to make sure you are accessing the right system:

    Displaying the MessageSight machine type and serial number


    Console> show version
    Installation date: Jul 2, 2014 12:33:11 PM
    Platform version: 5.0.0.24
    Platform build ID: build24-20140609-2024
    Machine type/model: 7915AC1
    Serial number: KLM0199
    Entitlement: KLM0199
    Firmware type: Release



If your IBM MessageSight appliance was given a node name, you can display it to confirm you are accessing the right system, for example:

    Displaying the MessageSight node name


    Console> nodename get
    nodename is Doncaster



Accessing the Command Line from the network


In order to access the IBM MessageSight command line over the network, you should record some information while using the KVM console. First, find the IP address of the management interface(s), which you will use to access the IBM MessageSight command line over the network. For example:

    Displaying the MessageSight management IP addresses


    Console> status ethernet-interface mgt0
    mgt0	OpState:[Up]
    generic MTU:1500 carrier:true
    flags:UP BROADCAST RUNNING MULTICAST index:9
    inet addr:192.0.2.2 flags:PERMANENT mask:255.255.255.0
    scope:GLOBAL
    inet6 addr: 2001:db8::42ee:a1df:c1a:a2 flags:PERMANENT
    mask: ffff:ffff:ffff:ffff:: scope:LINK
                    ...

    Console> status ethernet-interface mgt1
    mgt1	offline
    OpState:[Down]
    generic MTU:1500 carrier:false flags: BROADCAST MULTICAST
    index:10
                    ...



Before connecting to IBM MessageSight using these addresses, record the SSH key fingerprint of the appliance so you can verify it later, for example:

    Displaying the MessageSight SSH key fingerprint


    Console> sshkey fingerprint
    SSH RSA Key fingerprint 8e:e9:5d:ca:51:ea:82:c5:72:bc:e2:c2:35:04:ae:2b
    SSH DSA Key fingerprint c2:af:e1:6a:33:15:8d:73:82:5e:73:25:ca:42:4e:24




Use SSH (Secure Shell) on your laptop or on another server to connect to the MessageSight appliance. On Windows there are aa number of SSH client like PuTTY to choose from, while on Linux, OS X and UNIX you can run the ssh command to connect to the MessageSight appliance. Connect using the format Admin_User@IP_Address or Admin_User@Host_Name and be prepared to validate the SSH key the first time you connect. For example:

    Connecting to MessageSight using SSH


    sh> ssh admin@192.0.2.2
    The authenticity of host '192.0.2.2' can't be established.
    RSA Key fingerprint is 8e:e9:5d:ca:51:ea:82:c5:72:bc:e2:c2:35:04:ae:2b.
    Are you sure you want to continue connecting (yes/no)? yes
    Warning: Permanently added '192.0.2.2' (RSA) to the list of known hosts.
    Password:
    Last login: Thu Jul 17 12:53:45 EST 2014 from 192.0.2.4 on pts/1
    Welcome to IBM MessageSight
    5725-F96
    Copyright 2012, 2014 IBM Corp. Licensed Materials - Property of IBM.
    IBM and MessageSight are trademarks or registered trademarks of IBM, registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies.
    Console>



If your IBM MessageSight appliance was given a node name, you can display it to confirm you are accessing the right system, for example:

    Displaying the MessageSight node name


    Console> nodename get
    nodename is Doncaster



Using the Command Line interface


Once you have successfully logged in to the command line interface, you can run any of the commands shown in the Command Reference section of the IBM MessageSight documentation. Use the exit command when you are done. For example:

    Running MessageSight commands


    ssh> status imaserver
    Status = Running (production)
    ServerUpTime = 12 days 10 hours 0 minutes 34 seconds
    Console> imaserver stop
    The IBM MessageSight server is stopping.
    Check the IBM MessageSight server status using "status imaserver" command.
    Console> status imaserver
    Status = Stopped
    Console> imaserver start
    The IBM MessageSight server is starting.
    The IBM MessageSight server is in "production" mode.
    Console> exit

[{"Product":{"code":"SSCGGQ","label":"IBM MessageSight"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Command Line","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"1.0;1.1;1.2","Edition":"All Editions","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
17 June 2018

UID

swg21636982