Stopping, Starting, Refreshing, and Checking Instant Messaging Components

The imadmin command enables you to:

Start and stop all Instant Messaging components (server, multiplexor, Calendar agent, cluster agent, and watchdog).
Start and stop an individual Instant Messaging component.
Refresh all Instant Messaging component configurations.
Refresh an individual Instant Messaging component.
Check the status of Instant Messaging components.

The imadmin command-line utility can be executed only by root or a user who has administration rights to the system(s) on which the Instant Messaging server and multiplexor are running. This end user is typically the identity that the server runs as, and is designated during installation:

On Solaris - inetuser.
In a deployment with Sun Java^TM System Access Manager, if the Sun Java System Portal Server and the Instant Messaging server are installed on the same host, the user is the one who is running the Access Manager, as root.

The imadmin command-line utility is located in the following directory:

im-svr-base/sbin

Starting the Instant Messaging server enables Instant Messenger to connect to it. Stopping the Instant Messaging server closes all connections and disconnects all Instant Messenger clients.

Starting Instant Messaging Components

You can start all the components together or a single component separately.

Use the imadmin command with the start option to start the Instant Messaging Server, multiplexor, Calendar agent, cluster agent, and watchdog depending on which components are enabled.

To Start All Components

At the command line, type the following:
imadmin start
If both server and multiplexor are enabled, this command first starts the Instant Messaging server, and then starts the multiplexor.

If the watchdog is enabled (default), this command starts the watchdog, then the watchdog reads the configuration file and starts the Instant Messaging Server and/or multiplexor as necessary.

To Start a Single Component

At the command line, type the imadmin start command with an argument that designates the component as follows:

Server:
imadmin start server
Multiplexor:
imadmin start multiplexor
Calendar agent:
imadmin start agent-calendar
Watchdog:
imadmin start watchdog

Stopping Instant Messaging Components

You can stop all the components together or a single component separately.

Use the imadmin command with the stop option to stop the Instant Messaging Server, multiplexor, Calendar agent, cluster agent, and watchdog depending on which components are enabled.

To Stop All Components

At the command line, type the following:
imadmin stop
If the watchdog is running, imadmin brings the watchdog down first, and then stops the server and/or the multiplexor.

This command stops the server, multiplexor, Calendar agent, cluster agent, and watchdog, terminates all end user connections, and disconnects any inbound and outbound servers configured.

To Stop a Single Component

At the command line, type the imadmin stop command with an argument that designates the component as follows:

Server:
imadmin stop server
Multiplexor:
imadmin stop multiplexor
Calendar agent:
imadmin stop agent-calendar
Watchdog:
imadmin stop watchdog

Refreshing Component Configuration

Use the imadmin command with the refresh option to stop and restart an individual Instant Messaging component and refresh that component’s configuration.

You can refresh all the components together or a single component separately.

Whenever you change a configuration parameter in the iim.conf file, you also need to refresh the configuration.

To Refresh All Components

At the command line, type the following:
imadmin refresh
This command stops the server, multiplexor, Calendar agent, cluster agent, and watchdog, terminates all end user connections, and disconnects any inbound and outbound servers configured.

If the watchdog is running, imadmin brings the watchdog down first, and then stops the server and/or the multiplexor. Then starts the watchdog which reads the configuration file and starts the Instant Messaging server and/or multiplexor as necessary.

To Refresh a Single Component

At the command line, type the imadmin refresh command with an argument that designates the component as follows:

Server:
imadmin refresh server
Multiplexor:
imadmin refresh multiplexor
Calendar agent:
imadmin refresh agent-calendar
Cluster agent:
imadmin refresh monitor
Watchdog:
imadmin refresh watchdog

Checking the Status of Instant Messaging Components

You can check the status of all the components together or a single component separately using the imadmin command with the status option. This command returns results in the following format:

Component  [status]

For example:

Server          [UP]
Multiplexor     [UP]
Agent:calendar  [DOWN]
Watchdog        [UP]

To Check the Status of All Components

At the command line, type the following:
imadmin status
This command returns the status of all enabled components.

To Check the Status of a Single Component

At the command line, type the imadmin status command with an argument that designates the component as follows:

Server:
imadmin status server
Multiplexor:
imadmin status multiplexor
Calendar agent:
imadmin status agent-calendar
Watchdog:
imadmin status watchdog