This chapter explains the imadmin command used to administer Instant Messaging in the following sections:
You can use the imadmin utility to start, stop, and refresh the Instant Messaging server and multiplexor. Run imadmin as root or as the end user you specified during configuration.
You must invoke the imadmin utility from the host on which Instant Messaging server is installed.
By default, imadmin is installed in the following location:
im-svr-base/sbin
Table C–1 lists and describes commands related to the imadmin command.
Table C–1 imadmin Commands and Descriptions
Command |
Description |
---|---|
imadmin assign_services |
If iim.policy.modules is set to identity, this command assigns Instant Messaging and presence services to existing users under the base DN you specify. The DN should be the base DN of the organization under which user entries are stored. If iim.policy.modules is set to iim_ldap, and iim.userprops.store is set to ldap, this command adds objectclasses (sunIMUser, and sunPresenceUser) to user entries in the directory. Instant Messaging requires these objectclasses in order to store properties in LDAP. |
imadmin status (Previously imadmin check) |
Checks to see if the components (server, multiplexor, agent-calendar, and watchdog) are up and running and displays the results. If you don’t specify a component, the imadmin utility returns information about all components. |
imadmin start |
Starts the enabled component(s). |
imadmin stop |
Stops the enabled component(s). |
imadmin refresh |
Refreshes the enabled component(s). |
imadmin start server |
Starts only the server. |
imadmin stop server |
Stops only the server. |
imadmin refresh server |
Refreshes only the server. |
imadmin start multiplexor |
Starts only the multiplexor. |
imadmin stop multiplexor |
Stops only the multiplexor. |
imadmin refresh multiplexor |
Refreshes only the multiplexor. |
imadmin start agent-calendar |
Starts only the Calendar agent. |
imadmin stop agent-calendar |
Stops only the Calendar agent. |
imadmin refresh agent-calendar |
Refreshes only the Calendar agent. |
imadmin start watchdog |
Starts only the watchdog. |
imadmin stop watchdog |
Stops only the watchdog. |
imadmin refresh watchdog |
Refreshes only the watchdog. |
imadmin version |
Displays the version. |
imadmin [options] [action] [component]
Table C–2 lists and describes options for the imadmin command.
Table C–2 Options for imadmin command
Option |
Description |
---|---|
-c alt-config-file |
Used with the start and refresh actions, to specify a different configuration file other than /etc/opt/SUNWiim/config/iim.conf file |
-h |
Displays help on the imadmin command. |
Table C–3 lists and describes actions performed after various imadmin commands are issued.
Table C–3 Actions for imadmin Command
Option |
Description |
---|---|
status (Previously imadmin check) |
Returns information about Instant Messaging components (server, multiplexor, agent-calendar, and watchdog). You do not need to provide a [component] with this action. |
start |
Sets the classpath, the Java heap size and starts all the specified components. |
stop |
Stops all the specified component’s daemons. |
refresh |
Stops and starts the specified component(s). Useful after a configuration change. |
Table C–4 lists and describes the components for the imadmin command.
Table C–4 Components for imadmin Command
Option |
Description |
---|---|
agent-calendar |
Indicates the Calendar agent (agent-calendar). |
multiplexor |
Indicates the multiplexor alone. |
server |
Indicates the Instant Messaging server. |
watchdog |
Indicates the watchdog. |