Appendix A
iPlanet Instant Messaging Server Configuration Parameters
This appendix describes the settings that you can configure for iPlanet Instant Messaging Server.
This appendix contains these sections:
Using the iim.conf file
iPlanet Instant Messaging Server stores configuration settings in the following file:
This file is a plain ASCII text file, with each line defining a server parameter and its value(s):
A parameter and its value(s) are separated by an equal sign (=) with spaces and tabs allowed before or after the equal sign.
A value can be enclosed in double quotes (" "). If a parameter allows multiple values, the entire value string must be enclosed in double quotes.
A comment line must have an exclamation point (!) as the first character of the line. Comment lines are for informational purposes only and are ignored by the server.
If a parameter appears more than once, the value of the last parameter listed overrides the previous value.
A backslash (\) is a continuation character, and indicates that the value or values are longer than one line.
Each line is terminated by a line terminator (\n, \r, or \r\n).
The key consists of all the characters in the line starting with the first non-whitespace character and up to, but not including, the first ASCII equal sign (=) or semi-colon (;). If the key is terminated by a semi-colon, it is followed by "lang-" and then a tag that indicates the language in which this value is to be interpreted. The language tag is followed by an equal sign (=). All whitespace characters before and after the equal sign are ignored. All remaining characters on the line become part of the associated value string.
Multiple values in the value string are separated using commas (,).
Within a value, if any special characters like comma, space, newline, tab, double quotes, or backslash are present, the entire value needs to be within double quotes. In addition, every carriage return, line feed, tab, backslash, and double quotes within the value must be further escaped with a backslash (\).
If you make changes to the iim.conf file, you must refresh the iPlanet Instant Messaging server in order for your new configuration settings to take effect. See "To Refresh the Configuration (Instant Messaging Server and Multiplexor)" for more information.
.
|
Note
|
The iim.conf file is initialized by the installation process and should be modified only as described in this manual.
|
General Configuration Parameters
Table A-1 describes the general configuration parameters.
Table A-1 General Configuration Parameters
|
Parameter
|
Default Value
|
Description
|
|
iim.comm.modules
|
iim_server,iim_mux
|
The communication modules used. Values are iim_server and iim_mux. The default value is iim_server, iim_mux, which means both the server and multiplexor are used. The iim_mux value is useful for multiplexor only installations.
|
|
iim.smtpserver
|
localhost
|
SMTP server to send mail for users who have set the option of forwarding their messages as emails or to pagers.
|
|
iim.instancedir
|
/etc/opt/SUNWiim/default
|
Root of the installation directory.
|
|
iim.instancevardir
|
Solaris:
/var/opt/SUNWiim/default
Windows NT:
im30_install_dir\
|
Sets the directory to contain runtime files, including the user profile database, logs, and other files created by the server and multiplexor at runtime.
|
|
iim.user
|
iimuser
|
The user the server processes runs as. Used only on Solaris platforms.
|
|
iim.group
|
iimgroup
|
The group the server processes belongs to. Used only on Solaris platforms.
|
|
iim.jvm.maxmemorysize
|
256 MB
|
The maximum number of megabytes of memory that the JVM running the server is allowed to use. Used to construct the -mx argument of the Java command.
|
User Source Configuration Parameters
Table A-2 describes the user source configuration parameters.
Table A-2 User Source Configuration Parameters (1 of 3)
|
Parameter
|
Default Value
|
Description
|
|
iim_ldap.host
|
localhost:389
|
LDAP server name and port used by iIM server for user authentication.
|
|
iim_ldap.searchbase
|
o=internet
|
The string used as base to search for the users and groups on the LDAP server.
|
|
iim_ldap.usergroupbinddn
|
None (the server performs anonymous searches)
|
Specifies the dn to use to bind to the LDAP server for searches.
|
|
iim_ldap.usergroupbindcred
|
None (the server performs anonymous searches)
|
Specifies the password to use with the iim_ldap.usergroupbinddn dn for LDAP searches.
|
|
iim_ldap.loginfilter
|
(&(|(objectclass=inetorgperson)(objectclass=webtopuser))(uid={0}))
|
Search filter used during user login.
|
|
iim_ldap.
usergroupbyidsearchfilter
|
(|(&(objectclass=groupofuniquenames)(uid={0}))(&(|(objectclass=inetorgperson)(objectclass=webtopuser))(uid={0})))
|
The search filter used to search for users and groups in the directory, under the base specified by ID.
|
|
iim_ldap.usergroupbynamesearchfilter
|
(|(&(objectclass=groupofuniquenames)(cn={0}))(&(|(objectclass=inetorgperson)(objectclass=webtopuser))(cn={0})))
|
The search filter used to search for users and groups in the directory, under the base specified by name.
|
|
iim_ldap.allowwildcardinuid
|
False
|
Determines if wildcarding should be enabled for UIDs while doing a search. As most directory installations have UIDs indexed for exact searches only, the default value is False. Setting this value to True can impact performance unless UIDs are indexed for substring search.
|
|
iim_ldap.userclass
|
inetOrgPerson,webtopuser
|
The LDAP class that indicates that an entry belongs to a user.
|
|
iim_ldap.groupclass
|
groupOfUniqueNames
|
The LDAP class that indicates that an entry belongs to a group.
|
|
iim_ldap.groupbrowsefilter
|
(objectclass=groupofuniquenames)
|
The search filter used to browse all groups in the directory, under the specified search base.
|
|
iim_ldap.searchlimit
|
40
|
Maximum number of entries to be returned by a search. A value of -1 means search is disabled on this server and a value of 0 indicates unlimited search.
|
|
iim_ldap.userdisplay
|
cn
|
LDAP attribute to use for display name of users.
|
|
iim_ldap.groupdisplay
|
cn
|
LDAP attribute to use for display name of groups.
|
|
im_ldap.useruidattr
|
uid
|
LDAP attribute used as users' UID.
|
|
im_ldap.groupmemberattr
|
uniquemember
|
LDAP attribute that gives the list of members of a group.
|
|
iim_ldap.resynctime
|
720
|
The frequency, in minutes, at which the in memory user and group information is updated from LDAP.
|
|
iim_ldap.usermailattr
|
mail
|
LDAP attribute that should contain users' provisioned email addresses. Used in the email message sent to an offline user.
|
Logging Configuration Parameters
Table A-3 describes the logging configuration parameters.
Table A-3 Logging Configuration Parameters
|
Parameter
|
Default Value
|
Description
|
|
iim.log.iim_server.severity
|
NOTICE
|
Level of logging required for the server module. The possible values from highest to lowest are: FATAL, ERROR, NOTICE, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, NOTICE, and WARNING.
|
|
iim.log.iim_server.url
|
Solaris: /var/opt/SUNWiim/default/log/server.log
Windows NT: im30_install_dir\log\server.log
|
Location of the server log file. This file needs to be periodically trimmed to prevent disk space from filling up.
|
|
iim.log.iim_mux.severity
|
NOTICE
|
Level of logging required for the multiplexor module. The possible values from highest to lowest are: FATAL, ERROR, NOTICE, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, NOTICE, and WARNING.
|
|
iim.log.iim_mux.url
|
Solaris: /var/opt/SUNWiim/default/log/mux.log
Windows NT: im30_install_dir\log\mux.log
|
Location of the multiplexor log file. This file needs to be periodically trimmed to prevent disk space from filling up.
|
General iPlanet Instant Messaging Server Configuration Parameters
Table A-4 describes the iPlanet Instant Messaging server configuration parameters.
Table A-4 General iIM Server Configuration Parameters
|
Parameter
|
Default Value
|
Description
|
|
iim_server.domainname
|
host's domain name
|
The logical iIM Server domain name you want this server to support. This is the name that is used by other servers in the network to identify this server (the name tagged to users on this server when displayed to users on other server). It is also the name used by this server to identify its users to other servers. This is not necessarily the FQDN of the system running the iPlanet Instant Messaging server.
For example, if the system iim.xyz.com is the only iPlanet Instant Messaging server for a company xyz.com, then the domain name is likely to be xyz.com.
|
|
iim_server.port
|
9919
|
IP address and port for the server to bind to, to listen for connections from other servers. IP address setting is useful for multihomed machines when you want to use only one particular IP address. If no IP address is listed, this indicates a value of INADDR_ANY on localhost.
|
|
iim_server.useport
|
TRUE
|
Indicates whether the server should listen on the server-to-server communication port. The possible values are TRUE and FALSE. If TRUE, the server listens on the port defined by iim_server.port or on port 9919, if that is not explicitly defined.
|
|
iim_server.sslport
|
9910
|
Server's SSL port used for secure server-to-server communication. Note: The value format is IPaddress:port. If no IP address is listed, this indicates a value of INADDR_ANY on localhost.
|
|
iim_server.usesslport
|
FALSE
|
Indicates if the server should listen on the server-to-server SSL communication port. The possible values are TRUE and FALSE. If TRUE, the server listens on the port defined by iim_server.sslport or on port 9910, if that is not explicitly defined.
|
|
iim_server.sslkeystore
|
None
|
File name containing the certificate to use for SSL connection.
|
|
iim_server.sslkeystorepassphrase
|
None
|
Password of file name containing the SSL certificate.
|
|
iim_server.clienttimeout
|
15
|
Specifies the time, in minutes, before the server discards client connections that are no longer active, for example, when a machine is turned off. The minimum accepted value is 5.
|
Multiple Server Configuration Parameters
For communication between multiple iPlanet Instant Messaging servers in your network, you need to configure your server to identify itself to the other servers, and to identify each coserver, or cooperating server, which will have a connection to your server. The coserver identifies itself with its iIM domain name, host and port number, serverID, and password.
Each cooperating server is given a symbolic name, which is a string consisting of letters and digits, for example, coserver1. In this way you can specify multiple servers.
When iPlanet Instant Messaging servers are configured in this manner, you form a larger instant messaging community. Users on each server can communicate with users on every other server, use conferences rooms on other servers, and subscribe to news channels on other servers (subject to access privileges).
Table A-5 describes the multiple server configuration parameters.
Table A-5 Multiple Server Configuration Parameters
|
Parameter
|
Default Value
|
Description
|
|
iim_server.serverid
|
None
|
String used by this server to identify itself to all other servers.
|
|
iim_server.password
|
None
|
Password used by this server to authenticate itself to all other servers.
|
|
iim_server.coservers
|
None
|
Comma separated list containing symbolic names of the servers that can connect to this server. Any meaningful names are allowed, but they must match what you use for the .serverid, .password, and .host parameters. Examples:
iim_server.coservers=coserver1,coserver2
or
iim_server.coservers=abc,xyz,ntc
|
|
iim_server.coserver1.serverid
|
None
|
String that identifies the cooperating server represented by the name, coserver1 to authenticate to this server. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its serverid would be iim_server.abc.serverid.
|
|
iim_server.coserver1.password
|
None
|
Password used by cooperating server represented by the name, coserver1 to authenticate to this server. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its password would be iim_server.abc.password.
|
|
iim_server.coserver1.host
|
None
|
IP address and the port to connect to, for users on this server to communicate to users on the server represented by the name coserver1. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its host would be iim_server.abc.host.
Note: The value format is name:port or IPaddress:port.
|
|
iim_server.coserver1.usessl
|
False
|
Indicates if this server should use SSL to talk to the server identified by coserver1. The possible values are TRUE and FALSE.
|
Multiplexor Configuration Parameters
Table A-6 describes the multiplexor configuration parameters.
Table A-6 Multiplexor Configuration Parameters
|
Parameter
|
Default Value
|
Description
|
|
iim_mux.listenport
|
9909
|
IP address and listening port for the multiplexor, to listen for iPlanet Instant Messenger. The value format is IPaddress:port. If no IP address is listed, this indicates a value of INADDR_ANY on localhost. Note: If you change this value, also change the iim.html and iim.jnlp files so that they match the port value.
|
|
iim_mux.serverport
|
9999
|
The iIM server and port the multiplexor talks to. The value format is servername:port or IPaddress:port.
|
|
iim_mux.numinstances
|
1
|
Number of instances of the multiplexor. This parameter is valid only for Solaris platforms.
|
|
iim_mux.maxthreads
|
5
|
Maximum number of threads per instance of the multiplexor.
|
|
iim_mux.maxsessions
|
2000
|
Maximum number of concurrent connections per multiplexor process.
|