Summary


The IBShell (Command Shell) utility provides a command-line interface to many of the available features of the InfoBurst Platform and supports a script mode whereby commands can be stored in an external file which allows tasks to be automated and repeated.


Access

  • Open a command prompt (Run as administrator) on the InfoBurst Platform server
  • Change directory to the application root folder (default = C:\Program Files (x86)\InfoSol\InfoBurstPlatform)
  • Enter IBSHELL
  • Enter Connect
    • Connect Server="<URL>" SSL=True for SSL-enabled servers
      • URL must match URL defined in SSL certificate
  • Enter Get Token
  • Enter InfoBurst user credentials

Command Shell Reference

Command Shell Reference Guide attached to this article (PDF)


Scripting


Shell commands can be scripted. Command shell scripts must have an .ibs extension.

Example Script

The following script lists platforms.
  • Create list_platforms.ibs in the application root folder (default = C:\Program Files (x86)\InfoSol\InfoBurstPlatform)
  • Enter the following shell commands and save the script file 
 
connect
get token user=admin password=admin
list platforms
exit

 

Execute Script Using Command Shell

  • Open a command prompt (Run as administrator) on the InfoBurst server 
  • Change directory to the application root folder (default = C:\Program Files (x86)\InfoSol\InfoBustPlatform) 
  • Execute list_platforms.ibs 

    • Syntax: IBSHELL <Script_Name>.ibs
Example:


 

C:\Program Files (x86)\InfoSol\InfoBurstPlatform>ibshell testscript.ibs
  InfoBurst Shell Utility, (c) InfoSol 2008-2013
* Start of Session at 10/15/2013 10:06:40 AM
> Connect
. Connecting to http://IBQA
* Connected OK, version is 2013.9.123 beta - Enterprise Edition
* Licensed to IBQA
> Get token user="admin" password="admin"
* OK
> List Platforms
  5 Platform(s) sorted by Name
  ID        Name                Type
  -----------------------------------------------------------------------
  16        DEVBI406_JC         Platform_BI40
  15        DEVBI406_WS         Platform_BI40
  18        DEVBI41_JC          Platform_BI41
  17        DEVBI41_WS          Platform_BI41
  40        Mig3to40            Platform_BI41
> exit
* OK
* Released token for ADMIN
* End of Session at 10/15/2013 10:06:41 AM, Elapsed=00h 00m 01s

 

Execute Script Using Batch File


Example batch file:

 

@echo off
"c:\Program Files (x86)\InfoSol\InfoBurstPlatform\IBSHELL" c:\scripts\list_platforms.ibs >>c:\scripts\logs\list_platforms.log