This chapter describes how to use the imadmin command to administer Oracle Communications Instant Messaging Server.
You can use the imadmin command to start, stop, and refresh the Instant Messaging server and multiplexor.
You must invoke the imadmin command from the host on which Instant Messaging server is installed. Run imadmin as root or as the end user you specified during configuration.
By default, imadmin is installed in the following location:
InstantMessaging_home/sbin
Table 30-1 lists and describes commands related to the imadmin command.
Table 30-1 imadmin Commands and Descriptions
Command | Description |
---|---|
imadmin assign_services |
If iim.policy.modules is set to iim_ldap, and iim.userprops.store is set to ldap, this command adds object classes (sunIMUser, and sunPresenceUser) to user entries in the directory. Instant Messaging Server requires these object classes to store properties in LDAP. The assign_services command fails if the LDAP search limit exceeds the defined value. To avoid this failure, increase the search limit of the LDAP server. Set the values of the directory server parameters as follows:
|
imadmin status |
Checks to see if the components (server, multiplexor, agent-calendar, and watchdog) are up and running and displays the results. If you do not specify a component, the imadmin command 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 start sms-gateway |
Starts the SMS Gateway. |
imadmin stop sms-gateway |
Stops the SMS Gateway. |
imadmin status sms-gateway |
Displays the status of SMS Gateway. |
imadmin refresh sms-gateway |
Refreshes the SMS Gateway. |
imadmin start relay |
Starts the relay server. |
imadmin stop relay |
Stops the relay server. |
imadmin refresh relay |
Refreshes the relay server. |
imadmin status relay |
Displays the status of relay server. |
imadmin smf-register |
Registers the Service Management Facility (SMF) with Instant Messaging Server. |
Table 30-3 lists and describes actions performed after various imadmin commands are issued.
Table 30-3 Actions for imadmin Command
Action | Description |
---|---|
status |
Returns information about Instant Messaging Server 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 30-4 lists and describes the components for the imadmin command.
Table 30-4 Components for imadmin Command
Components | Description |
---|---|
agent-calendar |
Indicates the Calendar agent (agent-calendar). |
multiplexor |
Indicates the multiplexor alone. |
server |
Indicates the Instant Messaging server. |
watchdog |
Indicates the watchdog. |
sms-gateway |
Indicates the SMS Gateway. |
relay |
Indicates shoal cross-subnet relay server. |