Calendar Server configuration parameters are stored in configuration files, including ics.conf and counter.conf.
This chapter provides the following information:
Calendar Server configuration parameters are stored in the following file:
/etc/opt/SUNWics5/config/ics.conf
The ics.conf file is a ASCII text file, with each line defining a parameter and its associated value(s). The parameters are initialized during Calendar Server installation. After installation, you can edit the file using a text editor.
Modify the settings for parameters in the ics.conf file only as described in Sun documentation or as directed by a customer support representative.
For example: Remote administration is not enabled for Calendar Server. Do not change the service.admin.portparameter, because it is already set to its required value by Calendar Server. Otherwise, the csadmind process might not run properly.
Log in as a user who has administrator rights to the system where Calendar Server is running.
Change to the /etc/opt/SUNWics5/config directory where the ics.conf file is located.
Edit parameters in the ics.conf file using a text editor such as vi. Conventions for parameters are:
All parameters must be in lower case only.
A parameter and its associated value(s) must be separated by an equal sign (=), with spaces or tabs allowed before or after the equal sign. For example:
service.http.idletimeout = "120"
A parameter value must be enclosed in double quotation marks ("). If a parameter allows multiple values, the entire value string must be enclosed in double quotation marks. For example:
calstore.calendar.owner.acl= "@@o^a^rsf^g;@@o^c^wdeic^g"
A comment line begins with an exclamation point (!). Comment lines are for informational purposes only and are ignored by Calendar Server.
Some parameters are released as comments, beginning with either one or two exclamation points (! or !!). To use this type of parameter, you must remove the exclamation point(s), supply a value (if needed), and then restart Calendar Server for the parameter to take effect.
For example, to use !!caldb.dwp.server.[hostname].ip, you must remove the exclamation points (!!), supply a value for hostname, and then restart Calendar Server.
If a parameter is not in the ics.conf file, add the parameter and its associated value to the file.
If a parameter appears more than once, the value of the last parameter listed overrides the previous value.
All options must start at the beginning of a line.
After you make changes to parameters in the ics.conf file, stop and then restart Calendar Server for the new configuration values to take effect.
If you prefer, you can also stop Calendar Server before you edit the ics.conf file. For more information, see Starting and Stopping Calendar Server.
Configuration parameters in the ics.conf file include:
The following table shows the Local configuration parameters with each parameter’s default value and description.
Table E–1 Local Configuration Parameters in the ics.conf File
The following table shows the Calendar Store Configuration parameters with each parameter’s default value and description.
Table E–2 Calendar Store Configuration Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"anonymous" |
Calendar ID (calid) used for anonymous logins. |
|
"yes" |
Determines if a user calendar can have more than one event scheduled for the same time slot when the calendar is created:
|
|
"@@o^a^r^g; @@o^c^wdeic^g; @^a^fs^g; @^c^^g; @^p^r^g" |
Specifies the default access control permissions used when a user creates a calendar. The format is specified by a semicolon-separated list of access control entry (ACE) argument strings. For details on the ACE format, see Calendar Access Control To specify Access Control Entries for one or more calendars using the command-line utilities, see cscal. |
|
"@@o^a^rsf^g; @@o^c^wdeic^g" |
Specifies the default access control settings for owners of a calendar. |
|
calstore.calendar.create. lowercase |
"no" |
Specifies whether Calendar Server should convert a calendar ID (calid) to lowercase when creating a new calendar or when looking up a calendar using the LDAP CLD plug-in. |
"America/ New_York" |
Time zone ID to be used when:
|
|
"yes" |
Specifies whether Calendar Server filters (recognizes) Private and Time and Date Only (confidential) events and tasks. If "no", Calendar Server treats them the same as Public events and tasks. |
|
defaultcalendar |
"yes" |
Specifies whether a user's default calendar is included in user's free/busy calendar list. |
defaultcalendar |
"no" |
Specifies whether a user's default calendar can be removed from user's free/busy calendar list. |
"0" |
Maximum number of attendees allowed in an LDAP group when expanding an event. Value of "0" means to expand the group entirely. |
|
"60" |
Maximum number of events that can be created by a recurrence expansion. |
|
defaultcalendar |
"yes" |
Specifies whether a user's default calendar is included in the user's subscribed calendar list. |
defaultcalendar |
"no" |
Specifies whether a user's default calendar can be removed from the user's subscribed calendar list. |
"200" |
Maximum number of results returned from LDAP lookup from user search. Value of "0" means no limit. |
|
fmt1.type |
"uid" |
Specifies how Calendar Server treats strings, such as jdoe or jdoe:tv, when performing a directory lookup for attendees of an event. Allowable values are: uid, cn, gid, res, mailto, cap. |
fmt2.type |
"mailto" |
Specifies how Calendar Server treats strings with an at sign (@), such as jdoe@sesta.com, when performing a directory lookup for attendees of an event. Allowable values are: uid, cn, gid, res, mailto, cap. |
fmt3.type |
"cn" |
Specifies how Calendar Server treats strings with a space, such as john doe, when performing a directory lookup for attendees of an event. Allowable values are: uid, cn, gid, res, cap. |
"." |
Location of primary disk partition where calendar information is stored. |
The following table shows the calendar log configuration parameters with each parameter’s default value and description.
Table E–3 Calendar Log Configuration Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"admin.log" |
Name of log file for logging administrative tools. |
|
"0" |
Size of log buffers (in bytes). |
|
"dwp.log" |
Name of log file for logging Database Wire Protocol related administrative tools. |
|
"604800" |
Number of seconds before log files expire. |
|
"60" |
Number of seconds between flushing buffers to log files. |
|
"http.log" |
Name of current log file for the cshttpd service. |
|
"httpd.access" |
Name of current HTTP access log file. |
|
"logs" |
Directory location of log files. |
|
"NOTICE" |
Determines the level of detail the server will log. Each log entry is assigned one of these levels: CRITICAL, ALERT, ERROR, WARNING, NOTICE, INFORMATION, and DEBUG. |
|
"10" |
Maximum number of log files in log directory. |
|
"2097152" |
Maximum size of each log file (in bytes). |
|
"20971520" |
Maximum disk space for all log files (in bytes). |
|
"5242880" |
Minimum free disk space (in bytes) that must be available for logging. |
|
"notify.log" |
Name of log file for the csnotifyd service. |
|
"86400" |
Number of seconds before log files are rotated. |
The following table lists the ics.conf parameters that pertain to administrators.
Table E–4 Configuration Parameters for Administrators
The following table shows the various services configuration parameters with each parameter’s default value and description.
Table E–5 Services Configuration Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"yes" |
Enable ("yes") or disable ("no") alarm notifications for administration tools. |
|
"yes" |
If "yes", start the csadmind database checkpoint thread. |
|
"8388608" |
Maximum cache size (in bytes) for Berkeley Database for administration sessions. |
|
"yes" |
If "yes", start the csadmind database deadlock detection thread. |
|
"no" |
If "yes", start the csadmind low disk space monitor thread. |
|
"yes" |
If "yes", start the csadmind service when starting all services and stop csadmind when stopping all services. |
|
"120" |
Number of seconds before timing out an HTTP connection in csadmind. |
|
"100" |
Maximum number of administration sessions allowed. |
|
"10" |
Maximum number of running threads per administration session. |
|
N/A |
Maximum number of a concurrent administration processes allowed. |
|
service.admin.port **CAUTION** |
N/A |
Set by the system. Do not change. |
"900" |
Number of seconds before timing out an administration connection. |
|
"no" |
If "yes", start the csadmind service response thread. |
|
" " |
Temporary directory for administration session requests. |
|
"1800" |
Number of seconds before timing out an HTTP session in csadmind. |
|
"2" |
Number of seconds to wait between checking for started, stopped, or ready calendar service. |
|
"300" |
Number of seconds to wait for any calendar service to start. |
|
"300" |
Number of seconds to wait for any calendar service to stop. |
|
"60" |
Number of seconds to wait between sending stop commands to any calendar service. |
|
"o=internet" |
Root suffix of the DC tree in the directory. |
|
"no" |
If "yes", client IP addresses are checked against DNS if allowed HTTP access. |
|
"0" |
Number of seconds to delay after successfully authenticating a user using plain text passwords. |
|
"calmaster" |
Space separated list of user ID's with administration rights to this Calendar Server. |
|
"no" |
If "yes", allow login via proxy. |
|
"yes" |
If "yes", allow anonymous (no authentication) access. This is a special type of login that is allowed only specified, restricted access (usually read only access to public calendars). |
|
"" (Null) |
HTTP host for retrieving HTML documents. |
|
"yes" |
Tells the server to whether or to support cookies (yes/no). It must be set to "yes" to enable single sign-on. |
|
"8388608" |
Maximum cache size of Berkeley DB for HTTP sessions. |
|
"" (Null) |
If specified and not "", filter to allow access based on TCP domains. For example, "ALL:LOCAL.sesta.com" would allow local HTTP access to anyone in the sesta.com domain. Multiple filters are separated by CR-LF(line feed). |
|
"" (Null) |
If specified and not " ", filter to not allow access based on TCP domains. For example, "ALL:LOCAL.sesta.com" would deny HTTP access to anyone in the sesta.com domain. Multiple filters must be separated by CR-LF (line-feed). |
|
"." |
Directory location relative to local.queuedir (or an absolute path if specified) where imported files are temporarily stored. |
|
"yes" |
If "yes", all requests that reference an existing session are verified as originating from the same IP address. |
|
"yes" |
If "yes", start the cshttpd service when starting all services and stop cshttpd when stopping all services. |
|
"120" |
Number of seconds before timing out an HTTP connection. |
|
"yes" |
If "yes", LDAP connections for authentication and user preferences are created and maintained. |
|
"INADDR_ANY" |
Specifies the TCP address that HTTP services will listen on for client requests. "INADDR_ANY" indicates any address. |
|
"no" |
If "yes", HTTP connections to server are fully logged. |
|
"5000" |
Maximum number of HTTP sessions in cshttpd service. |
|
"20" |
Maximum number of threads to service HTTP requests in cshttpd service. |
|
"1" |
Maximum number of concurrently running HTTP service (cshttpd) processes that should run on a server. For a server that has multiple CPU's, see Using Load Balancing Across Multiple CPU's |
|
"80" |
Port for HTTP requests from Calendar Server users. |
|
"" |
If specified and not "", filter for allowing proxy login based on TCP domains. Same syntax as service.http.domainallowed. |
|
"900" |
Number of seconds before timing out an HTTP session. |
|
"http" |
Temporary directory for HTTP sessions. |
|
"1800" |
Number of seconds before timing out an HTTP session in cshttpd service. |
|
" " |
Directory relative to executable where all URL references to files are stored. |
|
service.http.tmpdir |
Directory relative to executable where all URL references to files are stored. The default is: "/var/opt/SUNWics5/tmp" |
|
"html" |
Directory that contains the default calendar client. If allowing only WCAP access, set to "". |
|
"no" |
If "yes", use cache in LDAP SDK. |
|
"30" |
If service.ldapmemcache is "yes", pass in this value to the LDAP SDK. This is the maximum number of seconds that an item can be cached. If 0, there is no limit to the amount of time that an item can be cached. |
|
"131072" |
If service.ldapmemcache is "yes", pass in this value to the LDAP SDK. This is the maximum amount of memory in bytes that the cache will consume. If 0, the cache has no size limit. |
|
.allowpubliccalendarwrite |
"yes" |
If "yes", allow anonymous users to write to publicly writable calendars. |
"text/calendar" |
Specifies the default output format for commands currently applied only for freebusy. |
|
"30" |
Specifies the default offset from the current time in days for get_freebusy for beginning of the range. |
|
"30" |
Specifies the default offset from the current time in days for get_freebusy for end of the range. |
|
service.wcap.freebusy.redirecturl |
““ |
For migration purposes, when migration is only partially done and calendars are split between the originating database and the Calendar Server target database. The URL of the originating database to look in if a calendar is not found in the Calendar Server database. |
"yes" |
If "yes", allow calendars to be created. |
|
"yes" |
If "yes", allow calendars to be deleted. |
|
"no" |
If "yes", allow users to change their passwords via this server. |
|
allowpublicwritablecalendars |
"yes" |
If "yes", allow users to have publicly writable calendars. |
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "cn" (LDAP user's common name). |
|
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "givenname" (LDAP user's given name). |
|
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference “icsCalendar" (a user's default calendar identifier). |
|
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "mail" (user's email address). |
|
.preferredlanguage |
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "preferredlanguage" (LDAP user's preferred language). |
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "sn" (LDAP user's surname). |
|
"no" |
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "nswccalid", which is the user's default calendar ID. |
|
"no" |
If "yes", default user calendars are initially set to public read/private write. If no, default user calendars are initially set to private read/private write. |
|
"no" |
If "yes", enables LDAP proxy authorization for get_userprefs.wcap command. If "no", anonymous LDAP search is performed. |
|
"no" |
If "yes", the server must validate that each owner of a calendar exists in the directory (through LDAP or a CSAPI compatible user directory mechanism). |
|
"3.0" |
WCAP version. |
The following table shows the ics.conf SSL Configuration parameters with each parameter’s default value and description. While most of the SSL parameters take the default values, two of the parameters require you to change the value from the system default to the SSL value, as follows:
service.http.ssl.usessl = “yes”
service.http.ssl.port.enable = “yes”
The table that follow shows the ics.conf parameters and their default settings. Verify that your ics.conf parameters have the appropriate values:
Table E–6 Configuration Parameters for SSL
The following table shows the hosted (virtual) domain configuration parameters with each parameter’s default value and description.
Table E–7 Configuration Parameters for Hosted Domain Support
The following table shows the alarm notification server configuration parameters with each parameter’s default value and description.
Table E–8 Alarm Notification Configuration Parameters in the ics.conf File
The following table shows the Calendar Lookup Database (CLD) parameters with each parameter’s default value and description.
Table E–9 Calendar Lookup Database (CLD) Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"n" |
Enable ("y") or disable ("n") calendar lookup plug-ins. |
|
"*" |
Specifies the name of a specific calendar lookup plug-in to load. If this value is an asterisk ("*"), Calendar Server loads all plug-ins. |
|
"local" |
Specifies the type of CLD plug-in to use: "local" specifies that all calendars are stored on the local server where Calendar Server is running and no plug-in is loaded. "directory" specifies the LDAP CLD plug-in, which uses a calendar owner’s icsDWPHost LDAP attribute to determine the server where a specified calendar is stored. |
|
" " |
Specifies the fully qualified default DWP server name used by Calendar Server if a user or resource calendar entry in the LDAP server database does not have an icsDWPHost attribute. If a user who logs into Calendar Server through Communications Express, or using WCAP commands, does not have an icsDWPHost attribute, Calendar Server uses this parameter to auto-provision the attribute. If a user already has an icsDWPHost attribute, caldb.dwp.server.default is not used. This name must be resolvable by your Domain Name Service (DNS) into a valid IP address. |
|
"yes" |
Enables ("yes") or disables ("no") the Calendar Lookup Database (CLD) cache option. For optimum performance for the LDAP CLD plug-in, set to "yes". |
|
"10" |
Specifies the maximum size in megabytes of the checkpoint file. |
|
"4" |
Specifies the size in megabytes of shared memory. |
|
"1000" |
Specifies the maximum number of database threads. |
|
"." |
Specifies the location of database event, task, and alarm files for the CLD cache option. The default value of "." specifies that these files are stored in the /var/opt/SUNWics5/csdb/cld_cache directory. |
|
"60" |
Specifies the number of seconds between checkpoints. |
|
"yes" |
Specifies whether to remove the checkpoint files after they are synchronized for the CLD cache option. |
|
caldb.dwp.server.host-name.ip |
" " |
Specifies the host name of a server that is storing a calendar database. The server must be running the DWP (csdwpd) service. This name must be resolvable by your Domain Name Service (DNS) into a valid IP address. This parameter is used by the LDAP CLD plug-in. Note: In each part of the parameter, host-name must be identical and fully qualified. For example: caldb.dwp.server.sesta.com.ip="sesta.com" |
"1" |
Maximum number of backlogged requests before the server obtains a new network connection. |
|
"2" |
Initial number of connections for the Database Wire Protocol service client to make to each Database Wire Protocol service host. |
|
"2" |
Initial number of threads for handling Database Wire Protocol service requests. |
|
"1000" |
Maximum number of connections allowed to a server using the Database Wire Protocol service. |
|
"20" |
Maximum number of threads allowed to a server using the Database Wire Protocol service. |
|
"n" |
Specifies if the server performs MD5 (Message Digest 5) one-way hash checking of all Database Wire Protocol service requests. (One-way hash functions are used to create digital signatures for message authentication.)
|
|
" " |
Specifies the IP address of the server using the Database Wire Protocol (DWP) service at the specified machine’s hostname. |
|
"9779" |
Specifies the port number of the server using the Database Wire Protocol (DWP) service at the specified machine’s hostname. |
|
" " |
On a front-end server, specifies the user ID that is used for authentication for a DWP connection to a back-end server, where back-end-server is the name of the server. |
|
" " |
On a front-end server, specifies the password that is used for authentication for a DWP connection to a back-end server, where back-end-server is the name of the server. |
|
"65536" |
Stack size for Database Wire Protocol service threads. |
|
Base DN to authenticate against if LDAP plug-in is used for the calendar locate mechanism. |
||
Host name of the LDAP server to access if an LDAP plug-in is used for the calendar locate mechanism. |
||
Bind credentials (password) for the user specified in the setting local.authldapbinddn if an LDAP plug-in is used for the calendar locate mechanism. |
||
DN used to bind to for authentication to search for user's DN if an LDAP plug-in is used for the calendar locate mechanism. |
||
"389" |
Port number of the LDAP server to access if an LDAP plug-in is used for the calendar locate mechanism. |
|
"n" |
If "y", load only the plug-in specified in csapi.plugin.authentication.name or if not specified, load all authentication class plug-ins in alphabetical order. For authentication, use each of these plug-ins in alphabetical order. |
|
" " |
If csapi.plugin.loadall is "n" and csapi.plugin.authentication is "y", only load this specific plug-in. If not specified or blank (" "), load all authentication class plug-ins. |
|
"0" |
Size of Database Wire Protocol service log buffers (in bytes). |
|
"604800" |
Number of seconds before the Database Wire Protocol service log files expire. |
|
"60" |
Number of seconds between flushing buffers to the Database Wire Protocol service log files. |
|
"logs" |
Directory location of the Database Wire Protocol service log files. |
|
"Notice" |
Determines the level of detail the server will log for the Database Wire Protocol service. Each Database Wire Protocol log entry is assigned one of the following levels (starting with the most severe): Critical, Error, Warning, Notice, Information, and Debug. If you set this preference to Critical, the server will log the least amount of detail. If you want the server to log the most amount of detail, specify Debug. For example, if you specify Warning, only Critical, Error, and Warning level log entries are logged. |
|
"10" |
Maximum number of Database Wire Protocol related log files in log directory. |
|
"2097152" |
Maximum size of each Database Wire Protocol log file (in bytes). |
|
"20971520" |
Maximum disk space for all Database Wire Protocol log files (in bytes). |
|
"5242880" |
Minimum free disk space that must be available for logging Database Wire Protocol service activity (in bytes). When this value is reached, the server will attempt to free disk space by expiring old log files. All logging will be paused if no space can be freed up. |
|
"86400" |
Number of seconds before Database Wire Protocol service log files are rotated. |
|
" " |
On a back-end server, specifies the user ID that is used to authenticate a DWP connection. This parameter is optional. If a back-end server does not specify a user ID, no authentication is performed. |
|
" " |
On a back-end server, specifies the password that is used to authenticate a DWP connection. This parameter is optional. If a back-end server does not specify a password, no authentication is performed. |
|
"localhost" |
The hostname of the machine on which the Database Wire Protocol service is running. |
|
"1000" |
Maximum number of concurrently running Database Wire Protocol service threads. |
|
"1" |
Maximum number of concurrently running Database Wire Protocol (DWP) service (csdwpd) processes that should run on a server. For a server that has multiple CPUs, see Using Load Balancing Across Multiple CPU's |
|
"no" |
If "yes", start the csdwpd service when starting all services and stop csdwpd when stopping all services |
|
"86400" |
Amount of time (in seconds) before closing the Database Wire Protocol service persistent connections that are idle. |
|
"59779" |
Port number that the Database Wire Protocol service listens to. This value is the default port for the LDAP CLD plug-in. |
|
"yes" |
Enable ("yes") or disable ("no") LDAP for remote user authentication for the Database Wire Protocol (csdwpd) service. |
|
service.calendarsearch.ldap |
"yes" |
Specifies whether Calendar Server searches the LDAP directory and then the calendar database ("yes") or only the calendar database ("no"). |
The following table describes the configuration parameters in the ics.conf file for the LDAP data cache.
Table E–10 LDAP Data Cache Configuration Parameters
Parameter |
Description |
---|---|
local.ldap.cache.enable |
Enables (“yes”) or disables (“no”) the LDAP data cache. The default is “no”. |
local.ldap.cache.checkpointinterval |
Specifies the number of seconds for the checkpoint thread to sleep. The default time is “60” seconds. |
local.ldap.cache.circularlogging |
Specifies whether or not to remove the old cache files. The default is “yes”. |
local.ldap.cache.homedir.path |
Specifies the physical location of LDAP data cache database. The default is /var/opt/SUNWics5/csdb/ldap_cache. |
local.ldap.cache.logfilesizemb |
Specifies the maximum size in megabytes of the checkpoint file. The default is “10” megabytes. |
local.ldap.cache.maxthreads |
Specifies the maximum number of threads for the LDAP data cache database. The default is “1000”. |
local.ldap.cache.mempoolsizemb |
Specifies the number of megabytes of shared memory. The default is “4” megabytes. |
local.ldap.cache.entryttl |
Specifies the time to live (TTL) in seconds for an LDAP data cache entry. The default is “3600” seconds (1 hour). |
local.ldap.cache.stat.enable |
Specifies whether or not to log access to the LDAP data cache and to print statistics in the log file. The default is “no”. Note This parameter applies only to debug mode. |
local.ldap.cache.stat.interval |
Specifies the interval in seconds when each statistics report is written to the log file. The default is “1800” seconds (30 minutes). |
local.ldap.cache.cleanup.interval |
Specifies the interval in seconds between each database cleanup. The default is “1800” seconds (30 minutes). |
To configure resource calendars, use the parameters found in The following table:
Table E–11 Configuration Parameters for Resource Calendars
The following table shows the SSO configuration parameters with each parameter’s default value and description when you are using Access Manager.
Table E–12 SSO Configuration Parameters in the ics.conf File (Through Access Manager)
The following table shows the SSO configuration parameters with each parameter’s default value and description when the Communications Servers trusted circle technology.
Table E–13 SSO Configuration Parameters in the ics.conf File Using Communications Servers Trusted Circle Technology
The following table shows the Group Scheduling Engine (GSE) configuration parameters with each parameter’s default value and description.
Table E–14 Group Scheduling Engine (GSE) Configuration Parameters in the ics.conf File
The following table lists the ics.conf parameters used to configure database handling, and gives each parameter’s default value and description.
Table E–15 Database Configuration Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"60" |
Number of seconds between checkpointing database transactions. |
|
"yes" |
If "yes" remove database checkpoint files after their transactions are synchronized. Do not set this to “no” unless you have enabled automatic backups. |
|
"100" |
Number of milliseconds between checking for database deadlocks that need to be broken. |
|
"." |
Directory (relative to the location of the program executable files or an absolute path if specified) where database event, task, and alarm files are stored. The default is “.”, which specifies: /var/opt/SUNWics5/csdb |
|
"10" |
Maximum megabytes for a database checkpoint file. |
|
"10000" |
Maximum number of threads that database environment must be prepared to accommodate. |
|
"4" |
Megabytes of shared memory for database environment. |
|
" " |
Email for user or alias that is responsible for administering the database. |
|
"yes" |
If "yes", data base statistics (reads, writes, deletes) will be counted. |
|
"100" |
Maximum number of calendars that can have counters. A calendar is enabled for counters using the cscal command line utility. |
|
"en" |
Specifies the directory under /etc/opt/SUNWics5/config that contains the localized version of the files used to format email notifications. For example, "en" specifies the directory for the English localized version, and "fr" specifies the directory for the French localized version. |
|
"25" |
Port for SMTP host. |
The following table lists the parameters used by the automatic backup process (csstored), gives the default value where available, and describes the ics.conf parameter.
Table E–16 ics.conf Parameters Used by the Automatic Backup Process
Parameter |
Default Value |
Description |
---|---|---|
defaultstore.log |
Name of the log file. |
|
"." |
Path to the log directory. |
|
caldb.berkeleydb.homedir.path |
none |
Path to live database. |
caldb.berkeleydb.archive.path |
none |
Path to the archive backup. |
caldb.berkeleydb.hotbackup.path |
none |
Path to the hot backup. |
caldb.berkeleydb.archive.enable |
"yes" |
Enable/disable automatic archive backups. |
caldb.berkeleydb.hotbackup.enable |
"yes" |
Enable/disable automatic hot backups. |
caldb.berkeleydb.hotbackup.mindays |
"3" |
Minimum number of hot backup copies kept on disk. |
caldb.berkeleydb.hotbackup. maxdays |
"7" |
Maximum number of hot backup copies kept on disk. |
caldb.berkeleydb.hotbackup. threshold |
"70" |
Percentage of used disk space that triggers purging of old hot backup copies. |
caldb.berkeleydb.archive.mindays |
"3" |
Minimum number of archive backup copies kept on disk. |
caldb.berkeleydb.archive.maxdays |
"7" |
Maximum number of archive backup copies kept on disk. |
caldb.berkeleydb.archive.threshold |
"70" |
Percentage of used disk space that triggers purging of old archive backup copies. |
caldb.berkeleydb.circularlogging |
"yes" |
Enables/disables management of the number of, and disk space occupied by, backup copies. |
caldb.berkeleydb.archive.interval |
"120" |
Time in seconds between opening of new transaction logs. |
alarm.msgalarmnoticercpt |
"root@ localhost" |
Email address of the administrator to notify when necessary. |
service.store.enable (not included in ics.conf file) |
"yes" |
Enables csstored to be started by start-cal. Must be added to the ics.conf file, set to "no", if you want to disable csstored from being started by start-cal. |
The following table describes the parameter, default value, and description for each of the parameters used to configure the calendar database. If you require a value other than the default, you must set it in the ics.conf file.
Table E–17 Calendar Database Parameters for ENS Messages
Parameter |
Default Value |
Description |
---|---|---|
"enp:///ics/alarm" |
Specifies the URL for the ENS message. |
|
"" |
Specifies the content type of the alarm data. Value can be "text/xml" or "text/calendar". |
|
"no" |
Creates an ENS message when a calendar is created. |
|
"enp:///ics/calendarcreate" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when a calendar is deleted. |
|
"enp:///ics/calendardelete" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when a calendar is modified. |
|
"enp:///ics/calendarmodify" |
URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when an event is created. |
|
"enp:///ics/caleventcreate" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when an event is modified. |
|
"enp:///ics/caleventmodify" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when an event is deleted. |
|
"enp:///ics/caleventdelete" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or"text/calendar". |
|
"no" |
Creates an ENS message when a todo is created. |
|
"enp:///ics/caltodocreate" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when a todo is modified. |
|
"enp:///ics/caltodomodify" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
|
"no" |
Creates an ENS message when a todo is deleted. |
|
"enp:///ics/caltododelete" |
Specifies the URL for the ENS message. |
|
"text/xml" |
Specifies the content type of the message data: "text/xml" (default) or "text/calendar". |
Calendar Server, when configured to do so, uses an external generic service called the Event Notification Server (ENS), which accepts reports of server-level events that can be categorized into specific areas of interest and notifies other servers that have registered interest in certain categories of events. Calendar Server uses ENS to send and receive alarm notifications that include the creation, deletion, or modification of calendar events and tasks as well as general operational warning and error messages.
The following table shows the Event Notification Server (ENS) configuration parameters in ics.conf. with each parameter’s default value and description.
Table E–18 Event Notification Server (ENS) Configuration Parameters in the ics.conf File
The following table shows the Calendar Server API (CSAPI) configuration parameters with each parameter’s default value and description.
Table E–19 CSAPI Configuration Parameters in the ics.conf File
The following table shows the csmonitor utility configuration parameters with each parameter’s default value and description.
Table E–20 csmonitor Utility Configuration Parameters in the ics.conf File
Parameter |
Default Value |
Description |
---|---|---|
"0" |
Specifies whether csmonitor should loop continuously: "0"–Do not loop continuously. "1"–Loop continuously. This option requires more system resources, but it can useful in debug mode. |
|
"60" |
Specifies the delay in seconds between two monitoring loops. |
|
none |
Specifies the email address csmonitor sends messages from. |
|
none |
Specifies the email address csmonitor should send messages to. |
|
service.monitor.csdb.logthreshold |
"90" |
Specifies a threshold value in percent of the total disk space for the maximum disk occupation considered to be normal. If the disk occupation where the calendar database (csdb directory) resides exceeds this value, csmonitor sends a warning email message. |
"csmonitor.log" |
Specifies the csmonitor log file name. |
|
"2097152" |
Specifies the maximum log file size. If the log file exceeds this size, csmonitor saves the log as csmonitor.log.timestamp and resets the log. |
|
"0" |
Specifies the debug level. The higher this value, csmonitor sends more precise and verbose messages. |
Calendar Server counters (statistics) configuration parameters are in the following file:
/etc/opt/SUNWics5/config/counter.conf
The counter.conf file is an ASCII text file, with each line defining a counter and its parameters: name, type, size (in bytes), and description. A parameter with spaces must be enclosed in double quotation marks (" "). A comment line must begin with an exclamation point (!). Comment lines are for informational purposes only.
The first part of a counter's name identifies the counter object used with the csstats utility. For more information about the command-line utilities, see Appendix D, Calendar Server Command-Line Utilities Reference.
Do not modify the counter.conf file unless instructed to do so by customer support staff.
This section describes the Calendar Server counter.conf parameters, including:
The following table shows each alarm counter’s name, type, size, and description.
Table E–21 Alarm Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
GAUGE |
4 |
Highest ever recorded value. |
|
GAUGE |
4 |
Lowest ever recorded value. |
|
GAUGE |
4 |
Current monitored valued. |
|
GAUGE |
4 |
Warning state: yes (1) or no (0). |
|
COUNTER |
4 |
Number of times crossing threshold. |
|
COUNTER |
4 |
Number of warnings sent. |
|
TIME |
4 |
Last time current value was set. |
|
TIME |
4 |
Last time warning was sent. |
|
TIME |
4 |
Last time reset was performed. |
|
TIME |
4 |
Last time alarm state changed. |
The following table shows each disk usage counter’s name, type, size, and description.
Table E–22 Disk Usage Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
GAUGE |
5 |
Total space available in the disk partition. |
|
TIME |
4 |
The last time statistic was taken. |
|
STRING |
512 |
Calendar partition path. |
|
GAUGE |
4 |
Disk partition space available percentage. |
|
GAUGE |
5 |
Total space in the disk partition. |
The following table shows each HTTP counter’s name, type, size, and description.
Table E–23 HTTP (httpstat) Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
GAUGE |
4 |
Average connection response time. |
|
TIME |
4 |
When Calendar Server was started. |
|
TIME |
4 |
Last time new client connection was accepted. |
|
COUNTER |
4 |
Maximum number of concurrent connections served. |
|
COUNTER |
4 |
Maximum number of WCAP sessions served. |
|
COUNTER |
4 |
Total number of connections served. |
|
GAUGE |
4 |
Current number of active connections. |
|
GAUGE |
4 |
Current number of WCAP sessions. |
|
COUNTER |
4 |
Total number of failed connections served. |
|
COUNTER |
4 |
Number of successful logins served by the current HTTP server. |
|
COUNTER |
4 |
Number of failed logins served by the current HTTP server. |
The following table shows each Group Scheduling Engine (GSE) counter’s name, type, size, and description.
Table E–24 Group Scheduling Engine (GSE) Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
TIME |
4 |
Last time GSE wakes up and process job. |
|
TIME |
4 |
Last time GSE processes a job. |
|
COUNTER |
4 |
Total number of jobs GSE processed. |
|
COUNTER |
4 |
Total number of active Worker Threads. |
The following table shows each Authentication counter’s name, type, size, and description.
Table E–25 Authentication (authstat) Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
TIME |
4 |
Last time a user logged in. |
|
COUNTER |
4 |
Total number of successful logins served. |
|
COUNTER |
4 |
Total number of failed logins served. |
The following table shows each WCAP counter’s name, type, size, and description.
Table E–26 WCAP (wcapstat) Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
COUNTER |
4 |
Total number of WCAP requests. |
The following table shows each Database counter’s name, type, size, and description.
Table E–27 Database (dbstat) Counters in the counter.conf File
Name |
Type |
Size |
Description |
---|---|---|---|
COUNTER |
4 |
Total number of database reads. |
|
COUNTER |
4 |
Total number of database writes. |
|
COUNTER |
4 |
Total number of database deletes. |
|
TIME |
4 |
Last time of database read. |
|
TIME |
4 |
Last time of database write. |
|
TIME |
4 |
Last time of database delete. |
The following table shows each Server Response counter’s name, type, size, and description.
Table E–28 Server Response Counters in the counter.conf File
Name |
Type |
Size |
Scale |
Description |
---|---|---|---|---|
TIME |
4 |
Last time statistic was taken. |
||
GAUGE |
4 |
2 |
Server response time in milliseconds. |
The following table shows each Session Status counter’s name, type, size, and description.
Table E–29 Sessions Status Counters in the counter.conf File
Name |
Type |
Size |
Scale |
Description |
---|---|---|---|---|
COUNTER |
4 |
4 |
Maximum number of HTTP sessions served. |
|
GAUGE |
4 |
2 |
Current number of HTTP sessions. |
Calendar Server sends the types of email messages described in Calendar Server Mail Parameters. The format of these messages is controlled by the associated format (.fmt) file listed in the table. Format files are located in specific directories for each locale (such as /en for English and /fr for French) in the following directory:
/etc/opt/SUNWics5/config
For example, the English version of the task (todo) alarm message format is specified in the file:
/etc/opt/SUNWics5/config/en/mail_todoalarm.fmt
This section describes:
The following table shows the message type, parameter name, default format file description, and recipient for each Calendar Server Mail parameter.
Table E–30 Calendar Server Email Formats in the ics.conf File
Message Type |
Parameter |
Format File (default) |
Description |
Recipients |
---|---|---|---|---|
Event Publish |
Announces an event or a change to an existing event |
Those listed in Notification |
||
Event Cancel |
Announces an event cancellation |
Those listed in Notification |
||
Reply to Event |
"mail_eventreply.fmt" |
Replies to an event notification. |
Those listed in Notification |
|
Request Event |
"mail_eventrequest.fmt" |
Subscribes to an event notification. |
Those listed in Notification |
|
Event Alarm |
Reminder for an upcoming event |
Those listed in Reminder |
||
Recurring Event Notification |
“mail_eventnotificationrecur.fmt” |
Notifies of a recurring event |
Those listed in Notification |
|
Event Cancel Notification |
“mail_eventcancel notification.fmt” |
Notifies of a cancelled event |
Those listed in Notification |
|
Recurring Event Cancel Notification |
“mail_eventcancelnotificationrecur.fmt” |
Notifies of a cancelled recurring event |
Those listed in Notification |
|
Task Publish |
Announces a task or a change to an existing task |
Those listed in Notification |
||
Task Cancel |
Announces a task cancellation |
Those listed in Notification |
||
Reply to Task |
"mail_todoreply.fmt" |
Replies to a task notification |
Those listed in Notification |
|
Todo Request |
"mail_todorequest.fmt" |
Subscribes to a todo notification. |
Those listed in Notification |
|
Task Alarm |
Reminder for an upcoming task |
Those listed in Reminder |
Calendar Server generates notification messages by combining a particular event or task with the contents of a format file. The values of data fields within an event or task can be output to the message. The notification message can also include MIME header lines and associated special values. Using special character sequences (format notations), you can include the values of events, tasks, and MIME headers in the message. The lines in the format file are format strings comprised of special character sequences that are replaced with actual values from calendar data fields when the mail message is generated. Special character sequences consist of two characters, the first is the percent sign (%) and the second represents the specific format notation.
The following sections describe special character sequences:
The following table shows the format code and meaning for Special Character Sequences for Event Notifications.
Table E–31 Special Character Sequences for Event Notifications
Format Code |
Meaning |
---|---|
%0 |
Start time in localized format |
%1 |
End time in localized format |
%A |
exdates in iCalendar format (semicolon-separated list of ISO 8601 date strings listing dates to exclude) |
%a |
rdates in iCalendar format (semicolon-separated list of ISO 8601 date strings listing recurrence dates) |
%B |
Start time (also see %Z) |
%b |
Output the start time and end time in iCalendar format. If the start time has the parameter value=date, only the month/day/year portion of the date is output. If end time has the same month/day/year value as the start time, only the start time is generated. |
%C |
Create time |
%c |
Event class |
%d |
Event description. (also see %F) |
%E |
End time (also see %Z) |
%e |
Exception rules in iCalendar format |
%F |
Event description - folded line / iCalendar format (also see %d) |
%G |
The event's geographic location (latitude and longitude) |
%g |
Organizer's email address. (There is no guarantee as to the authenticity of this value.) |
%K |
Organizer email in the form of a mailto:url |
%k |
Alarm count |
%L |
Location |
%l |
Recurrence rules in iCalendar format |
%M |
Modify time |
%N |
New line |
%n |
The current time stamp used with DTSTAMP |
%P |
Priority |
%r |
Recurrence id (blank if this event does not recur) |
%S |
Event sequence number |
%s |
Summary |
%t |
Event status |
%U |
Unique Event Identifier |
%Z |
Used in conjunction with the time field code to force the time to be rendered in UTC. (%B displays the start time in local time whereas %ZB displays the start time in UTC time.) |
%% |
Displays the percent (%) character |
% (sub-format code) |
Specifies a sub-format for the data identified by code. (For details, see Date Sub-Formatting.) |
Date-time values can be formatted in many different ways. Using a sub-format, you can provide additional information to describe how a date-time value should be formatted. If a sub-format is not specified, the server uses a default format to output the date. Using a sub-format field allows you to specify the exact format to be used.
For example, %B specifies that the output string includes the event's begin time. This default format prints out the date, time, the time zone, and everything possible about the date. The sub-format string for date values is a strftime format string (see Special Character Sequences for Dates). If you were only interested in the month and year of the start time, instead of %B, you would use: %(%m %Y)B.
The following example:
The event begins: %B%N The event ends: %(%b %d, %Y %I:%M %p)E%N |
produces output that resembles the following notification:
The event begins Feb 02, 1999 23:30:00 GMT Standard Time The event ends Feb 03, 1999 02:30 AM |
Sometimes it is desirable to print a line only under certain conditions. For example, the following lines:
title: %S%N start: %B%N end: %E%N |
produce output that resembles the following notification:
title: Staff Meeting start: Feb 04, 1999 09:00:00 end: Feb 04, 1999 10:00:00 |
There are two conditions, however, where the above example would yield misleading or incorrect results:
If the event has no end time
If the event is an “all-day” event that starts and ends on the same day
In these situations, it is best not to print the end time at all. By default, only the year, month, and day are printed when a time stamp has the attribute of being all-day. Furthermore, if an event start time has the all-day attribute and the event ends on the same day as it starts, a special conditional flag is set. Use the ? modifier to print conditional values only when the special conditional flag is not set.
For example, if you change the lines in the above example to:
title: %S%N start: %B%N end: %?E%N |
The last line will not be printed for all-day events for which the start day and end day are the same. It produces the following output for typical all-day events (such as birthdays or anniversaries):
title: Staff Meeting start: Feb 04, 1999 |
The ? flag can be combined with other modifiers. For example:
The event ends: %?(%b %d, %Y %I:%M %p)E%N
The following table shows the format code and meaning for Special Character Sequences for Task Notifications.
Table E–32 Special Character Sequences for Task Notifications
Format Code |
Meaning |
---|---|
%A |
exdates in iCalendar format (semicolon-separated list of ISO 8601 date strings listing dates to exclude) |
%a |
rdates in iCalendar format (semicolon-separated list of ISO 8601 date strings listing recurrence dates) |
%B |
start time (also see %Z) |
%C |
create time |
%c |
task class |
%D |
due date and time. |
%d |
task description. (also see %F) |
%E |
due date and time in IMIP format |
%e |
exception rules in iCalendar format |
%F |
task description - folded line, iCalendar format (also see %d) |
%G |
this task's geographic location, the latitude and longitude. |
%g |
organizer's email address (cannot guarantee the authenticity of this value) |
%K |
organizer’s email in the form of a mailto:URL |
%k |
alarm count |
%L |
the location |
%l |
recurrence rules in iCalendar format |
%M |
modify time |
%N |
a new line |
%n |
"now" (the current time stamp and used with DTSTAMP) |
%P |
priority |
%r |
the recurrence ID (blank if this task does not recur) |
%S |
is the task’s Sequence Number |
%s |
summary |
%t |
the status |
%U |
the UID |
%Z |
used in conjunction with time field code to force the time to be rendered in UTC (%Bdisplays the start time in local time whereas %ZB displays the start time in UTC time) |
%% |
displays the % character |
% (sub-format code) |
specify a sub-format for the data identified by code (for details, see Date Sub-Formatting) |
The following table shows the format code and meaning for Special Character Sequences for dates.
The special date format codes appear in this section only for convenience. Calendar Server does not rewrite any of the codes, but simply uses the operating system implementation.
Format Code |
Meaning |
---|---|
%a |
Abbreviated weekday name |
%A |
Full weekday name |
%b |
Abbreviated month name |
%B |
Full month name |
%c |
Date and time representation appropriate for locale |
%d |
Day of month as decimal number (01 - 31) |
%H |
Hour in 24 hour format (00 - 23) |
%I |
Hour in 12 hour format (01 - 12) |
%j |
Day of year as decimal number (001 - 366) |
%m |
Month as decimal number (01 - 12) |
%M |
Minute as decimal number (00 - 59) |
%p |
Current locale's A.M./P.M. indicator for 12 hour clock |
%S |
Second as decimal number (00 - 59) |
%U |
Week of year as decimal number, with Sunday as first day of week (00 - 53) |
%w |
Weekday as decimal number (0 - 6; Sunday is 0) |
%W |
Week of year as decimal number, with Monday as first day of week (00 - 53) |
%x |
Date representation for current locale |
%X |
Time representation for current locale |
%y |
Year without century, as decimal number (00 - 99) |
%Y |
Year with century, as decimal number |
%Z |
Time-zone name or abbreviation; no characters if time zone is unknown |
%% |
Percent sign |
The following example shows the default event reminder message format:
1 EVENT REMINDER 2 ~~MIME-Version: 1.0%N 3 ~~Content-Type: text/plain; charset=%s%N 4 ~~Content-Transfer-Encoding: %x%N%N 5 Summary: %s%N 6 Start: %(%a, %d %b %Y %I:%M %p)B%N 7 End: (%a, %d %b %Y %I:%M %p)E%N 8 Location: %L%N%N 9 Description: %N%d%N |
The description of each line in this example is:
Line 1 is the message subject.
Line 2 begins with ~~, which indicates that it is a MIME wrapper line. That is, the replacement of special character sequences are those associated with an internal MIME object rather than an event or task. The special sequence %N is a line feed. The subject line does not need the special new line sequence, while all other lines do.
Line 3 is also a MIME header line. It contains the special character sequence %s, which will be replaced by the character set associated with the event or task being mailed.
Line 4 is the last MIME line, %x is the content transfer encoding string needed for this message.
Line 5 lists the event summary and calls out the event summary with %s.
Line 6 lists the event start time. It makes use of a sub-format string on the special character sequence %B. For details, see Date Sub-Formatting.
Line 7 lists the event end time.
Line 8 lists the location of the event.
Line 9 lists the description of the event.
The following sample resembles the notification message generated by the above example:
From: jsmith@sesta.com (James Smith) Date: Wed, 15 Nov 1999 19:13:49 To: jsmith@sesta.com Subject: EVENT REMINDER MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Summary: smtp_rig event 1 Start: Tues, 16 Nov 1999 02:00 PM End: Tues, 16 Nov 1999 03:00 PM Location: Green Conference Room Description: This is the description for a randomly generated event. |
The following example shows a more complex multipart message. This example has a text part and an IMIP PUBLISH part.
EVENT PUBLICATION ~~MIME-Version: 1.0%N ~~Content-Type: multipart/mixed; boundary="%b"%N%N This is a multi-part message in MIME format.%N ~~--%b%N ~~Content-Type: text/plain; charset=%s%N ~~Content-Transfer-Encoding: %x%N%N Summary: %s%N Start: %(%a, %d %b %Y %I:%M %p)B%N End: %(%a, %d %b %Y %I:%M %p)E%N Location: %L%N%N Description: %N%d%N%N ~~--%b%N ~~Content-Type: text/calendar; method=%m; component=%c; charset=%s%N ~~Content-Transfer-Encoding: %x%N%N BEGIN:VCALENDAR%N PRODID:-//iPlanet/Calendar Hosting Server//EN%N METHOD:PUBLISH%N VERSION:2.0%N BEGIN:VEVENT%N ORGANIZER:%K%N DTSTAMP:%Zn%N DTSTART:%ZB%N DTEND:%ZE%N SUMMARY:%s%N UID:%U%N %R %A %a %e %l SEQUENCE:%S%N LOCATION:%L%N GEO:%G%N %F STATUS:%t%N END:VEVENT%N END:VCALENDAR%N ~~--%b-- |