iCDBCmdLine Tool

OS: Windows and Linux

iCDBCmdLine.exe is a command line tool that executes specific operations in the database, RSCM configurator, and server monitor modules. Operations include installing, uninstalling, starting and stopping an RSCM service, listing installed RSCM services, showing the status of a service, generating a server monitor report, and updating the database to the current version.

Usage

Windows:

<MentorGraphics-root>\SDD_HOME\common\<OS>\bin> iCDBCmdLine <module_name> <command>

Linux:

[<MentorGraphics-root>/SDD_HOME/common/<OS>/bin>]# ./iCDBCmdLine <module_name> <command>

Arguments

Modules — (Required) iCDBCmdLine requires one of the following modules:

  • database

  • rscm_configurator

  • server_monitor

Note:

If an iCDB tool is not installed, then its corresponding module will not be available in the iCDBCmdLine tool. For example, if iCDB Server Monitor is not installed, the server_monitor module will not be available in the iCDBCmdLine tool.

Commands — (Required) iCDBCmdLine requires one of the following commands listed for the given module:
Note:

You can use either the full command or its shortcut. For example, use the command is_update_needed, or substitute the shortcut n. See the Examples section.

  • database: See Table 1 for database commands.

    Table 1. Database Commands and Arguments for the iCDBCmdLine Tool

    Command

    Arguments

    Description

    s, get_list_snapshots

    <path_to_database_folder>

    Returns names of all snapshots in the database.

    n, is_update_needed

    <path_to_database_folder>

    Check if the database needs to be upgraded to the current version.

    u, update

    <path_to_database_folder>

    Update the database to the current version.

  • rscm_configurator: See Table 2 for RSCM configurator commands.

    Table 2. RSCM Configurator Commands and Arguments for the iCDBCmdLine Tool

    Command

    Arguments

    Description

    m, addsub

    <service_name>

    Add RSCM Service to the Coordinator.

    c, -change

    -sdd_home <sdd_home>, ‑port <port>, -wdir <wdir>

    Reconfigure the RSCM Service settings.

    g, config

    <service_name>

    Show the RSCM Service configuration details.

    dc, delcoordinator

    None

    Turn off Coordinator mode on the RSCM Service.

    ds, delsub

    <service_name>

    Remove RSCM Services from the Coordinator.

    gc, getcoordinator

    None

    Get an RSCM coordinator.

    k, getsubs

    None

    Get a list of RSCM Services managed by Coordinator.

    i, install

    -sdd_home <sdd_home>, ‑port <port>, -wdir <wdir>

    Install the RSCM Service.

    l, list

    None

    Show the list of installed RSCM Services.

    f, mrsoff

    None

    Turn off Multi Release Support.

    n, mrson

    <mrs_config_file_folder>

    Turn on Multi Release Support.

    sc, setcoordinator

    <service_name>

    Set the RSCM Service into Coordinator mode.

    t, start

    <service_name>

    Start the RSCM Service.

    s, status

    <service_name>

    Return the status of the RSCM Service.

    p, stop

    <service_name>

    Stop the RSCM Service.

    u, uninstall

    <service_name>

    Uninstall the RSCM Service.

  • server_monitor: See Table 3 for server monitor commands.

    Table 3. Server Monitor Commands and Arguments for the iCDBCmdLine Tool

    Command

    Arguments

    Description

    g, generate_report

    <path_to_report>

    Generate an iCDB Server Monitor report.

Description

To show the list of available modules, type the following: 

iCDBCmdLine help

To show the list of commands for a specific module, type the following: 

iCDBCmdLine help <module_name>

To get help for a specific command, type the following: 

iCDBCmdLine help <module_name> <command>

Examples

The following are examples of the install, start, list, status, report, stop, and uninstall commands:

C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator install ‑sdd_home "C:\MentorGraphics\EEVX.2.6\SDD_HOME" ‑port 9000 ‑wdir "C:\WDIR\EEVX.2.5\EEVX.2.6"
Installing service.
MGC.SDD.RSCM.EEVX.2.6; Service install requested.
MGC.SDD.RSCM.EEVX.2.6; Service installed successfully
RSCM [MGC.SDD.RSCM.EEVX.2.6] has been installed
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator start MGC.SDD.RSCM.EEVX.2.6
MGC.SDD.RSCM.EEVX.2.6;  start requested
MGC.SDD.RSCM.EEVX.2.6; Service has started successfully
RSCM [MGC.SDD.RSCM.EEVX.2.6] has been started.
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator list
MGC.SDD.RSCM.EEVX.2.6
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator status MGC.SDD.RSCM.EEVX.2.6
NAME: MGC.SDD.RSCM.EEVX.2.6
STATUS: Working
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine server_monitor gen_report "C:\users\tnelson\downloads\test.html"
The report has been generated: file[C:\users\tnelson\downloads\test.html]
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator stop MGC.SDD.RSCM.EEVX.2.6
Service stop requested
MGC.SDD.RSCM.EEVX.2.6; Service has stopped successfully
RSCM [MGC.SDD.RSCM.EEVX.2.6] has been stopped.
C:\MentorGraphics\EEVX.2.6\SDD_HOME\common\win64\bin>iCDBCmdLine rscm_configurator u MGC.SDD.RSCM.EEVX.2.6
Service remove requested
Service removed successfully
MGC.SDD.RSCM.EEVX.2.6; has been uninstalled.
RSCM [MGC.SDD.RSCM.EEVX.2.6] has been uninstalled.
Parent Topic: iCDB Command Line Tool Reference
1 <service_name> can be long (MGC.SDD.RSCM.EEVX.2.6) or short (EEVX.2.6)