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 support actions such as starting and stopping Real-Time Collaboration processes, viewing their current state, and configuring them. You can run imtctl in an interactive shell mode, or it can take a single command as a command-line argument, in which case it will execute the command and exit.

The utility is available on all platforms under <ORACLE_HOME>/imeeting/bin. It is invoked as "imtctl" on all platforms. Invoking imtctl without any arguments opens the interactive shell.

$ORACLE_HOME/imeeting/bin> imtctl

A list of supported commands can be obtained by executing the help command:

imtctl> help

You can get specific instructions for a particular command by invoking the command followed by the "-help" option:

imtctl> <COMMAND> -help

The exit command ends the shell session:

imtctl> exit

10.1 Common Commands

10.1.1 Help

Gets the list of commands available in the shell.

10.1.2 listInstances

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

Examples:

It can only be invoked in one way:

imtctl> listInstances

Table 10-1 Real-Time Collaboration Instances

Instance Name	Host Name	Oracle Web Conferencing Home
instance1.oracle.com	host1.oracle.com	C:/core/imeeting
instance2.oracle.com	host2.oracle.com	/u02/ 90200b/imeeting

10.1.3 listComponents

List the components in any instance. The different forms of this command are:

• listComponents [-i <instance-name>]:

  List all the components in the current instance. Use -i to list components in an instance with the given name.

• listComponents - cid <component-id>

  List the component with the given ID.

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

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

• listComponents -ctype <component-type> [-i <instance-name>]

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

10.1.3.1 Examples

Example 1

To get the components in the current instance (ap079sun.us.oracle.com), invoke the following:

imtctl> listComponents

Table 10-2

ID	Name	Type	Description	num_procs
10001	imt-collab	clbsvr	Collaboration Server	4
10003	imt-starter	starter	Web Conferencing Starter	1
10002	OC4J_imeeting	oc4j	OC4J	1
10000	mx	mxcomm	Multiplexer	1

Example 2

To get the components in a different instance (instance1.company.com), invoke the following:

imtctl> listComponents -i instance1.company.com

Table 10-3

ID	Name	Type	Description	num_procs
10006	imt-voice	voiceconv	Voice Conversion Server	1
10005	imt-starter	starter	Web Conferencing Starter	1
10004	imt-converter	docconv	Document Conversion Server	1

To list the component with the ID 10006, invoke the following:

imtctl> listComponents -cid 10006

Table 10-4

ID	Name	Type	Description	num_procs
10006	imt-voice	voiceconv	Voice Conversion Server	1

Example 3

To list the components on the current instance with the type "clbsvr", invoke the following

imtctl> listComponents -ct clbsvr

Table 10-5

ID	Name	Type	Description	num_procs
10001	imt-collab	clbsvr	Collaboration Server	4

10.1.4 start

Start the whole (current) instance, or individual components in the current instance. The different forms of this command are:

• start:

  Start all the components in the current instance. This is the recommended way of starting an instance. This takes care of startup dependencies.

• start - cid <component-id>

  Start the component with the given ID.

• start -cname <component-name>

  Start the component of the given name.

• start -ctype <component-type>

  Start the components with the given type.

10.1.4.1 Examples

Example 1

To start a component with component ID 10001 (which needs to be on the current instance) invoke:

imtctl> start -cid 10001

Example 2

To start a component with name imt-collab (which needs to be on the current instance) invoke:

imtctl> start -cname imt-collab

10.1.5 stop

Stop the whole (current) instance, or individual components in the current instance. The different forms of this command are:

• stop:

  Stop all the components in the current instance. This is the recommended way of stopping an instance. This takes care of stopping all components in the instance in appropriate order.

• stop - cid <component-id>

  Stop the component with the given ID.

• stop -cname <component-name>

  Stop the component with the given type.

• stop -ctype <component-type>

  Stop the component with the given type.

10.1.5.1 Examples

Example 1

To start a component with component ID 10001 (which needs to be on the current instance) invoke:

imtctl> stop-cid 10001

To start a component with name imt-collab (which needs to be on the current instance) invoke:

imtctl> stop -cname imt-collab

10.1.6 getState

Shows the state of components in any instance. The different forms of this command are:

• imtctl> getState [-i <instance-name>]:

  Show 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 state of the component with the given ID.

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

  Show 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 -ctype <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.

Examples

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

imtctl> getState

Table 10-6

ID	Name	Type	Status	num_procs
10001	imt-collab	clbsvr	UP	4
10000	mx	mxcomm	UP	1

10.1.7 setProperty

Set a property at a specified scope. Oracle Real-Time Collaboration supports system, instance (default), component, site, and conference type scopes. See Chapter 5, "Configuration" for more information on these scopes.

The different forms of this command are:

• imtctl> setProperty -pname <property_name> -pvalue <property_value>:

  Set the value for the property at instance level.

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

  Set the value of the 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 the property for the component of the given name in the current instance. If -i is used, it sets the property for the component of the given name in the given instance.

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

  Set the value of the 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 the property at system level.

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

  Set the value for the property at site level.

Examples

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

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

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

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

See Chapter 5, "Configuration" and Chapter 6, "Sample Deployments" for more examples.

10.1.8 getProperty

Get a property at the a specified scope. Oracle Real-Time Collaboration supports system, instance (default), component, site, and meeting type scopes. See Chapter 5, "Configuration" for more information on these scopes.

The different forms of this command are:

• imtctl> getProperty -pname <property_name>

  Get the value for the property at instance level.

• imtctl> getProperty -cid <component-id> -pname <prop_name>

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

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

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

• imtctl> getProperty -ctype <component-type> [-i <instance-name>] -pname <prop_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 system level.

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

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

• imtctl> getProperty - mtgType <meeting type> -siteId <site-id> -pname <property_name>

  Get the value for all the properties at meeting type level for the specified meeting type and the site level properties in the specified site.

Examples

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

imtctl> getProperty -pname ApacheWebHost 

The effective value for instance 90200b.ap079sun.us.oracle.com of the property "ApacheWebHost" is "imeeting4.company.com"

To get the system-wide log-level, invoke:

imtctl> getProperty -system true -pname LogLevel 

10.1.9 getProperties

Gets all properties at the a specified scope and above. Oracle Real-Time Collaboration supports system, instance (default), component, site, and meeting type scopes. See Chapter 5, "Configuration" for more information on these scopes.

The different forms of this command are:

• imtctl> getProperties

  Get the values for the properties at instance level and system.

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

  Get 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

  Gets all system properties only

• imtctl> getProperties - siteId <site-id>

  Gets the value for all the properties at site level for the specified site and the system.

10.1.10 runTests

Runs Real-Time Collaboration tests (all tests or a specified set of tests) on a specific instance or all instances in the system.

• 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-list separated by commas>]

  Different tests are:

  • mtgtest--conference service test
  • voiceconvtest--voice conversion service test
  • docconvtest--document conversion service test
  • dbtest--database connectivity test
  • modtest--mx/mod configuration test
  • proxytest--proxy configuration test
  • emailtest--e-mail configuration test
• runTests - system true

  Run the tests on all the instances in the system.

Examples

After doing an installation and during the post-installation steps, the following can be invoked to see if things are configured properly and working.

imtctl> runTests

To run the conference test alone, invoke the following

imtctl> runTests -testlist "mtgtest"

To run the conference test and voice conversion service test, invoke the following

imtctl> runTests -testlist "mtgtest,voiceconvtest"