Skip Headers

Oracle® Web Conferencing Administrator's Guide
Release 2 (2.0.4.3)

Part Number B10877-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

10 imtctl Command Line Utility

The imtctl utility provides a command-line interface for administering and configuring the Real-Time Collaboration system. The utility supports a variety of commands to let you start and stop Real-Time Collaboration processes, view their current state, and configure your Web Conferencing system.

10.1 Running imtctl

The imtctl utility is available on all platforms under $ORACLE_HOME/imeeting/bin. There are two ways to run imtctl commands interactively. You can also create scripts to run imtctl commands.

The following sections describe how to use imtctl in interactive mode, and how to run imtctl scripts.

10.1.1 Using imtctl in Command-line Mode

To start imtctl in command-line mode, enter imtctl in an operating system shell or command window, without any options:

$ORACLE_HOME/imeeting/bin> imtctl
imtctl>

You can then enter as many imtctl commands as you wish:

imtctl> setProperty -siteId 1024536 -pname "MeetingStartUrl" -pvalue "www.oracle.com"
imtctl> setProperty -siteId 1024536 -pname "MeetingEndUrl" -pvalue "www.oracle.com"
imtctl>

To display a list of supported commands, enter help:

imtctl> help

To get specific instructions for a particular command, enter the command followed by the -help option:

imtctl> getState -help

You stop command-line mode by entering exit:

imtctl> exit

10.1.2 imtctl Scripts

You can write simple scripts for the imtctl utility, consisting of imtctl commands and optional comments.

Oracle Web Conferencing is shipped with a set of standard scripts you can use to perform typical post-installation configuration tasks. These scripts reside in the $ORACLE_HOME/imeeting/bin/scripts directory and end with the extension .imt. Each script has sample lines to indicate the values that must be set before running the script. Run the scripts using standard input redirection as in the following example:

$ORACLE_HOME/imeeting/bin> imtctl < scripts/sample.imt

You can create new scripts as needed. The scripts can contain any supported imtctl commands, plus comment lines (any line that begins with #) and the special echo [on/off] command for echoing commands executed by scripts.

10.2 Setting System, Instance, Component, and Site Values

As discussed in Chapter 5, you can use imtctl to configure an entire system or particular instances or components. "List of imtctl Commands" describes the syntax for all of the imtctl commands, including the options that are available. The following table shows the possible values for any the scope-related options; you may use these values with any command that includes one of these options.

Table 10-1 Valid Values for System, Instance, or Component Options

imtctl Option Scope it Affects Valid Value(s)
-system Entire system true
-i An instance The full instance name: instance_name.machinename.domainname, where instance_name is a name you assign as you install the instance.

Use imtctl listInstances to display the IDs for all instances for this system, or click the System tab to display all instances.

Example: myinst.machine.us.oracle.com

-cid A single component, by its ID A number assigned by the Real-Time Collaboration system to this component when you install it.

Use imtctl listComponents to display the IDs for all components in the current instance, or click the System tab to display all components and their IDs for your system.

-cname Any component of a specific name Any of the following names:

imt-collab: Web Conferencing server

imt-docconv: Document Conversion server

imt-mx: Multiplexer (mx)

imt-pm: Web Conferencing Process Monitor

imt-voiceconv: Voice Conversion server

-ct Any component of a specific type Any of the following types:

clbsvr: Web Conferencing server

docconv: Document Conversion server

imtpm: Web ConferencingProcess Monitor

mxcomm: Multiplexer (mx)

voiceconv: Voice Conversion server

-siteID A single site, by its ID A number assigned by the Real-Time Collaboration system to this site when you create it.

Click the Sites tab to display all sites and their IDs for your system.


10.3 List of imtctl Commands

Following is a brief summary of all imtctl commands, listed alphabetically.

Table 10-2 imtctl Commands

Command Use to See
addSysDialin Add a dial-in number for voice conferencing "Setting Conference Dial-In Information"
deleteSysDialin Delete a voice conferencing dial-in number "Setting Conference Dial-In Information"
exit or quit Exit imtctl command-line mode "Getting Help and Quitting imtctl"
getMonitorStats Get monitoring statistics "Testing and Monitoring the System"
getPids Get identifiers for current Web Conferencing processes "Testing and Monitoring the System"
getProperties Get the current value of properties at a specified scope "Setting and Displaying Properties"
getProperty Get the current value of any property "Setting and Displaying Properties"
getState Determine the current status of Web Conferencing components "Testing and Monitoring the System"
getSysDialins Display all dial-in numbers currently set "Setting Conference Dial-In Information"
help Display a list of available commands "Setting Conference Dial-In Information"
listComponents Display current properties for Web Conferencing components "Listing System Information"
listInstances Display current properties for Web Conferencing instances "Listing System Information"
modifyRole Set or change roles for any Web Conferencing user "Setting User Roles"
runTests Run status tests on the Web Conferencing system "Testing and Monitoring the System"
setProperty Set properties to configure the Web Conferencing system "Setting and Displaying Properties"
start Start a Web Conferencing instance "Starting and Stopping an Instance"
stop Stop a Web Conferencing instance "Starting and Stopping an Instance"
versions List version information for an instance "Listing System Information"

The following sections discuss the imtctl commands, grouped as follows:

10.4 Starting and Stopping an Instance

You use the start and stop commands to start any instance or component processes.


Note:

Although the start and stop commands let you start and stop individual components for administrative purposes, this document strongly recommends that in general you start or stop only a complete instance whenever possible.

10.4.1 start

Start the current instance, or individual components in the current instance. See Table 10-1 for the valid values for instance and component options.

  • start

    Start all the components in the current instance. This is the recommended way to start an instance, because it handles all startup dependencies.

  • start -i instance-name

    Start all components in a specific instance.

  • start -cid component-ID

    Start the component with the given ID.

  • start -cname component-name

    Start the component(s) with the given name.

  • start -ct component-type

    Start the component(s) with the given type.

Example 1: Starting a Component with a Specific ID

To start a component with ID 10001 in the current instance, enter:

imtctl> start -cid 10001

Note:

The component with the ID you enter must be running on the instance where you enter the imtctl command.

Example 2: Starting a Component with a Specific Name

To start a component named imt-collab in the current instance, enter:

imtctl> start -cname imt-collab

Note:

The component with the name you enter must be running on the instance where you enter the imtctl command.

10.4.2 stop

Stop the current instance, or individual components in the current instance. See Table 10-1 for the valid values for instance and component options.

  • stop

    Stop all the components in the current instance. This is the recommended way to stop an instance, because it stops all components in the instance in appropriate order.

  • stop -i instance-name

    Stop all components in a specific instance.

  • stop -cid component-ID

    Stop the component with the given ID.

  • stop -cname component-name

    Stop the component(s) with the given name.

  • stop -ct component-type

    Stop the component(s) with the given type.

Example 1: Stopping a Component with a Specific ID

To stop a component with ID 10001, enter:

imtctl> stop-cid 10001

Note:

The component with the ID you enter must be running on the instance where you enter the imtctl command.

Example 2: Stopping a Component with a Specific Name

To stop any component named imt-collab, enter:

imtctl> stop -cname imt-collab

Note:

The component with the name you enter must be running on the instance where you enter the imtctl command.

10.5 Listing System Information

Three informational commands, listInstances, listComponents, and versions, let you display details about parts of your system.

10.5.1 listInstances

List all the instances in the Real-Time Collaboration system.

imtctl> listInstances
INSTANCE NAME                  HOST NAME             IMT HOME
instance1.oracle.com        host1.oracle.com      C:/core/imeeting
instance2.oracle.com        host2.oracle.com      /u02/90200b/imeeting

10.5.2 listComponents

List the components in any Real-Time Collaboration instance. See Table 10-1 for the valid values for component and instance options.

  • listComponents

    List information about all components on the current instance.

  • listComponents -i instance-name

    List all the components for a particular instance.

  • listComponents -cid component_ID

    List the component with the given ID.

  • listComponents -cname component-name [-i instance-name]

    List the component with the given name. If -i is used, the component with the given name in the given instance is listed.

  • listComponents -ct component-type [-i instance-name]

    List the component with the given type. If -i is used, the component with the given type in the given instance is listed.

Example 1: Listing Components in the Current Instance

To list the components in the current instance, enter:

imtctl> listComponents
ID      NAME             TYPE       DESCRIPTION                NUM_PROCS
10006   imt-collab       clbsvr     Collaboration Server       4
10008   imt-pm           imtpm      iMeeting Process Monitor   1
10009   imtctl           imtctl     iMeeting CmdLine Control   1
10007   OC4J_imeeting    oc4j       OC4J                       1
10005   imt-mx           mxcomm     Multiplexer                1

Example 2: Listing Components for a Specific Instance

To list the components in a different instance (instance1.company.com), enter:

imtctl> listComponents -i instance1.company.com
ID      NAME             TYPE       DESCRIPTION                NUM_PROCS
10003   imt-voice        voiceconv  Voice Conversion Server    1
10004   imt-converter    docconv    Document Conversion Server 1

Example 3: Listing Components with a Specific ID

To list the component with the ID 10007, enter:

imtctl> listComponents -cid 10006
ID      NAME             TYPE       DESCRIPTION                NUM_PROCS
10007   OC4J_imeeting    oc4j       OC4J                       1

Example 4: Listing Components with a Specific Type

To list the components in the current instance with the type clbsvr, enter:

imtctl> listComponents -ct clbsvr
ID      NAME             TYPE       DESCRIPTION                NUM_PROCS
10006   imt-collab       clbsvr     Collaboration Server       4

10.5.3 versions

List the software versions for an instance or components. See Table 10-1 for the valid values for instance and component options.

  • versions [-i instance-name]

    List versions for all components in the current instance or a specified instance.

  • versions -cid component-ID

    List the version for a specific component, by its ID.

  • versions -cname component-name [-i instance-name]

    List the versions for all components with a specific name, and optionally for a specific instance.

  • versions -ct component-type [-i instance-name]

    List the versions for all components with a specific type, and optionally for a specific instance.

Example 1: List Versions for the Current Instance

To list the software versions running on all components in the current instance, enter:

imtctl> versions
ID        NAME              TYPE             VERSION
10006     imt-collab        clbsvr           2.0.4.3.0 Rel20430_135
10008     imt-pm            imtpm            2.0.4.3.0 Rel20430_135
10007     OC4J_imeeting     oc4j             2.0.4.3.0 Rel20430_135

Example 2: List Versions for a Component on a Specific Instance

To list the software version of the document conversion server on myinstance.oracle.com, enter:

imtctl> versions -ct docconv -i myinstance.oracle.com
ID        NAME              TYPE             VERSION
10010     imt-docconv       docconv          2.0.4.3.0 Rel20430_135

10.6 Setting and Displaying Properties

You configure the Web Conferencing system by setting properties. The setProperty, getProperty, and getProperties commands let you set and display property details.

See Table 5-2, "Web Conferencing Properties" in Chapter 5, "Configuration" for a list of all of the properties you can set. That chapter also provides specific syntax for each property.

10.6.1 setProperty

Set a property to configure a Real-Time Collaboration system, instance (default) component, and/or site. See Table 10-1 for the valid values for system, instance, component, and site options.

  • imtctl> setProperty -pname property-name -pvalue property-name

    Set the value for a property at instance level.

  • imtctl> setProperty -cid component-id -pname prop_name -pvalue prop_value

    Set the value of a property for the component with the given ID.

  • imtctl> setProperty -cname component-name [-i instance-name] -pname prop_name -pvalue prop_value

    Set the value of a property for the components of the given name in the current instance. If -i is used, it sets the property for the components of the given name in the given instance.

  • imtctl> setProperty -ct component-type [-i instance-name] -pname prop_name -pvalue prop_value

    Set the value of a property for the components with the given type in the current instance. If -i is used, it sets the property for the components with the given type in the given instance.

  • imtctl> setProperty -system true -pname property_name -pvalue property_value

    Set the value for a property at the system level.

  • imtctl> setProperty -siteId site-id -pname property_name -pvalue property_value

    Set the value for a property at site level.

  • imtctl> setProperty -pname property-name -pvaluenull true|false

    Sets the value of a property to null if -pvaluenull is true. Use this to unset a property so that it has a null value. Some properties interpret null in a special manner. For example, the GlobalWebhost property, once configured, cannot be unset unless set to a value of "null." By default, the value for -pvaluenull is false, in which case a -pvalue is required.

Example 1: Setting a Property for an Instance

To set the ApacheWebHost property for the current instance to imeeting4.company.com, enter:

imtctl> setProperty -pname ApacheWebHost -pvalue imeeting4.company.com

Example 2: Setting a Property for a System

To set the system-wide log-level to SEVERE, enter:

imtctl> setProperty -system true -pname LogLevel -pvalue SEVERE

See Chapter 5, "Configuration" for more examples.

10.6.2 getProperty

Get a property at a specified scope. Oracle Real-Time Collaboration supports system, instance (default), component, and site scopes. See Table 10-1 for the valid values for system, instance, component, and site options.

  • imtctl> getProperty -pname property_name

    Get the value for the property for this instance.

  • imtctl> getProperty -cid component-id -pname property_name

    Get the value of the property for the component with the given ID.

  • imtctl> getProperty -cname component-name [-i instance-name] -pname property_name

    Get the value of the property for the components of the given name in the current instance. If -i is used, it gets the property for the components of the given name in the given instance.

  • imtctl> getProperty -ct component-type [-i instance-name] -pname property_name

    Get the value of the property for the components with the given type in the current instance. If -i is used, it gets the property for the components with the given type in the given instance.

  • imtctl> getProperty -system true -pname property_name

    Get the value for the property at the system level.

  • imtctl> getProperty -siteId site-id -pname property_name

    Get the value for all the properties at site level for the specified site

Example 1: Getting a Property for the Current Instance

To get the ApacheWebHost property for the current instance, enter:

imtctl> getProperty -pname ApacheWebHost 
The effective value for instance myinstance.ap079sun.us.oracle.com of the property "ApacheWebHost" is "imeeting4.company.com"

Example 2: Getting a Property for the System

To display whether the system has SSL security enabled (it is possible to create secure meetings), enter:

imtctl> getProperty -system true -pname GlobalMeetingSSLSupportEnabled 
The effective value at system scope of the property "GlobalMeetingSSLSupportEnabled" is "true"

For a list of all possible properties, see Chapter 5, "Configuration".

10.6.3 getProperties

Displays an alphabetized list of all properties at the specified scope and higher. You can display properties for the system and for an instance , component, or site. See Table 10-1 for the valid values for system, instance, component, and site options.

  • imtctl> getProperties

    Display the values for the properties for this instance and for the system.

  • imtctl> getProperties -ct component-type [-i instance-name]

    Display the value of all the properties for the component with the given type in the current instance. If -i is used, it gets the property for the components with the given type in the given instance. It will return properties for the component, instance and system.

  • imtctl> getProperties -system true

    Display only system properties.

  • imtctl> getProperties -siteId site-id

    Display the value for all the properties for the specified site and the system.

Example 1: Displaying the Properties for the System Only

To display only system-level properties, enter:

imtctl> getProperties -system true
AllSitesID="100"
ApplicationContainerName="RTC"
ApplicationEntryName="RTCApplication"
CheckConnectionTimePeriod="15"
ConsolePrivacyEnabled="true"
CorpImageName="oracle_ocs_crop.gif"
DateFormat="dd-MMM-yyyy h:mm a"
...

Note:

The command displays all properties set for your system, including those set by default or through the Web Conferencing graphical user interface. The properties you might normally wish to set using setProperty to configure your system are discussed in Chapter 5, "Configuration".

Example 2: Displaying the Properties for a Component by Type

To display the properties of all collaboration server (clbsvr) components on this instance, as well as instance and system properties, enter:

imtctl> getProperties -ct clbsvr
AdditionalLocationsServed="(null)"
AdminEmail="imeeting@us"
AllSitesID="100"
ApacheProtocolSecure="true"
ApacheTunnelHost="machine1.us.oracle.com"
ApacheTunnelPort="443"
ApacheWebHost="machine1.us.oracle.com"
ApacheWebPort="80"
ApacheWebSecurePort="443"
...

10.7 Setting User Roles

As described in "User Management", the Web Conferencing system uses the Oracle Internet Directory store to identify users. You assign roles to these users to allow them access to various features of the Web Conferencing system. You use the modifyRole command to assign the roles.

10.7.1 modifyRole

Sets a user's role, to control what features of the Web Conferencing system the user may access.

modifyRole -username username -rolename rolename

Assigns a role to a named user. The user's name is that shown in the Oracle Internet Directory, such as john.smith@oracle.com. The role can be any of the following:

  • enduser: Can use any of the standard Web Conferencing features, such as scheduling a meeting, uploading mneeting materials, and viewing meeting archives.

  • businessmonitor: Can use standard Web Conferencing features, and can also view the Monitor and Reports tabs to monitor current conferences and see reports regarding conference history, usage, and user's feedback about conferences.

  • businessadmin: Can use any of the previous-listed features, and can also view the Site and System tabs to create and manage Web Conferencing sites and view statistics about all instances and components of the system.


Note:

Only a user with businessadmin privileges can set other users' roles. As discussed in Chapter 4, "Post-Installation", you must set at least one businessadmin user for a Web Conferencing installation.

Example: Setting a Business Administrator Role

To set a jane.roe@oracle.com to be a business administrator, enter:

imtctl> modifyRole -username jane.roe@oracle.com -rolename businessadmin

10.8 Setting Conference Dial-In Information

If you use streaming voice conferences, the addSysDialin, deleteSysDialin, and getSysDialins commands let you manage the dial-in numbers for any of your phone conference vendors. See Chapter 5, "Configuration" for more details and examples of how you might set dial-in information.

10.8.1 addSysDialin

Sets a named dial-in with a pre-programmed number that users can choose from a drop-down list when scheduling a conference. You can enter a complete number with conference ID and password for a recurring phone conference, or enter a template number with text indicating where users need to substitute their own information. When users select this dial-in, they can edit the number in the text field.

  • addSysDialin -name dialin-name -sequence dialin-sequence [-default true]

    Adds a dial-in with a specified name and number (sequence). If -default is set to true, this dial-in is the default for all users of the Web Conferencing system.


    Note:

    The Voice Conversion server handles the actual dialing of the number. If your company has a prefix that must be entered to get an outside line, you set that prefix using the VoiceDialInPrefix property. Do not enter the prefix in the dial-in. See "Setting Up Document and Voice Conversion Servers for Web Conferencing" for more details.

Example 1: Setting a Default Dial-in for a System

To set a dial-in named Standard Phone Conference that can be used by all users as a default, enter:

imtctl> addSysDialin -name "Standard Conference" -sequence "18005551234,,<Conf ID>#<Passcode>#,,,,,,,,,,#" -default true
New system dialin created with id = 21994

The Web Conferencing system automatically assigns the dial-in an ID number.

In the previous example, users can remove the text in angle brackets and type in their specific conference ID and passcode for a particular conference. The commas (,) cause dialing to pause for one second. The # symbol represents the user pressing the # button to complete entering an ID or password (typically required by most phone conference vendors). If your phone conference system includes additional message to which the user must respond by pressing #, you can include commas to pause during the message and a # for response.

Example 2: Setting a Dial-in for a Recurring Conference

To set a dial-in for a recurring conference with ID 80904 and passcode 56221, enter:

addSysDialin -name "Sales Force Mtg" -sequence "18005551234,,80904#56221#,,,,,,,,,,#"

10.8.2 getSysDialins

Displays the currently-set dial-ins.

getSysDialins
ID     NAME                   SEQUENCE
21994  Standard Conference    18005551234,,<Conf ID>#<Passcode>#,,,,,,,,,,#
21998  Sales Force Mtg        18005551234,,80904#56221#,,,,,,,,,,#

10.8.3 deleteSysDialin

Deletes an existing dial-in number. You can delete the dial-in by entering either its name, or its ID. For example, to delete a conference named Standard Conference, enter:

imtctl> deleteSysDialin -name "Standard Conference"
Standard Conference has been deleted

To delete a conference with the ID 21994, enter:

imtctl> deleteSysDialin -id 21994
Dialin with id 21994 has been deleted

10.9 Testing and Monitoring the System

The getState, getPids, getMonitorStats, and runTests commands let you view the state of various components and processes, and run quick tests on instances or components.

10.9.1 getState

Shows the state of components in any instance. See Table 10-1 for the valid values for component and instance options.

  • imtctl> getState [-i instance-name]

    Show the state of all the components in the current instance. Use -i to show the state of components in an instance with the given name.

  • imtctl> getState -cid component-ID

    Show the state of the component with the given ID.

  • imtctl> getState -cname component-name [-i instance-name]

    Show the state of the components of the given name in the current instance. If -i is used, it shows state of the components with the given name in the given instance.

  • imtctl> getState -ct component-type [-i instance-name]

    Show state of the components with the given type in the current instance. If -i is used, it shows state of the components with the given type in the given instance.

Example: Getting the State of All Components

To get the state of all the components in the current instance, enter:

imtctl> getState
ID       NAME           TYPE         STATUS     NUM_PROCS
10001    imt-collab     clbsvr                 UP         4
10000    mx             mxcomm       UP         1

10.9.2 getPids

Display the process identifiers for all running processes. See Table 10-1 for the valid values for instance and component options.

  • getPids [-i instance-name]

    Display the process identifiers for either the current instance, or a specified instance if -i is used.

  • getPids -cid component-id

    Display the process identifiers for a specific instance, by its ID number.

  • getPids -cname component-name [-i instance-name]

    Display the process identifiers for components by name. If -i is used, displays the identifiers for the named components in the named instance.

  • getPids -ct component-type [-i instance-name]

    Display the process identifiers for components by type. If -i is used, displays the identifiers for the specified components in the named instance.

Example 1: Display All Process Identifiers for an Instance

To display all the process identifiers for the current instance, enter:

imtctl> getPids
ID       NAME           COMPONENT TYPE    PIDS
10006    imt-collab     clbsvr                      12650
10006    imt-collab     clbsvr            912
10006    imt-collab     clbsvr            12549
10006    imt-collab     clbsvr            31966
10008    imt-pm         imtpm             25921
10007    OC4J_imeeting  oc4j              15585
10005    imt-mx         mxcomm            26003

Example 2: Displaying Process Identifiers for Components on an Instance

To display the process identifiers for any document conversion servers on instance myinstance.oracle.com, enter:

imtctl> getPids -ct docconv -i myinstance.oracle.com
ID       NAME          COMPONENT TYPE     PIDS
10010    imt-docconv   docconv            3020

10.9.3 getMonitorStats

Dispays monitoring statistics for a system, instance, or component. See Table 10-1 for the valid values for system, instance and component options. See Chapter 7, "Monitoring" for more information about monitoring components.

  • getMonitorStats [-i instance-name]

    Display statistics for the current instance or, if -i is used, for a named instance.

  • getMonitorStats -cid component-id

    Display statistics for a particular component in this instance, by the component ID number.

  • getMonitorStats -cname component-name [-i instance-name]

    Display statistics for all components of a particular name in this instance or, if -i is used, in a named instance.

  • getMonitorStats -ctype component-type [-i instance-name]

    Display statistics for all components of a particular type in this instance or, if -i is used, in a named instance.

  • getMonitorStats -system true

    Display statistics for all components in the system.

  • getMonitorStats -publish true

    Display statistics for all components in this instance and display them in XML format, for use in integrating with other applications. The -publish option can be used with options that specify system, site, component, or instance.

The displayed results vary depending on the types of components. The results list may include any of the following.

Statistics for collaboration server components:

  • TMTGS: Number of conferences since the process was started

  • CMTGS: Number of active conferences

  • CLTS: Number of active users

  • TMEM: Total memory allocated for this component

  • UMEM: Total memory currently used by this component

Statistics for voice conversion server components:

  • AVAIL: Whether the voice conversion server is available

  • T1LINE: Whether a T1 line is available

  • IN-USE: Number of voice channels currently in use

  • IDLE: Number of voice channels idle

  • BAD: Number of bad voice channels

Example 1: Displaying Statistics for an Instance

To display statistics for all components in a specific instance, enter:

intctl> getMonitorStats -i instance1.oracle.com
Instance - instance1.oracle.com:
Component Name: imt-collab, Component Type: clbsvr
SERVICE_NAME                           TMTGS CMTGS  CLTS  TMEM     UMEM
clbsvr:instance1.oracle.com.imt-collab.01     1     2     4,708K   4,285K
clbsvr:instance1.oracle.com.imt-collab.11     0     0     4,624K   3,836K
clbsvr:instance1.oracle.com.imt-collab.20     0     0     8,644K   3,457K

These statistics show there is currently one conference being run on imt-collab.01, with two attendees.

Example 2: Displaying Statistics for a System

To display statistics for all components and instances in this system, enter:

intctl> getMonitorStats -system true
Instance - instance1.oracle.com:
Component Name: imt-collab, Component Type: clbsvr
SERVICE_NAME                           TMTGS CMTGS  CLTS  TMEM     UMEM
clbsvr:instance1.oracle.com.imt-collab.01     1     2     4,708K   4,285K
clbsvr:instance1.oracle.com.imt-collab.11     0     0     4,624K   3,836K
clbsvr:instance1.oracle.com.imt-collab.20     0     0     8,644K   3,457K
Instance - instance2.oracle.com:
Component Name: imt-voiceconv, Component Type: voiceconv
SERVICE_NAME                                   AVAIL T1LINE IN-USE  IDLE   BAD
voiceconv:instance2.oracle.com.imt-voiceconv.0 true  true   0       12     0

These statistics show there is currently one meeting being run on imt-collab.01 with two attendees, and there are 12 channels on the voice conversion server available on a T1 line but none currently in use.

10.9.4 runTests

Runs Real-Time Collaboration tests on a specific instance or all instances in the system. See Table 10-1 for the valid values for instance options. See Chapter 7, "Monitoring" for more information about using the tests.

  • runTests [-i instance-name]

    Run tests in the current instance. Use -i to run all the tests in an instance with the given name.

  • runTests -testlist test-name, test-name, test-name...

    The possible tests are:

    • apptest database connectivity test

    • dbtest database connectivity test

    • docconvtest document conversion service test

    • emailtest e-mail configuration test

    • mtgtest conference service test

    • mxmodtest multiplexer/mod_imeeting configuration test

    • proxytest proxy configuration test

    • voiceconvtest voice conversion service test

  • runTests -system true

    Run tests on all the instances in the system.

  • runTests -publish true

    Run tests on the current instance with the output displayed in structured XML tags. This option can be used in scripts to provide output to services integrated with Web Conferencing.

  • runTests -v true

    Run tests on the current instance with the verbose option to display any messages regarding test failures.

  • runTests -cluster true

    Run the conference service tests on a cluster of instances. If this instance is not part of a cluster, the test is only run on the current instance.

Example 1: Testing an Instance

After installing an instance, enter the following to see if the instance is configured properly and working. The runTests command will run all appropriate tests for components installed on this instance.

imtctl> runTests
Instance - myinstance.oracle.com
TESTNAME              SUCCESS
mtgtest               true
voiceconvtest         true
docconvtest           true
dbtest                true
apptest               true
mxmodtest             true
proxytest             true
emailtest             true

Example 2: Running a Single Test

To run the conference test alone, invoke the following

imtctl> runTests -testlist mtgtest
Instance - myinstance.oracle.com
TEST NAME                    SUCCESS
mtgtest               true

Example 3: Running Multiple Tests With the Verbose Option

To run multiple tests with verbose display, enter:

imtctl> runTests -testlist mtgtest,emailtest,modtest -v true
Instance - myinstance.oracle.com
TEST NAME            SUCCESS   MESSAGE
mtgtest              true
emailtest            true
modtest               false     Unknown test

In the example, one option was entered incorrectly (modtest instead of mxmodtest), so the message displayed by the -v option reports the problem.

10.10 Getting Help and Quitting imtctl

The help command displays help about all commands available in imtctl. You can exit the imtctl command line interface by entering exit or quit.

10.10.1 help

Displays the list of imtctl commands.

imtctl> help
Commands are:
start - Start a specified component or complete instance.
stop - Stop a specified component or complete instance.
getstate - Gets the state of a specified component or complete instance.
...

10.10.2 exit or quit

Leaves the imtctl command-line interface. You can use either exit or quit.

> $ORACLE_HOME/imeeting/bin/imtctl
imtctl>
imtctl> exit
>