This part contains the appendixes for the Administration Guide.
This worksheet helps you collect the information you will be asked for when running comm_dssetup.pl. The first column shows you the silent mode options and the expected information that is to follow it. The second column shows you the same option in interactive mode with the default answer.
There is a line provided in the right column for the answer you want to give. It applies to both the silent and interactive modes. For silent mode, use the answers as the value that follows the option. For interactive mode, enter your value at the prompt.
For examples and instructions on how to run comm_dssetup.pl, see Running the Directory Preparation Script.
Table A–1 Directory Server Setup Script (comm_dssetup.pl) Worksheet
This appendix contains the following worksheets to help you keep track of the information you need to run the Calendar Server configuration program, which is described in Chapter 3, Calendar Server Configuration Program (csconfigurator.sh)
Option |
Description |
---|---|
LDAP Server Host Name |
Host name of the LDAP directory server you are using for user authentication. Default: current host. Your value: |
LDAP Server Port |
Port number that the LDAP server listens on. Default: 389. Your value: |
Base DN |
Entry in the LDAP directory used as the starting point from which searches will occur. Default: o=host.com. Your value: |
Directory Manager DN |
User name that can make changes in the directory server schema. Default: cn=Directory Manager. Your value: |
Directory Manager Password |
Password of the Directory Manager DN. Default: None Your value: |
Administrator User ID |
User ID of the Calendar Server Administrator. This user must be a user in the above LDAP directory server. Default: calmaster. Your value: |
Administrator Password |
Password of the Calendar Server Administrator. Default: None Your value: |
Option |
Description |
---|---|
Email Alarms |
Specifies whether Calendar Server should send an email alarm message to a Calendar Server administrator in case a server problem occurs. Default: Enabled. Your value: |
Administrator Email Address |
Email address of the Calendar Server Administrator who will receive the email alarm messages. Default: None. Your value: |
SMTP Host Name |
Host name of the SMTP server where email alarm messages should be sent. Default: Current host. Your value: |
Option |
Description |
---|---|
Service Port |
Port number that Calendar Server listens on to provide Web (HTTP) access to users. Default: 80. Your value: |
Maximum Sessions |
Maximum number of Calendar Server sessions. Default: 5000. Your value: |
Maximum Threads |
Maximum number of Calendar Server threads. Default: 20. Your value: |
Number of Server Processes |
Maximum number of Calendar Server processes. Default: Number of CPU's on the server where you are installing Calendar Server. Your value: |
Runtime User ID |
UNIX user name under which Calendar Server will run. Default: icsuser. Your value: |
Runtime Group ID |
UNIX group under which Calendar Server will run. Default: icsgroup. Your value: |
Calendar Server Startup |
Start after successful installation. Default: Checked. Your value: Start on system startup. Default: Checked. Your value: |
Option |
Description |
---|---|
Database Directory |
Directory where Calendar Server should create and store the calendar database files. Default: /var/opt/SUNWics5/csdb Your value: |
Logs Directory |
Directory where Calendar Server writes log files. Default: /var/opt/SUNWics5/logs Your value: |
Temporary Files Directory |
Directory where the Calendar Server writes temporary files. Default: /var/opt/SUNWics5/tmp Your value: |
To plan a high availability (HA) configuration for Calendar Server, use the following worksheets:
If you are viewing the HTML version of these worksheets and you want to print them, consider printing the PDF version for better control of page breaks.
Component |
Value and Comments |
---|---|
File system mount point |
For example: /global/cal Your value: |
Logical Host Name |
For example: cal-logical-host Your value: |
Logical Host Name IP Address |
Your value: |
Nodes in the Cluster |
For example: cal-node-1 and cal-node-2 Your value: |
Calendar Resource Group Name |
For example: cal-resource-group Your value: |
Calendar Server Storage Resource |
For example: cal-resource-group-store Your value: |
Calendar Server Resource |
For example: cal-resource Your value: |
The following table lists the values you set when you install Calendar Server using the Sun Java Enterprise System installer.
Table C–2 Calendar Server Installation Worksheet
Component |
Description and Comments |
---|---|
Calendar Server Installation Directory |
Default value: opt/ For example: /global/cal/opt/r Your value: |
The following table lists the values you set when you run the Calendar Server configuration program (csconfigurator.sh).
Table C–3 Calendar Server Configuration Worksheet
Component |
Description and Comments |
---|---|
LDAP Server Host Name |
For example: ldaphost.sesta.com Your value: |
LDAP Server Port |
Port number that the LDAP server listens on. Default: 389. Your value: |
Directory Manager DN |
User name that can make changes in the directory server schema. Default: cn=Directory Manager. Your value: |
Directory Manager Password |
Password of the Directory Manager DN. Default: None Your value: |
Administrator User ID |
User ID of the Calendar Server administrator. This user must be a user in the above LDAP directory server. Default: calmaster. Your value: |
Administrator Password |
Password of the Calendar Server administrator. Default: None Your value: |
Email Alarms |
Specifies whether Calendar Server should send an email alarm message to a Calendar Server administrator in case a server problem occurs. Default: Enabled. Your value: |
Administrator Email Address |
Email address of the Calendar Server administrator who will receive the email alarm messages. Default: None. Your value: |
SMTP Host Name |
Host name of the SMTP server where email alarm messages should be sent. Default: Current host. Your value: |
Service Port |
Port number that Calendar Server listens on to provide Web (HTTP) access to users. Default: 80. Your value: |
Maximum Sessions |
Maximum number of Calendar Server sessions. Default: 5000. Your value: |
Maximum Threads |
Maximum number of Calendar Server threads. Default: 20. Your value: |
Number of Server Processes |
Maximum number of Calendar Server processes. Default: Number of CPU's on the server where you are installing Calendar Server. Your value: |
Runtime User ID |
Default value: icsuser For an HA configuration, add to /etc/passwd on all nodes in the cluster. Your value: |
Runtime Group ID |
Default value: icsgroup For an HA configuration, add to /etc/group on all nodes in the cluster. Your value: |
Calendar Server Startup |
Start after successful installation. Default: Checked. Your value: For an HA configuration, do not check this option. Start on system startup. Default: Checked. Your value: For an HA configuration, do not check this option. |
Database Directory |
Default: var/opt/SUNWics5/csdb For example: /global/cal/var/opt/SUNWics5/csdb Your value: |
Logs Directory |
Default: var/opt/SUNWics5/logs For example: /global/cal/var/opt/SUNWics5/logs Your value |
Temporary Files Directory |
Default: var/opt/SUNWics5/tmp For example: /global/cal/var/opt/SUNWics5/tmp Your value: |
For a short description of each utility, see Short Description of Command-Line Utilities.
Calendar Server provides command-line utilities not included in the Delegated Administrator bundled with Access Manager.
These Calendar Server utilities can be invoked from batch, shell, and scripting programs such as Perl. Some of these utilities (csuser, csresource and csdomain) have been superseded by the Delegated Administrator utility, but the rest are still used, even in a Schema 2 environment. For Schema 1, you must continue to use csuser, csresource and csdomain, and not use Delegated Administrator.
If needed, these utilities use default values from the ics.conf configuration file.
The command-line utilities are located in the following directory: cal_svr_base/SUNWics5/cal/sbin
All of the utilities must be started from the sbin directory, with the exception of start-cal and stop-cal which can be run from any directory, if the full path is specified.
Error messages from these administrative tools are written to the admin.log file found in the csdb directory.
This chapter provides the following information:
Run the command-line utilities while logged in as the user and group where Calendar Server is running, or as root. This was specified during installation; the defaults are icsuser and icsgroup.
For example, if your Calendar Server base directory is cal_svr_base, to run the cscal utility list command, you would do the following after logging in:
cd cal_svr_base/SUNWics5/cal/sbin ./cscal list
Calendar Server command-line utilities use the following syntax:
utility [ -option [value]] command [target]
where:
utility is the executable name of the utility, such as cscal or csuser.
option determines which action the command performs. Options are in lowercase and preceded by a hyphen (-), such as -d. An option enclosed in brackets ([]) is optional. If indicated, of two or more options can be used at the same time.
value further qualifies the action specified by option, such as a description used with the -d option. A value enclosed in brackets ([]) is optional. Values that include spaces must be enclosed in quotation marks (" "). Multiple values must be enclosed in quotation marks (""), and each value must be separated by a space, unless indicated otherwise, such as the use of a semicolon delimited list.
command is an action the utility performs such as list or create. Commands separated by a vertical bar (|) indicate that either one (but not both) can be used at the same time.
target is the object on which the command takes effect, such as a calendar ID or user ID.
The following rules are general usage guidelines for the command line utilities:
If you specify only the utility name, it lists all commands, options, and several examples.
If you do not specify a required password, the utility prompts you for it.
The -v (verbose) and -q (quiet) options are available for each utility.
If a command is dangerous (that is, one that could cause a data loss), the utility prompts for confirmation before executing the command. Examples of dangerous commands are cscal, which can delete a calendar, and csuser, which can delete a user. The -q (quiet) option, however, disables confirmation prompting.
The version command is available for each utility.
If you run the command-line utilities from a script, the return code is “0” if the utility run successfully or “-1” for a failure.
The following table gives a short description the Calendar Server command-line utilities.
Table D–1 Calendar Server Command-Line Utilities Summary
Utility |
Description |
---|---|
Manages the LDAP attributes of a calendar user or resource. |
|
Backs up individual calendars, users, and the calendar database. |
|
Manages calendars and their properties. |
|
Removes user and resource calendars for Calendar Server users whose status attribute (inetUserStatus) has been marked as “deleted” by Delegated Administrator. |
|
Manages calendar components: events and tasks (todos). |
|
Manages the calendar database. |
|
Manages Calendar Server attributes in the LDAP directory for a hosted (virtual) domain. |
|
Exports a calendar in iCalendar (.ics) or XML (.xml) format. |
|
Imports a calendar in iCalendar (.ics) or XML (.xml) format. |
|
Monitors LDAP connectivity, log files, and available disk space for the calendar database. |
|
Views, enables, or disables configured Calendar Server API (CSAPI) plug-ins. |
|
Allows the manual purge of entries in the Delete Log database (ics50deletelog.db). |
|
Allows the renaming of user ID's. Causes the whole database to be rewritten. |
|
Manages calendar resources such as conference rooms and equipment. |
|
Restores individual calendars, users, and the calendar database. |
|
Manages scheduling entries in the Group Scheduling Engine (GSE) queue. |
|
Displays counters in a Calendar Server. |
|
Pings a running Calendar Server instance. |
|
Manages calendar users. |
|
Starts all Calendar Server processes. |
|
Stops all Calendar Server processes. |
The csattribute utility manages Calendar Server user or resource LDAP entry attributes. Commands are:
add an LDAP attribute and value to a specified target (user or resource object).
list the attributes of a target object.
delete an attribute from a target.
If your site is using the LDAP CLD plug-in, do not use csattribute to change the icsDWPHost attribute when trying to specify a new back-end host server. Modifying icsDWPHost does not cause a new calendar to be created on the new back-end host. For more information, see Chapter 6, Configuring Calendar Database Distribution Across Multiple Machines
Calendar Server can be running or stopped.
You must be logged in as the user or group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csattribute [-q|-v] -a attribute=value [-t resource | user] [-d domain] add target csattribute [-q|-v] -a attribute[=value] [-t resource | user] [-d domain] delete target csattribute [-q | -v] [-t resource | user] [-d domain] list target |
The following table describes the commands available for csattribute.
Table D–2 csattribute Utility Commands
Command |
Description |
---|---|
add target |
Adds an LDAP attribute and value to a specified target (user or resource object). |
list target |
Lists the attributes of a target object. |
delete target |
Deletes an attribute from a target. |
version |
Displays the version of the utility. |
The following table describes the csattribute utility command options.
Table D–3 csattribute Utility Command Options
Add the icsCalendar LDAP attribute with the value tchang to the user ID tchang:
csattribute -a icsCalendar=tchang add tchang
Delete the LDAP attribute icsCalendar from tchang:
csattribute -a icsCalendar delete tchang
Display the attributes of tchang:
csattribute list tchang
The csbackup utility backs up the calendar database, a specified calendar, or a user’s default calendar. Commands are:
database to backup the calendar database.
calendar to backup a specified calendar.
defcal to backup a user’s default calendar.
version displays the version number of the utility currently installed.
The caldb.conf version file located in the specified backup directory shows the version number of the database that was backed up.
For information about csrestore, see csrestore.
Calendar Server can be running or stopped.
You must run the utility locally on the machine where Calendar Server is installed.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csbackup [-q|-v] -f database target csbackup [-q|-v] -c calid calendar target csbackup [-q|-v] -a userid [-b basedn] defcal target |
The following table describes the commands available for csbackup.
Table D–4 csbackup Utility Commands
Command |
Description |
---|---|
database target |
Backs up the calendar database to the specified target database directory. By default, the target database directory is: cal_svr_base/SUNWics5/cal/sbin/target-directory If you specify only the target database directory, do not include the slash (/) before the directory name. For example: csbackup database backupdir Note: The csbackup utility fails if the target backup directory already exists and you do not specify the -f option. For example, the following command fails if backupdir exists, even if the directory is empty: csbackup database backupdir Therefore, if you specify a target backup directory that already exists, include the -f option when you run csbackup. You can also specify a nonexistent target backup directory and let csbackup create the directory for you. |
calendar calid target |
Backs up the specified calendar ID to the specified target output file. The data format of the file is assumed by the file extension, .ics for text/calendar or .xml for text/xml. |
defcal userid target |
Backs up the default calendar of the specified user ID to the specified target file. The data format of the file is assumed by the file extension, .ics for text/calendar and .xml for text/xml. |
version |
Displays the version of the utility. |
The following table describes the csbackup utility command options.
Table D–5 csbackup Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a userid |
The user ID of the calendar user to backup. This option is required for the default option. There is no default. |
-b basedn |
The base DN to be used for this user. The default is taken from the setting local.ugldapbasedn defined in the ics.conf file. The Base DN (distinguished name) is the entry in your LDAP directory used as the starting point from which searches occur. For example, if you specify a base DN of ou=people, o=sesta.com, all LDAP search operations executed by Calendar Server examine only the ou=people subtree in the o=sesta.com directory tree. |
-c calid |
The calendar ID to backup. This option is required with the calendar command. There is no default. For more information, see Creating Calendar Unique Identifiers (calid's). |
-f |
To force any existing backup files to be deleted. In the current release, you must include the -f option if the backup target directory already exists, even if the directory is empty. |
-l |
To prepare the backup file for use with the SolsticeTM BackupTM or the Legato NetworkerTM backup programs. For more information, see Chapter 17, Backing Up and Restoring Calendar Server Data. |
Backup the calendar database to a directory named backupdir:
csbackup database backupdir
Backup the calendar with the calendar ID tchang to the file tchang.ics as text/calendar:
csbackup -c tchang calendar tchang.ics
Backup the default calendar for tchang to the file tchang.xml as text/xml:
csbackup -a tchang defcal tchang.xml
The cscal utility manages calendars and their properties. Commands are:
create a calendar
delete a calendar
disable a calendar
enable a calendar
list calendars
modify calendar properties and group scheduling access control
reset calendar properties to the default settings
version displays the version number of the utility currently installed
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
cscal [-q|-v] [-a aces] [-c charset] [-d description] [-g categories] [-k yes|no] [-l langcode] [-m email] [-n name] [-o owner’s uid] [-y otherowners] create|modify calid cscal [-q|-v] [-o owner’s uid] [-O] delete|reset calid cscal [-q|-v] [-o owner’s uid] [-O] disable|list [calid] cscal [-q|-v] [-k yes|no] [-o owner’s uid] [-O] enable [calid] |
Despite the fact that cscal does not check case when you enter the -o (owner’s uid), the search is case insensitive.
The following table describes the commands available for the cscal utility.
Table D–6 cscal Utility Commands
Command |
Description |
---|---|
create calid |
Creates the calendar specified by calid. Note: If your site is using the LDAP CLD plug-in, all calendars for a specific user must reside on the same back-end server, as indicated by the user’s icsDWPHost LDAP attribute. If you try to create a calendar for the user on a different back-end server, Calendar Server returns an error. |
delete calid |
Deletes the calendar specified by calid. If the -o owner option is specified, deletes all calendars whose primary owner is the specified uid. |
enable [calid] |
Enables the calendar specified by calid. If calid is not specified, enables all calendars. If the -o owner option is specified, enables all calendars whose primary owner is the specified uid. |
disable [calid] |
Disables the calendar specified by calid. If calid is not specified, disables all calendars. If the -o owner option is specified, disables all calendars whose primary owner is the specified uid. |
list [calid] |
Lists properties of the calendar specified by calid. If calid is not specified, lists properties of all calendars. If the -o owner's uid option is specified, lists all calendars whose primary owner is the specified owner uid. Note – ACE string permissions modified in the Calendar Express user interface may appear capitalized in the list command output. This has no significance. The ACE strings are case insensitive. |
modify calid |
Modifies the properties of the calendar specified by calid. |
reset calid |
Resets the properties of the calendar specified by calid to the default configuration settings. |
version |
Displays the version of the utility. |
The following table describes the cscal utility command options.
Table D–7 cscal Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a [aces] |
Access Control Entries (ACE's) for a specified calendar. ACE's determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (" "). The default is the calstore.calendar.default.acl parameter in the ics.conf file. For details about the ACE format, see Calendar Access Control. |
-c charset |
Character set. The default is no character set. |
-d description |
Description (a viewable comment about the purpose of the calendar). The default is no description. |
-g category |
Category. Multiple categories must be enclosed in quotation marks ("") and separated by spaces. The default is no category. |
-k yes|no |
Specifies whether double booking is allowed for a user calendar. For example, yes means the calendar can have more than one event scheduled for the same time slot. If the -k option is omitted, the default is taken from the user.allow.doublebook parameter in the ics.conf file. However, the user.allow.doublebook parameter is used only when a calendar is created. After a calendar is created, Calendar Server checks the calendar properties database, ics50calprops.db, to determine if doublebooking is allowed. If you need to change the calendar properties for a calendar to allow or disallow doublebooking, reissue cscal with the -k option. |
-l langcode |
Language code. The default is no language code. |
-m email |
Email address. The default is no email. |
-n name |
Name. The default is no name. |
-o owner |
Primary owner. The default setting is the calendar ID (calid), which is usually the same as the user ID. |
-O |
Specifies all calendars of the primary owner. Default is the named calendar only. |
-y otherowners |
Other calendar owners. Multiple owners must be enclosed in quotation marks ("") and separated by spaces. The default is no other owners. |
Create the calendar with the calendar ID tchang with tchang as the primary owner with the visible name Public_Calendar using the default access control settings (as defined by calstore.calendar.default.acl in the ics.conf file):
cscal -o tchang -n Public_Calendar create tchang
Modify calendar chang so that anyone has read and write access, it is associated with the category sports, and it is co-owned by jsmith@sesta.com:
cscal -a "@^a^rw^g" -g sports -y jsmith@sesta.com modify tchang
Disable the calendar with the calendar ID tchang (users will not be allowed to read, write to, or locate it using the user interface):
cscal disable tchang
Enable the calendar with the calendar ID tchang (users are allowed to read or write to it using the user interface), but it does not allow doublebooking:
cscal -k no enable tchang
List the properties of tchang:
cscal list tchang
List all the properties of tchang:
cscal -v list tchang
List all the calendars in the database:
cscal list
Reset the calendar with the calendar ID tchang to the default configuration settings:
cscal reset tchang
Remove a description from the calendar with the calendar ID tchang:
cscal -d "" modify tchang
Remove all categories from the calendar with the calendar ID tchang:
cscal -g "" modify tchang
Remove other owners from the calendar with the calendar ID tchang:
cscal -y "" modify tchang
Delete tchang from the calendar database:
cscal delete tchang
Delete all calendars from the calendar database whose primary owner is tchang:
cscal -o tchang delete
The csclean utility only works in Schema 2 hosted domain mode. It removes user and resource calendars for users whose status attribute (icsStatus) has been marked as “deleted” by Delegated Administrator.
For Schema 1 and non-hosted domain mode, use csuser and cscal to remove all of the calendars for a deleted user.
You must be using Schema 2 hosted domains.
Calendar Server can be running or stopped.
You must run csclean locally on the machine where Calendar Server is installed.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csclean [-q | -v] [-g graceperiod] clean domain |
The following table describes the csclean utility command options.
Table D–8 csclean Utility Command Options
Remove calendars for all users and resources in sesta.com whose calendar service has been deleted for at least 5 days:
csclean -g 5 clean sesta.com
Remove calendars for all users and resources in all domains whose calendar service has been deleted for at least 10 days:
csclean clean "*"
The cscomponents utility manages calendar components: events and tasks (todos). Commands are:
delete events and tasks in a calendar.
list events and tasks in a calendar.
version displays the version number of the utility currently installed.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
cscomponents [-v|-q] [-e endtime] [-s starttime] [-t event|task] delete|list calid |
The following table describes the commands available for the cscomponents utility.
Table D–9 cscomponents Utility Commands
Command |
Description |
---|---|
delete calid |
Deletes events and tasks in the calendar with the specified calendar ID. Note – When deleting tasks, you must specify the -soption with an actual DateTime Z String specifying the starting date for removal. If you do not specify a date, or you specify zero (0) as the value for the option, all tasks will be deleted from the calendar. |
list calid |
Lists events and tasks in the calendar with the specified calendar ID. |
version |
Prints the version of the utility to the screen. |
The following table describes the cscomponents utility command options.
Table D–10 cscomponents Utility Command Options
Delete all 2000 events in the calendar with the calendar ID tchang:
cscomponents -s 20000101T000000Z -e 20001231T000000Z delete tchang
List all events and tasks with details in the calendar with the calendar ID tchang:
cscomponents -v list tchang
The csdb utility manages the calendar databases (calendar, session, and statistics). Commands are:
create a new database. (If a database does not exist when the server is started, Calendar Server creates one automatically.)
delete an existing calendar database. A database cannot be deleted while it is open (when Calendar Server is running).
list information about the database.
check a calendar database to determine if any corruption has occurred.
rebuild a corrupted calendar database.
recover a damaged calendar database.
version displays the version number of the utility currently installed.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server must be stopped for the create, delete, or rebuild commands.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csdb [-q|-v] [-t caldb|sessdb|statdb] create|delete [dbdir] csdb [-q|-v] [-t caldb|sessdb|statdb] list [dbdir] csdb [-q|-v] [-f] [-t caldb|sessdb|statdb] recover [dbdir] csdb check [dbdir] csdb rebuild [-a, -V] [-g] [dbdir [dstdir]] |
The following table describes the commands available for the csdb utility.
Table D–11 csdb Utility Commands
Command |
Description |
---|---|
create [dbdir] |
Creates the databases in the specified database directory. If a database directory is not specified, the current directory is used. If a database does not exist when the server is started, Calendar Server creates one automatically. |
delete [dbdir] |
Deletes the databases in the specified database directory. If a database directory is not specified, the current directory is used. A database cannot be deleted while it is open (when Calendar Server is running). |
list [dbdir] |
Lists information about the databases in the specified database directory. If a database directory is not specified, the current directory is used. |
recover [dbdir] |
Attempts to recover damaged calendar databases in the specified database directory. If a database directory is not specified, the current directory is used. Is not implemented for session or statistics databases. |
check [dbdir] |
Scans a calendar database in the specified database directory to determine if any corruption has occurred and reports the results in its output. If a database directory is not specified, the current directory is used. |
rebuild [dbdir [dstdir]] |
Scans all calendar databases in the specified database directory to determine if any corruption has occurred and generates a rebuilt calendar database (.db files). If a database directory is not specified, the current directory is used. After the databases are rebuilt, db_verify runs. The dstdir specifies an optional destination directory. |
version |
Displays the version of the utility. |
The following table describes the csdb utility command options.
Table D–12 csdb Utility Command Options
Create new, unpopulated databases in the current directory:
csdb -t caldb create
Delete the databases in the current directory:
csdb -t caldb delete
List information about the calendar database in the current directory:
csdb -v -t caldb list
Attempt to recover all damaged databases in the current directory:
csdb recover
List information about the sessions database in the current directory:
csdb -t sessdb list
Rebuild the alarms database only:
csdb -a -V rebuild
The csdomain utility manages Calendar Server attributes in the LDAP directory for a hosted (virtual) domain. These attributes are part of the icsCalendarDomain object class. Commands are:
create a new hosted domain in the LDAP directory.
add a Calendar Server attribute and its associated value in the LDAP directory for a specific hosted domain.
delete a Calendar Server attribute in the LDAP directory for a specific hosted domain or delete an entire hosted domain.
list Calendar Server attributes in the LDAP directory for a specific hosted domain.
You must be in hosted (virtual) domain mode to run csdomain. That is, the following parameters in the ics.conf file must be set:
service.virtualdomain.support must be set to “yes”.
local.schemaversion must be set to the version of the LDAP schema (“1” , “1.5”, or “2”).
If local.schemaversion = “1” or “1.5”, service.dcroot must be set to the root suffix of the DC tree in the LDAP directory.
If local.schemaversion = “2”, service.schema2root must be set to the root suffix underneath which all domains are found.
You must have followed the instructions in Chapter 11, Setting Up Hosted Domains before using csdomain to add Organization Tree nodes.
You must run csdomain locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csdomain [-q | -v] -n node create domain csdomain [-q | -v] {-a attr[=value] | -f filename} add domain csdomain [-q | -v] [-a attr | -f filename] delete domain csdomain [-q | -v] list domain |
The following table describes the commands available for the csdomain utility.
Table D–13 csdomain Utility Commands
Command |
Description |
---|---|
create |
Create a new hosted domain in the LDAP directory. All Calendar Server users and resources for the domain are then created under this entry in the directory. |
add |
Add a Calendar Server attribute and its associated value in the LDAP directory for a specific domain. If you add or update domain LDAP attributes using csdomain, restart Calendar Server for the new values to take effect. |
delete |
Delete a Calendar Server attribute in the LDAP directory for a specific hosted domain or delete all LDAP entries for an entire domain. |
list |
Display Calendar Server attributes in the LDAP directory for a specific domain. |
version |
Display the version of the utility. |
The following table describes the csdomain utility command options.
Table D–14 csdomain Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a attr[=value] |
Specifies the LDAP attribute property name and its optional value. For a list of these attributes and property names, see LDAP Attributes and Property Names. |
-f filename |
Specifies a text file that contains Calendar Server LDAP directory property names and their associated values. For example: createLowerCase="yes" filterPrivateEvents="no" fbIncludeDefCal="no" subIncludeDefCal="no" uiProxyUrl="https://proxyserver" |
-n node |
Applies to the create command as follows:
|
domain |
For the add, delete, and list commands, specifies an existing domain in the LDAP directory. For the create command, specifies the unique name of a new domain that will be created in the LDAP directory. For example: west.sesta.com |
The following tables describe the LDAP attributes and property names that apply to the csdomain utility. These attributes are part of the icsCalendarDomain object class. When you add or delete a value, you must use the property name and not the attribute name.
If you add or update domain LDAP attributes using csdomain, restart Calendar Server for the new values to take effect.
LDAP Attributes and Property Names describes the icsAllowRights attribute and properties that you can set with the csdomain utility. This attribute is a 32-bit numeric string, with each bit in the string corresponding to a specific user right. (In the current release, some bits are not used and are set to zero by default.) If a bit corresponding to a specific right is set (value=1), the right is not allowed. If the bit is not set (value=0), the right is allowed.
Each property in the icsAllowRights attribute has a corresponding ics.conf parameter. If a property is not set (value = 0) or is not present (service.virtualdomain.support = “no”), Calendar Server uses the corresponding ics.conf parameter as the default value.
The value for icsAllowRights is a numeric string and not an integer. To use icsAllowRights programmatically in bitwise operations, you must first convert its string value to an integer.
Table D–15 icsAllowRights LDAP Directory Attribute and Properties
Bit |
Property Name |
Description |
---|---|---|
0 |
allowCalendarCreation |
If set (bit 0=1), do not allow calendars to be created. Corresponding ics.conf parameter: service.wcap.allowcreatecalendars |
1 |
allowCalendarDeletion |
If set (bit 1=1), do not allow calendars to be deleted. Corresponding ics.conf parameter: service.wcap.allowdeletecalendars |
2 |
allowPublicWritableCalendars |
If set (bit 2=1), do not allow public writable calendars. Corresponding ics.conf parameter: service.wcap.allowpublicwriteablecalendars |
3 |
Not used in the current release. |
|
4 |
allowModifyUserPreferences |
If set (bit 4=1), do not allow domain administrators to get or set user preferences using WCAP commands. Corresponding ics.conf parameter: service.admin.calmaster.wcap.allowgetmodifyuserprefs |
5 |
allowModifyPassword |
If set (bit 5=1), do not allow user to change password via this server. Corresponding ics.conf parameter: service.wcap.allowchangepassword |
6 |
Not used in the current release. |
|
7 |
Not used in the current release. |
|
8 |
allowUserDoubleBook |
If set (bit 8=1), do not allow double booking for user’s calendars. Corresponding ics.conf parameter: user.allow.doublebook |
9 |
allowResourceDoubleBook |
If set (bit 9=1), do not allow double booking for resource calendars. Corresponding ics.conf parameter: resource.allow.doublebook |
10 |
allowSetCn |
If set (bit 10=1), do not allow user to set the common name (cn) attribute using the WCAP set_userprefs command. Corresponding ics.conf parameter: service.wcap.allowsetprefs.cn |
11 |
allowSetGivenName |
If set (bit 11=1), do not allow user to set the givenName attribute using the WCAP set_userprefs command. Corresponding ics.conf parameter: service.wcap.allowsetprefs.givenname |
12 |
allowSetGivenMail |
If set (bit 12=1), do not allow user to set the mail attribute using the WCAP set_userprefs command. Corresponding ics.conf parameter: service.wcap.allowsetprefs.mail |
13 |
allowSetPrefLang |
If set (bit 13=1), do not allow user to set the preferredLanguage attribute using the WCAP set_userprefs command. Corresponding ics.conf parameter: service.wcap.allowsetprefs.preferredlanguage |
14 |
allowSetSn |
If set (bit 14=1), do not allow user to set the surname (sn) attribute using the WCAP set_userprefs command. Corresponding ics.conf parameter: service.wcap.allowsetprefs.sn |
15–31 |
Not used in the current release. |
The following table describes the icsExtendedDomainPrefs attribute and properties that you can set with the csdomain utility. Each property has a corresponding ics.conf parameter. If a property is not set (value = 0, service.virtualdomain.support=“no”), or is not present, Calendar Server uses the corresponding ics.conf parameter as the default value.
Table D–16 icsExtendedDomainPrefs LDAP Directory Attribute
Property Name |
Description |
---|---|
allowProxyLogin |
Specifies "yes" or "no" whether to allow proxy logins. Corresponding ics.conf parameter: service.http.allowadminproxy (default = "no") |
calmasterAccessOverride |
Specifies "yes" or "no" whether the Calendar Server administrator can override access control. Corresponding ics.conf parameter: service.admin.calmaster.overrides.accesscontrol (default = "no") |
calmasterCred |
Specifies an ASCII string that is the password of the user ID specified as the Calendar Server domain administrator. Corresponding ics.conf parameter: service.admin.calmaster.cred (no default) |
calmasterUid |
Specifies an ASCII string that is the user ID of the person designated as the Calendar Server domain administrator. Corresponding ics.conf parameter: service.admin.calmaster.userid (no default) |
createLowercase |
Specifies "yes" or "no" whether Calendar Server should convert a calendar ID (calid) to lowercase when creating a new calendar or when searching for a calendar Corresponding ics.conf parameter: calstore.calendar.create.lowercase (default = "no") |
domainAccess |
Specifies an access control list (ACL) for the domain. For information about ACLs, see Access Control Lists (ACLs). This ACL is used for cross domain searches. For more information, see Cross Domain Searches. |
fbIncludeDefCal |
Specifies "yes" or "no" whether a user’s default calendar is included in user’s free/busy calendar list. Corresponding ics.conf parameter: calstore.freebusy.include.defaultcalendar (default = "yes") |
filterPrivateEvents |
Specifies "yes" or "no" 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. Corresponding ics.conf parameter: calstore.filterprivateevents (default = "yes") |
groupMaxSize |
Specifies the maximum number of attendees allowed in an LDAP group when expanding an event. Corresponding ics.conf parameter: calstore.group.attendee.maxsize (default is "0" – expand the group entirely) |
language |
Specifies the language for a domain. Corresponding ics.conf parameter: local.domain.language |
resourceDefaultAcl |
Specifies an access control list (ACL) that is the default access control permissions used when a resource calendar is created. Corresponding ics.conf parameter: resource.default.acl (default is "@@o^a^r^g;@@o^c^wdeic^g; @^a^rsf^g" |
setPublicRead |
Specifies whether user default calendars are initially set to public read/private write ("yes") or private read/private write ("no"). Corresponding ics.conf parameter: service.wcap.login.calendar.publicread (default = "no") |
searchFilter |
Specifies a search filter for finding a user. Corresponding ics.conf parameter: local.userSearchFilter |
ssoCookieDomain |
Specifies that the browser should send a cookie only to servers in the specified domain. The value must begin with a period (.). For example: ".sesta.com" Corresponding ics.conf parameter: sso.cookiedomain (default is the current domain) |
ssoUserDomain |
Specifies the domain used as part of the user’s SSO authentication. Corresponding ics.conf parameter: sso.userdomain (no default) |
subIncludeDefCal |
Specifies "yes" or "no" whether a user’s default calendar is included in the user’s subscribed calendar list. Corresponding ics.conf parameter: calstore.subscribed.include.defaultcalendar (default = "yes") |
uiAllowAnyone |
Specifies "yes" or "no" whether the user interface should show and use the "Everybody" access control list (ACL). Corresponding ics.conf parameter: ui.allow.anyone (default = "yes") |
uiAllowDomain |
Specifies "yes" or "no" whether the user interface should show and use the access control list (ACL) for this domain. Corresponding ics.conf parameter: ui.allow.domain (default = "no") |
uiBaseUrl |
Specifies a URL for the base server address. For example: "https://proxyserver". Corresponding ics.conf parameter: ui.base.url (no default) |
uiConfigFile |
Specifies an optional xml based configuration file that Calendar Server can read at startup that allows parts of the user interface to be hidden. Corresponding ics.conf parameter: ui.config.file (no default) |
uiProxyURL |
Specifies a URL for the proxy server address to prepend in an HTML UI JavaScript file. For example: "https://web_portal.sesta.com/" Corresponding ics.conf parameter: ui.proxyaddress.url (no default) |
The following table describes other LDAP attributes and properties that you can set with the csdomain utility.
Table D–17 Other LDAP Directory Attributes for the csdomain Utility
Create a new hosted domain using LDAP schema 1 named west.sesta.com:
csdomain -v -n o=nodewest,o=sesta create west.sesta.com
Create a new hosted domain using LDAP schema 2 named east.sesta.com:
csdomain -v -n nodeeast create east.sesta.com
Display a list of Calendar Server LDAP attributes for the hosted domain named west.sesta.com:
csdomain -v list west.sesta.com
Set the time zone to America/New_York for the hosted domain named west.sesta.com:
csdomain -v -a timezone=America/New_York add west.sesta.com
The csexport utility exports a calendar to a file in iCalendar (.ics) or XML (.xml) format. Commands are:
calendar exports a specified calendar.
version displays the version number of the utility currently installed.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csexport [-v|-q] -c calid calendar outputfile |
The following table describes the commands available for the csexport utility.
Table D–18 csexport Utility Commands
The following table describes the csexport utility command options.
Table D–19 csexport Utility Command Options
Export the calendar with the calendar ID tchang in iCalendar (text/calendar) format to a file named tchang.ics:
csexport -c tchang calendar tchang.ics
Exports the calendar with the calendar ID tchang in XML (text/xml) format to a file named tchang.xml:
csexport -c tchang calendar tchang.xml
The csimport utility imports a calendar from a file in iCalendar (ics) or XML format that was saved with the csexport utility. Commands are:
calendar – Imports a specified calendar.
version – Displays the version number of the utility currently installed.
Date calculations for importing a calendar’s components use the time zone specified in the X-NSCP-DTSTART-TZID associated with the component. If none is present, then the server time zone found in the ics.conf is used.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csimport [-v|-q] -c calid calendar inputfile |
The following table describes the commands available for the csimport utility.
Table D–20 csimport Utility Commands
The following table describes the csimport utility command options.
Table D–21 csimport Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-c calid |
The calendar ID of the calendar to import. This option is required with the calendar command. If the specified calendar ID already exits, the imported data is merged with the current calendar. There is no default. For more information, see Creating Calendar Unique Identifiers (calid's). |
Import the calendar with the calendar ID tchang from the file tchang.ics and expect iCalendar (text/calendar file) format:
csimport -c tchang calendar tchang.ics
Import the calendar with the calendar ID tchang from the file tchang.xml and expect XML (text/xml file) format:
csimport -c tchang calendar tchang.xml
The csmonitor utility is a script that performs these monitoring functions:
Checks LDAP connectivity according to specific ics.conf parameters.
Checks the transaction log files, and if more than one file exists, csmonitor sends a warning by email.
Checks the available disk space for the calendar database.
Checks if Calendar Server services are running.
csmonitor [ -k | -c | -help] |
The following table describes the commands for the csmonitor utility.
Table D–22 csmonitor Utility Command Options
Parameter |
Description |
---|---|
-k |
Stops csmonitor. |
-c |
Backs up the csmonitor log and purges it. |
-help |
Displays the csmonitor usage. |
The following table csmonitor.
Table D–23 csmonitor Configuration Parameters
Parameter |
Description |
---|---|
service.monitor.continuous |
Specifies whether csmonitor should loop continuously: "0" – Do not loop continuously. "1" – Loop continuously. Default is "0". |
service.monitor.loopsdelay |
Specifies the delay in seconds between two monitoring loops. Default is "60". |
service.monitor.emailaddress.from |
Specifies the email address csmonitor sends messages from. Default is none. |
service.monitor.emailaddress.to |
Specifies the email address csmonitor should send messages to. Default is none. |
service.monitor.csdb.logthreshold |
Specifies a threshold value in percent of the total disk space for the maximum disk occupation considered to be normal. If, on the disk where the calendar database (csdb directory) resides, occupation exceeds this value, csmonitor sends a warning email message. Default is "90". |
logfile.monitor.logname |
Specifies the csmonitor log file name. Default is "csmonitor.log". |
logfile.monitor.maxlogfilesize |
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. Default is "2097152". |
service.monitor.dbglevel |
Specifies the debug level. The higher this value, csmonitor sends more precise and verbose messages. Default is "0". |
The csplugin manages CSAPI plug-ins configured for your Calendar Server installation. Commands are:
activate loads and starts a specified plug-in.
deactivate shut downs and disables the specified plug-in type and plug-in name. (For descriptions of the supported plug-in types, see the -t option in Table D–25.)
list displays all supported plug-ins.
version displays the version number of the utility currently installed.
Must be run on the local machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csplugin [-q|-v] [-r] -t ac|attr|auth|locate|lookup|xlate activate|deactivate plugin csplugin [-q|-v] list |
The following table describes the commands available for the csplugin utility.
Table D–24 csplugin Utility Commands
Command |
Description |
---|---|
activate -t type name |
Load and enable the specified plug-in type and plug-in name. (For descriptions of the supported plug-in types, see the -t option in Table D–25.) |
deactivate -t type name |
Shut down and disable the specified plug-in type and plug-in name. (For descriptions of the supported plug-in types, see the -t option in Table D–25.) |
list |
List all the supported plug-in types, names, and activation status. (For descriptions of the supported plug-in types, see the -t option in Table D–25.) |
version |
Display the version of the utility. |
The following table describes the csplugin utility command options.
Table D–25 csplugin Utility Command Options
List details about all the supported plug-ins, including the type, name and the activation status of each plug-in configured for use with this server instance:
csplugin -v list
Load and enable the lookup type plug-in with the file named mylookup:
csplugin activate -t lookup mylookup
Disable the lookup type plug-in with the file named mylookup and then delete it from the plugin directory:
csplugin deactivate -t lookup mylookup -r
The cspurge utility allows the manual purge of entries in the Delete Log database (ics50deletelog.db).
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
cspurge [-q|-v] -e endtime -s starttime |
The following table describes the cspurge utility command options.
Table D–26 cspurge Utility Command Options
Purge all entries in the Delete Log:
cspurge -v -e 0 -s 0
Purge all entries from July 1, 2003 through July 31, 2003:
cspurge -v -e 20030731T235959Z -s 20030701T120000Z
Purge all entries up to September 30, 2003:
cspurge -v -e 20031030T235959Z -s 0
The csrename utility allows you to rename one or more calendar users. This utility renames calendar users as follows:
Calendar database files–Renames users (user ID's) in the calendar database files and then writes the new database files to a destination directory. The existing calendar database files are not modified.
LDAP directory server–Converts the user ID's in the Calendar Server LDAP attributes (that is, attributes with the “ics” prefix). The LDAP directory server is modified in place.
The csrename utility is located in the following directory:
cal_svr_base/SUNWics5/cal/sbin
Before you run csrename, you must first:
Create an input mapping file (-m option) for the users you want to convert.
Create any new users in the LDAP directory server, if necessary.
Stop Calendar Server.
To run csrename, you must log in as icsuser (or as the Calendar Server runtime user ID specified during configuration). If you run csrename as superuser (root), you might need to reset the permissions for the new database files. To modify the LDAP directory server attributes, you must also have administrative rights for that directory.
If your Calendar Server installation has a front-end/back-end server configuration, you must run csrename on each back-end server.
Use the following syntax to run csrename:
csrename [-t DestinationDB] [-c ConfigFile] [-e ErrorFile] -m MappingFile rename [DB|LDAP] |
table lists the options for this utility and gives a description of each:
Table D–27 Options for csrename
Option |
Description |
---|---|
-t DestinationDB |
Specifies the destination directory where csrename generates the new database with the converted user names. The default is MigratedDB. After csrename is finished, the caldb.berkeleydb.homedir.path parameter in the ics.conf file must point to the destination database. Either reset caldb.berkeleydb.homedir.path to point to the destination database directory, or move the destination database files to the directory indicated by the parameter. |
-c ConfigFile |
An input parameter that specifies a Calendar Server configuration file. The default is the ics.conf file. csrename uses the caldb.berkeleydb.homedir.path parameter in the configuration file to determine the location of the input calendar database. The default location of the calendar database is /var/opt/SUNWics5/csdb. |
-e ErrorFile |
The file where csrename writes any errors or database entries that cannot be resolved. The default is MigrateError. |
-m MappingFile |
Specifies an input mapping file. The default is MigrateMapping. The input mapping file is a text file that maps existing user ID's to new user ID's. You must create the mapping file before you run csrename. Specify one entry per line with a space between the old and new values. For example: tchang tc897675 jsmith js963123 bkamdar bk548769 If upon auditing your results, you find that one or more of your intended name changes was omitted, you can fix the error by creating a new mapping file with only the missed names in it and rerunning csrename. |
DB|LDAP |
Specifies the database that gets updated: DB converts user ID's in the new calendar database only (default). LDAP converts user ID's in both the new calendar database and the LDAP directory server attributes. |
Rename users based on the mapping file named DBMapFile and create the new calendar database in the destination directory named newcalDB:
csrename -t newcalDB -m DBMapFile rename DB
Rename users based on values in the mapping file named NewNames, create the new calendar database in the destination directory named NewDB, and modify the Calendar Server attributes in the LDAP directory server:
csrename -t NewDB -m NewNames rename LDAP
The csresource utility creates and manages LDAP entries and calendars for resources, such as conference rooms or equipment. (The csresource utility is available only for calendars associated with a resource and returns an error if issued against a user’s calendar.) Commands are:
create adds a new resource for a specified calendar ID (calid)
delete removes a resource or all resources
disable disables a resource or all resources
enable enables a resource or all resources
list displays a single resource or a list of all resources
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csresource [-q|-v] [-a aces] [-b basedn] [-d domain] [-t description] [-k yes|no] [-o owner] [-y otherowners] -m email -c calid create common_name csresource [-q|-v] [-b basedn] [-d domain] delete|disable|enable [common_name] csresource [-q|-v] [-b basedn] [-d domain] [-h host] list [common_name] |
Then following table describes the commands available for the csresource utility.
Table D–28 csresource Utility Commands
Command |
Description |
---|---|
create common_name |
Create a new resource for a specified calendar ID. |
delete [common_name] |
Delete a resource or, if no resource common_name is specified, delete all resources. |
enable [common_name] |
Enable a resource or, if no resource common_name is specified, enable all resources. |
disable [common_name] |
Disable a resource or, if no resource common_name is specified, disable all resources. |
list [common_name] |
Display a single resource calendar or, if no resource name is specified, display all resource calendars. If the -h host option is included, display the calendar attributes for the specified name (or all resource calendars) on that back-end server. |
If the name contains a space in any of the above commands, it must be enclosed in quotation marks (" ").
The following table describes the csresource utility command options.
Table D–29 csresource Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a [aces] |
Access Control Entries (ACE's) for the specified calendar. ACE's determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (""). The default is the resource.default.acl parameter in the ics.conf file. For information about the ACE format, see Calendar Access Control. |
-b [basedn] |
LDAP base DN (distinguished name) to be used for the specified resource. The default is taken from the local.ugldapbasedn parameter in the ics.conf file. |
-c calid |
The icsCalendar attribute. This option is required with the create command. For more information, see Creating Calendar Unique Identifiers (calid's). |
-d domain |
Specifies the name of a hosted (virtual) domain. Default is taken from the service.defaultdomain parameter in the ics.conf file. |
-t [description] |
Specifies a viewable comment about the purpose of the calendar. The default is no description. |
-h host |
Specifies the name of a back-end server where the resource calendar resides. This option applies only to the list command. |
-k yes|no |
Specifies whether double booking is allowed for a calendar associated with a resource such as a conference room. For example, yes means the resource calendar can have more than one event scheduled for the same time slot. If the -k option is omitted, the default is taken from the resource.allow.doublebook parameter in the ics.conf file. However, the resource.allow.doublebook parameter is used only when a calendar is created. After a calendar is created, Calendar Server checks the calendar properties database (ics50calprops.db) to determine if double booking is allowed. If you need to change the calendar properties for a calendar to allow or disallow double booking, reissue csresource with the -k option. |
-m email |
Specifies the LDAP mail attribute (primary email address) for the resource. |
-o owner |
Primary owner. Default is taken from service.admin.calmaster.userid in the ics.conf file. |
-y otherowners |
Other owners. Multiple owners must be enclosed in quotation marks (" ") and separated by spaces. The default is no other owners. |
version |
Display the version of the utility. |
Display a list of all resource calendars and their LDAP attributes:
csresource -v list
Create a resource calendar with the calendar ID (calid) room100 and the viewable name (LDAP cn attribute) MeetingRoom100:
csresource -m room100@sesta.com -c room100 create MeetingRoom100
Display the LDAP attributes of the resource calendar with the viewable name MeetingRoom100:
csresource -v list MeetingRoom100
Disable the resource calendar with the viewable name MeetingRoom100:
csresource disable MeetingRoom100
Enable the resource calendar with the viewable name MeetingRoom100 and allow doublebooking:
csresource -k yes enable MeetingRoom100
Delete the resource calendar with the viewable name MeetingRoom100:
csresource delete MeetingRoom100
Display the LDAP attributes of the resource calendar with the viewable name MeetingRoom100 on the back-end server sesta:
csresource -v -h sesta list MeetingRoom100
The csrestore utility restores the calendar database, a specified calendar, or a user’s default calendar that was saved using csbackup or csexport. Commands are:
database restores the calendar database.
calendar restores a specified calendar.
defcal restores a user’s default calendar.
version displays the version number of the utility currently installed.
The caldb.conf version file located in the specified backup directory shows the version number of the database that was backed up.
Calendar Server 6 csrestore is not compatible with the version 2 of csrestore. Do not try to restore data that was backed up using Calendar Server 2 csrestore because data loss can occur.
You must run the utility locally on the machine where Calendar Server is installed.
If you are restoring the calendar database, Calendar Server must be stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csrestore [-v|-q] [-f] database inputdir csrestore [-v|-q] -c calid calendar inputfile csrestore [-v|-q] -a userid [-b basedn] defcal inputfile |
The following table describes the commands available for the csrestore utility.
Table D–30 csrestore Utility Commands
The following table describes the csrestore utility command options.
Table D–31 csrestore Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a userid |
The user ID to restore. This option is required with the default option. There is no default. |
-b basedn |
The LDAP base DN (distinguished name) to be used for the specified user ID. The default is taken from the setting local.ugldapbasedn defined in the ics.conf file. |
-f |
To force any existing database files to be deleted. |
-c calid |
The calendar ID to restore. This option is required with the calendar command. There is no default. For more information, see Creating Calendar Unique Identifiers (calid's). |
Restore the calendar database stored in the directory backupdir that was previously saved using csbackup:
csrestore database backupdir
Restore the calendar with the calendar ID tchang from the file tchang.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using csbackup or csexport:
csrestore -c tchang calendar backupdir/tchang.ics
Restore tchang from the calendar database in backupdir that was previously saved using csbackup:
csrestore -c tchang calendar backupdir
Restore the default calendar owned by tchang from the file tchang.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using csbackup or csexport:
csrestore -a tchang defcal backupdir/tchang.ics
The csschedule utility manages schedule entries stored in the Group Scheduling Engine (GSE) queue. Commands are:
list displays entries held in the GSE queue requested by a specified calendar ID.
delete removes an entry from the GSE queue requested by a specified calendar ID.
version displays the version number of the utility currently installed.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server must be stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csschedule [-q|-v] [-c count] [-e endtime] [-s starttime] [-t scheduletime -o offset] [-u uid] list [calid] csschedule [-q|-v] [-t scheduletime -o offset -u uid -n sequencenumber -r rid] list [calid] csschedule [-q|-v] [-t scheduletime -o offset -u uid -n sequencenumber -r rid] delete [calid] csschedule [-q|-v] [-s starttime] [-e endtime] delete [calid] |
The following table describes the commands available for the csschedule utility.
Table D–32 csschedule Utility Commands
Command |
Description |
---|---|
list |
Display entries held in the GSE queue requested by a specified calendar ID. |
delete |
Delete an entry from the GSE queue requested by a specified calendar ID. |
version |
Display the version of the utility. |
Then following table describes the csschedule utility command options.
Table D–33 csschedule Utility Command Options
List in detail all entries stored in the GSE queue:
csschedule -v list
List the first ten entries stored in the GSE queue:
csschedule -c 10 list
List the entries in the GSE queue scheduled between 10:30:45 to 11:30:45 on 12/31/2000:
csschedule -s 20001231T103045Z -e 20001231T113045Z list
List the entry in the GSE queue for calendar tchang that is scheduled at 10:30:45, with an offset number of 2 at the time 10:30:45 on 12/31/2000, with the unique identifier 1111, recurrence ID 0, and sequence number 0:
csschedule -v -t 20001231T103045Z -o 2 -u 1111 -r 0 -n 0 list tchang
Delete the entry in the GSE queue for calendar tchang at 10:30:45, the first offset at time 10:30:45 on 12/31/2000, with the unique identifier 1111, recurrence ID 0, and sequence number 0:
csschedule -v -t 20001231T103045Z -o 1 -u 1111 -r 0 -n 0 delete tchang
Delete entries in the GSE that are scheduled between 10:30:45 and 16:30:45 on 12/31/2000:
csschedule -v -s 20001231T103045Z -e 20001231T163045Z delete
Delete all entries in the GSE queue:
csschedule -v delete
The csstats utility displays Calendar Server statistics. Commands are:
list counter statistics about a specified Calendar Server subsystem.
version displays the version number of the utility currently installed.
For more information about counters, see Counters Configuration (counter.conf) File.
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csstats [-q|v] [-r registry] [-i iterations] [-s delay] list [subsystem] |
The following table describes the commands available for the csstats utility.
Table D–34 csstats Utility Commands
The following table describes the csstats utility command options.
Table D–35 csstats Utility Command Options
Display basic information about counters and what types are available:
csstats list
List counter statistics about the HTTP service subsystem (hpptstat):
csstats list http
List counter statistics about the WCAP subsystem (wcapstat) every 10 seconds for one hour (3600 seconds):
csstats -i 3600 -s 10 list wcap
The cstool utility can ping one of the following:
The HTTP process, cshttpd.
The administration service, csadmind
The Event Notification Service (ENS) process, enpd.
The cstool utility can also display its version number.
The cstool can not be used to ping the following processes:
The notification process, csnotifyd.
The DWP process, csdwpd.
To refresh the configuration, use stop-cal, then start-cal to stop and then restart Calendar Server.
Do not use cstool to refresh the configuration. It could cause unpredictable negative outcomes.
For more information, see Starting and Stopping Calendar Server.
Calendar Server must be running.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
cstool [-q|-v] [-h host] [-p port] [-t timeout] ping [http|ens] cstool [-q|-v] [-h host] version |
The following table describes cstool commands and their parameters.
Table D–36 cstool Utility Commands
Command |
Parameters |
Description |
---|---|---|
ping |
[http|admin|ens] neither parameter specified |
Ping the cshttpd process, the csadmind process, or the ENS process (enpd) Ping the server where Calendar Server is located. |
version |
none |
Display the version of the utility. |
The following table describes the cstool utility options.
Table D–37 cstool Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-h host |
Specifies host name of the machine on which Calendar Server is running. The default value is set at installation and taken from the local.hostname parameter in the ics.conf file. Use this option if you are accessing a Calendar Server running on a remote machine. |
-p port |
The port of the specified service, or if no service is specified, use the default value of the port as defined in the ics.conf file. |
-t timeout |
The amount of time (in seconds) to wait for a response from the server. The default is 120 seconds. |
Ping the cshttpd service:
cstool ping http
Ping ENS on the server with host name sesta:
cstool -h sesta ping ens
Ping the machine with the host name calserver to see if the Calendar Server cshttpd service is listening on port 80:
cstool -p 80 -h calserver -p 80 ping http
Force a local Calendar Server to refresh all service’s configurations:
cstool refresh
The csuser utility manages calendar user information stored in an LDAP directory server and the Calendar Server calendar database. Commands are:
check if user is enabled for calendaring.
create and enable a user for calendaring.
This utility does not enable users for Address Book as is required for Communications Express. This will have to be done manually with ldapmodify.
delete a user and the user’s default calendar.
You must use this command to delete users when you are in non-hosted domain mode. However, other calendars owned by the user are not deleted. Use cscal to remove other calendars of a deleted user.
disable a user from logging in to Calendar Server.
enable a user to log on to Calendar Server.
list a user's calendar attributes.
reset a user's calendar attributes to the default settings.
If you are using Directory Server, you can also use the ldapsearch and ldapmodify utilities. For information about these utilities, see the Directory Server documentation on the following Web site:
http://docs.sun.com/coll/1316.1
Calendar Server can be running or stopped.
You must run the utility locally on the machine where Calendar Server is installed.
The LDAP server that stores calendar user information must be running.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
csuser [-q|-v] [-a aces] [-b basedn] -m email address [-d domain] -f filename -g givenname [-k yes|no] [-l langcode] -s surname -y userpassword create userid csuser [-q|-v] [-b basedn] [-d domain] [-h host] list [userid] csuser [-q|-v] [-b basedn] [-d domain] [check|delete|disable|enable|reset] userid |
The following table describes the commands available for the csuser utility.
Table D–38 csuser Utility Commands
Command |
Description |
---|---|
check userid |
Check if the specified user ID is enabled for calendaring. |
create userid |
Create the specified user ID and enable this user to log into Calendar Server. |
delete userid |
Delete the specified user ID. |
disable userid |
Disable the specified user ID for calendaring. The utility defines http as the value of the icsAllowedServiceAccess attribute. |
enable userid |
Enable the specified user ID for calendaring. |
list [userid] |
List the calendar attributes for the specified user ID. If user ID is not specified, list attributes for all enabled users. If the -hserver-name option is included, list the calendar attributes for the specified user ID (or all enabled users) on that back-end server. |
reset userid |
Reset all calendar attributes for a user ID to their default settings. Note: After the calendar attributes for a user ID have been reset, all of the calendar attributes are removed from the user’s LDAP entry, including icsCalendarUser (object class), icsSubscribed, icsCalendarOwned, icsCalendar, and icsDWPHost (if the user is in an LDAP CLD setup). A Calendar Server administrator then cannot create calendars on the user’s behalf. These attributes are restored in the user’s LDAP entry when the Calendar Server administrator issues a csuser enable command for the user. |
version |
Display the version of the utility. |
The following table describes the csuser utility command options.
Table D–39 csuser Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-b basedn |
The base DN to be used for all LDAP users. The default value is taken from the setting local.ugldapbasedn defined in the ics.conf file. |
-b basedn |
Specifies the base DN for the user. |
-d domain |
Specifies the name of a hosted (virtual) domain. Default is taken from the service.defaultdomain parameter in the ics.conf file. |
-a [aces] |
Access Control Entries (ACE's) for a specified calendar. ACE's determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (""). Default is: "@@o^a^r^g;@@o^c^wdeic^g; @^a^sf^g;@^c^^g;@^p^r^g" For details about the ACE format, see Services Configuration. |
-f filename |
File name to specify a password for options that require a password (-y parameter). If you are running csuser from a script, for added security, specify the password in filename. |
-g givenname |
The user's LDAP given name (first name). This option is required. There is no default. |
-h host |
Specifies the name of a back-end server where the user’s calendar resides. This option applies only to the list command. |
-p port |
The port number that LDAP server is listening to. The default value is taken from the setting local.ugldapport defined in the ics.conf file. |
-k yes|no |
If double booking is allowed for a user’s calendar. If yes, the user’s calendar can have more than one event scheduled for the same time slot. Default is taken from the setting user.allow.doublebook defined in the ics.conf file. |
-l [langcode] |
Language code. Default is the value of local.sitelanguage in ics.conf. |
-m email address |
Specifies the LDAP mail attribute (primary email address) for the user. |
-s surname |
The user's LDAP surname (last name). This option is required. There is no default. |
-u adminDN |
The LDAP distinguished name (DN) of the person with administration rights to the LDAP server that stores user authentication information. The default value is taken from the configuration setting local.enduseradmindn defined in the ics.conf file. |
-w password |
The password of the LDAP administrator DN specified by the -u option. The default value is taken from the configuration setting local.enduseradmincred defined in the ics.conf file. This option is required if you use the -u option. |
-y userpassword |
The required calendar user's password. There is no default. |
Check if the calendar user jsmith@sesta.com is enabled for calendaring (if the existing calendar user has access to calendar data for this Calendar Server):
csuser check jsmith@sesta.com
Create an LDAP user with the user ID jsmith@sesta.com with the given name John, surname Smith, email address jsmith@sesta.com, and the domain sesta.com:
csuser -g John -s Smith -y password -m jsmith@sesta.com create jsmith@sesta.com -d sesta.com
Delete the calendar user jsmith@sesta.com
csuser delete jsmith@sesta.com
Disable the calendar user jsmith@sesta.com from logging in to Calendar Server:
csuser disable jsmith@sesta.com
This command prevents jsmith@sesta.com from logging into Calendar Server to access calendar data, but it does not delete jsmith’s data from the calendar database. If jsmith is currently logged into Calendar Server, he retains access to calendar data until he logs off.
Enable jsmith@sesta.com for calendaring (lets existing calendar user log in to Calendar Server):
csuser enable jsmith@sesta.com
List all calendar attributes for jsmith@sesta.com:
csuser -v list jsmith@sesta.com
List all calendar user ID's prefixed with the string user:
csuser -v list "user*"
Reset all calendar attributes for jsmith@sesta.com to the default configuration settings:
csuser reset jsmith@sesta.com
List all calendar attributes for tchang on the back-end server sesta:
csuser -v -h sesta list tchang
The start-cal utility starts the Calendar Server services in this order:
enpd— Event Notification Service (ENS)
csnotifyd— Notification Service
csadmind— Administration Service
csdwpd— Database Wire Protocol (DWP) service, the distributed database service that is started only with a remote Calendar Server database configuration
cshttpd— HTTP Service
You must run start-cal locally on the machine where Calendar Server is installed.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
start-cal |
cal_svr_base/SUNWics5/cal/sbin/start-cal
For more information, see Starting and Stopping Calendar Server.
The stop-cal utility stops all Calendar Server services.
You must run stop-cal locally on the machine where Calendar Server is installed.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
stop-cal |
cal_svr_base/SUNWics5/cal/sbin/stop-cal
For more information, see Starting and Stopping Calendar Server.
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
Parameter |
Default Value |
Description |
---|---|---|
"yes" |
Enables ("yes") or disables ("no") auto provisioning of Calendar Server users. |
|
" " |
Base DN for LDAP authentication. If not specified, local.ugldapbasedn is used. |
|
"localhost" |
Host for LDAP authentication. If not specified, local.ugldaphost is used. |
|
" " |
Bind credentials (password) for user specified in local.authldapbinddn. |
|
" " |
DN used to bind to LDAP authentication host to search for user's dn. If not specified or " ", anonymous bind. |
|
"389" |
Port for LDAP authentication. If not specified, local.ugldapport is used. |
|
"1" |
Minimum number of LDAP client connections that are maintained for LDAP authentication. If not specified, local.ugldappoolsize is used. |
|
"1024" |
Maximum number of LDAP client connections that are maintained for LDAP authentication. If not specified, local.ugldapmaxpool is used. |
|
"3" |
Specifies the minimum string size for wildcard searches in an attendee lookup search. Zero (0) means always do a wildcard search. |
|
"no" |
Periodically checks if the Berkeley database is in a deadlock state and, if so, instructs the database to reset. |
|
"en" |
Language for the domain. |
|
" " |
Bind credentials (password) for LDAP user preferences authentication. |
|
" " |
DN used to bind to LDAP user preferences host. Must be specified. If " " (not specified), anonymous bind is assumed. |
|
" " |
Host name of the machine on which Calendar Server is installed. |
|
"cal_svr_base/SUNWics5/cal" |
Directory path location where Calendar Server is installed. |
|
"cal_svr_base/SUNWics5/cal" |
Directory path location where programs and data for this instance of Calendar Server are installed. |
|
local.instance.lockdir.path |
"cal_svr_base/SUNWics5/cal/lib/lock" |
Specifies the location where lock files for this server instance are stored. |
"/etc/opt/SUNWics5/ config" |
Specifies the location where PID files for this server instance are stored. |
|
"cal_svr_base/SUNWics5/cal/lib/counter" |
Specifies the location where counter files for this server instance are stored. |
|
" " |
Directory path location where CSAPI plug-ins for this instance of Calendar Server are installed. |
|
"n" |
Allow (y) or not allow (n) 8-bit headers in email messages sent by this server. |
|
"icsgroup" |
Group ID (GID) for Calendar Server files, such as counters and logs. |
|
"icsuser" |
User ID (UID) for Calendar Server files, such as counters and logs. |
|
"en" |
Default language for this instance of Calendar Server. |
|
" " |
Name of the default domain used to lookup an attendee’s calendarID that corresponds to an email address. For example, jsmith resolves to jsmith@sesta.com if the value for this is setting is "sesta.com". |
|
"en" |
User languages supported by this instance of Calendar Server. |
|
" " |
Base DN for LDAP user preferences. Must be specified and cannot be blank. |
|
"localhost" |
Host name of machine that stores the LDAP user preferences. |
|
"ceColorSet, ceFontFace, ceFontSizeDelta, ceDateOrder, ceDateSeparator, ceClock, ceDayHead, ceDayTail, ceInterval, ceToolText, ceToolImage, ceDefaultAlarmStart, ceSingleCalendarTZID, ceAllCalendarTZIDs, ceDefaultAlarmEmail, ceNotifyEmail, ceNotifyEnable, ceDefaultView, ceExcludeSatSun, ceGroupInviteAll" |
Values for the options in the icsExtendedUserPrefs attribute. |
|
"389" |
Port number of the machine that stores LDAP user preferences. |
|
"1" |
Minimum number of LDAP client connections that are maintained for LDAP user preferences. |
|
"1024" |
Maximum number of LDAP client connections that are maintained for LDAP user preferences. |
|
local.user.authfilter |
“uid=%u’” |
Filter to use for user lookup. |
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
Parameter |
Default Value |
Description |
---|---|---|
cred |
" " |
Password of the user ID specified as the Calendar Server administrator. This value is supplied at installation and is required by the installation program. |
userid |
"calmaster" |
User ID of the person designated as the Calendar Server administrator. This value is supplied at installation and is required by the installation program. |
overrides.accesscontrol |
"no" |
Indicates whether the Calendar Server administrator can override access control. |
service.admin.calmaster .wcap.allowgetmodify userprefs |
"no" |
Indicates whether the Calendar Server administrator can get and set user preferences using WCAP commands. |
"yes" |
If “yes”, enables LDAP for user authentication of the user specified in service.admin.calmaster.userid. |
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
Parameter |
Default Value |
Description |
---|---|---|
"on" |
Enables the RSA Cypher Encryption Family Services for SSL. |
|
"internal" |
Specifies the location of the RSA Cypher Encryption Family token. |
|
"SampleSSLServerCert" |
Specifies the certificate name for the RSA Cypher Encryption Family. |
|
service.http.tmpdir |
"/var/opt/SUNWis5/ tmp" |
Specifies a temp directory. |
service.http.uidir.path |
“html” |
Specifies directory where the UI files are found. |
"." |
Specifies the physical path location for the SSL cache. |
|
"10000" |
Specifies the maximum size of the SSL cache database. |
|
"no" |
For SSL configuration, change this value to “yes”. Specifies whether the cshttpd process should use the SSL subsystem. |
|
"no" |
For SSL configuration, change this value to “yes”. Note – This does not disable the HTTP process from listening to its port. There is no way to actually disable HTTP, but you can assign it to another port that is non-functional. Do not set service.http.enable=”no”. That would disable the HTTPS process also. |
|
"443" |
Specifies the SSL port number where the cshttpd process listens for HTTPS requests from Calendar Server users. Do not set this to the same default port used by HTTP ("80"). |
|
"yes" |
Specifies whether to encrypt the entire session. |
|
"alias" |
Specifies the physical path location of the SSL Certificate Database. |
|
"password" |
Specifies the SSL Certificate Database access password. |
|
"https://localhost:443" |
Specifies the SSL host name and port number for the originating source URL. |
|
"" |
Specifies ciphers for SSL2. |
|
"0" |
Specifies the session timeout for SSL2. |
|
"rsa_rc4_40_md5, rsa_rc2_40_md5, rsa_des_sha, rsa_rc4_128_md5, rsa_3des_sha" |
Specifies a list of supported or valid SSL ciphers. |
|
sessiontimeout |
"0" |
Specifies the timeout value for the SSL session. |
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
Parameter |
Default Value |
Description |
---|---|---|
support |
"n" |
Enables ("y") or disables ("n") support for hosted (virtual) domains. |
"1" |
Specifies the version of the LDAP schema:
|
|
" " |
Specifies the root suffix of the DC tree in the LDAP directory, if local.schemaversion="1". For example: "o=internet" |
|
service.schema2root |
" " |
Specifies the root suffix underneath which all domains are found, if local.schemaversion="2". For example: "o=sesta.com" |
" " |
Specifies the default domain for this instance of Calendar Server. Used when a domain name is not supplied during a login. For example: "sesta.com". |
|
"@+" |
Specifies a string of separators used for the login-separator when Calendar Server parses userid[login-separator]domain. Calendar Server tries each separator in turn. |
|
" " |
Specifies the user ID of the domain administrator. |
|
service.siteadmin.cred |
" " |
Specifies the password of the domain administrator. |
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
Parameter |
Default Value |
Description |
---|---|---|
"percentage calendar partition disk space available" |
Description sent with insufficient disk space messages. |
|
"3600" |
Number of seconds between monitoring disk space. |
|
"10" |
Percentage of available disk space that triggers sending a warning message. |
|
"-1" |
Whether alarm.diskstat.msgalarmthreshold is above or below percentage. -1 is below and 1 is above. |
|
msgalarmwarninginterval |
"24" |
Number of hours between sending warning messages about insufficient disk space. |
"localhost" |
The host name of the SMTP server used to send server alarms. |
|
"25" |
The SMTP port used to send server alarms. |
|
"Postmaster @localhost" |
The email address to whom server alarms sent. |
|
"Postmaster @localhost" |
The email address used as the sender when the server sends alarms. |
|
alarm.msgalarmnoticetemplate |
"" |
The default format used to send email alarms: "From: %s\nTo: %s\nSubject: ALARM: %s of \"%s\" is n\n%s\n" |
msgalarmdescription |
"calendar service not responding" |
Description sent with no service response messages. |
msgalarmstatinterval |
"3600" |
Number of seconds between monitoring services. |
msgalarmthreshold |
"100" |
Only trigger sending a warning message if no service response. |
msgalarmthresholddirection |
"-1" |
Specifies whether alarm.responsestat. msgalarmthreshold is the percentage above or below the threshold. A value of -1 is below, and a value of 1 is above. |
msgalarmwarninginterval |
"24" |
Number of hours between sending warning messages about no service response sent out. |
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
Parameter |
Default Value |
Description |
---|---|---|
"no" |
Determines if a calendar that belongs to a resource (such as a conference room or audio visual equipment) can have more than one event scheduled for the same time slot when the calendar is created:
|
|
Specifies the default access control permissions used when a resource calendar is created. The default is: "@@o^a^r^g;@@o^c^wdeic^g;@^a^rsf^g" |
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)
Parameter |
Default |
Description |
---|---|---|
local.calendar.sso.singlesignoff |
”yes” |
Enables (”yes”) or disables (”no”) SSO for Calendar Server. |
local.calendar.sso.amcookiename |
“iPlanetDirectoryPro” |
Specifies the name of the Access Manager SSO cookie. |
local.calendar.sso.amnamingurl |
”http://AccessManager:port /amserver/namingservice” |
Specifies the URL of the Access Manager SSO naming service. |
local.calendar.sso.amloglevel |
”3” |
Specifies the log level for Access Manager SSO. Range is from 1 (quiet) to 5 (verbose). |
local.calendar.sso.logname |
“am_sso.log” |
Specifies the name of the Access Manager SSO API log file. |
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
Parameter |
Default Value |
Description |
---|---|---|
"ics50" |
Unique application ID for this Calendar Server installation. Each trusted application must also have a unique application ID. For example: sso.appid="ics50" |
|
"ssogrp1" |
The prefix value to be used for formatting the SSO cookies. The same value needs to be used by all trusted applications, because only SSO cookies with this prefix will be recognized by Calendar Server. The application prefix must not end with a hyphen (-), because Calendar Server appends a hyphen to the value. For example: sso.appprefix="ssogrp1" |
|
Verification URL for the value specified for sso.appid. For example: "sso.ics50.url="http://siroe.com:80/ default.html" |
||
sso.appid.ip |
IP address of the value specified for sso.appid. For example: sso.ics50.ip= "123.12.456.123" |
|
"." |
Causes the browser to send a cookie only to servers in the specified domain. The value must begin with a period (.). For example: ".sesta.com" |
|
"1" |
Enables or disables SSO:
|
|
"true" |
If set to "true", the server removes all SSO cookies for the user that match the value for sso.appprefix when the user logs out. If "false" the server removes only its SSO user cookie. |
|
" " |
Sets the domain used as part of the user's SSO authentication. |
|
" " |
Specifies the verify URL values for peer SSO hosts. A parameter is required for each trusted peer. appid is the application ID of a peer SSO host whose SSO cookies are to be trusted. For Calendar Server, the appid is ics50. verifyurl identifies the URL of the trusted peer in the format: "http://host:port/VerifySSO?". Do not omit the question mark (?) after VerifySSO. host is the URL of the host, and port is the port number for the host. For example, for Calendar Server on sesta.com with port number 8883: sso.ics50.url= "http://sesta.com:8883/VerifySSO?" |
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
Parameter |
Default Value |
Description |
---|---|---|
"yes" |
Specifies if the auto refresh feature is enabled or disabled. If auto refresh is enabled, after an attendee replies to an event organizer, that attendee’s reply status is automatically propagated to other attendees for that scheduled event.
|
|
"3" |
Specifies (in seconds) how long to wait before the server scans the schedule queue for incoming jobs. If there are more jobs in the queue than the maximum threads allocated, the last thread will always scan the job queue again. Therefore, this setting only takes effect when the number of jobs is below the maximum threads allocated. Increasing this number reduces the frequency the server scans the job queue and improves overall performance. |
|
"10" |
Specifies the maximum number of concurrent threads the server uses to process the schedule queue. Each thread processes one job in the queue. |
|
"86400" |
Specifies (in seconds) the maximum length of time the server will retry to complete a group scheduling job. If the time exceeds the maximum length of time specified, the server treats the job as a retry expired condition and reports the error. Note that the default of 86400 seconds equals one day. |
|
"300" |
Specifies (in seconds) how often the server will retry a previous failing job. The server retries a failing job only when a network error is encountered. The server treats most such errors, however, as fatal errors and does not consider them as retries. |
|
"65535" |
Specifies the maximum stack size (in bytes) of a group scheduling thread. |
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
Parameter |
Default Value |
Description |
---|---|---|
"yes" |
If "yes", start the enpd service when starting all services and stop enpd when stopping all services. |
|
"localhost" |
The host name of the machine on which ENS is running. |
|
"57997" |
The port number of the machine on which ENS is running. |
|
"xenp" |
The name of ENS plug-in. |
|
"yes" |
If "yes", start the csnotifyd service when starting all services and stop csnotifyd when stopping all services. |
|
"-1" |
How many times csnotifyd will consecutively retry and fail to contact ENS. A value of "-1" causes the alarm thread to retry indefinitely. |
|
"3" |
Number (in seconds) that csnotifyd waits before attempting to recontact ENS after a connection failure. |
|
"0" |
Total number of seconds Calendar Server keeps trying to contact ENS before it stops. This setting is similar to caldb.serveralarms.maxretrytime except that it applies only when the alarm thread is first starting. Once the alarm thread has successfully started, caldb.serveralarms.maxretrytime is used. A value of "0" tells the alarm thread to exit immediately if it fails to connect to ENS at startup. |
|
"0" |
Acceptable values:
|
|
"300" |
Retry time in seconds after a recoverable alarm delivery error. |
|
"no" |
If "yes", create an Event Notification Service message when a calendar is created using the following format: enp://ics/createcal?calid=cal |
|
"no" |
If "yes", create an Event Notification Service message when a calendar is modified using the following format: enp://ics/modifycal?calid=cal |
|
"no" |
If "yes", create an Event Notification Service message when a calendar is deleted using the following format: enp://ics/deletecal?calid=cal |
|
"no" |
Specifies how modify event notifications are published:
|
|
"no" |
If "yes", create an ENS message when an event is created. |
|
"no" |
If "yes", create an ENS message when an event is deleted. |
|
"no" |
If "yes", create an ENS message when an event is modified. |
|
"no" |
Specifies whether Calendar Server should create an ENS message when an event is refreshed. |
|
"text/xml" |
Specifies the content type of the message data for the refresh of an event. Values can be "text/xml" or "text/calendar". |
|
"enp:///ics/caleventrefresh" |
Specifies the URL for ENS message for the refresh of an event. |
|
"no" |
Specifies whether Calendar Server should create an ENS message for a reply to an event. |
|
"text/xml" |
Specifies the content type of the message data for a reply to an event. Values can be "text/xml" or "text/calendar". |
|
"enp:///ics /caleventreply" |
Specifies the URL for the ENS message for a reply to an event. |
|
"no" |
If "yes", create an Event Notification Service message when a todo (task) is created using the following format: enp://ics/createtodo? uid=uid&rid=rid |
|
"no" |
If "yes", create an Event Notification Service message when a task is modified using the following format: enp://ics/modifytodo? uid=uid&rid=rid |
|
"no" |
If "yes", create an Event Notification Service message when a task is deleted using the following format: enp://ics/deletetodo?uid=uid&rid=rid |
|
"10000" |
Initial size of the in-memory ENS message queue. This queue stores all ENS messages other than alarm reminders. |
|
"no" |
If "yes", create an Event Notification Service message when a scheduling request is written to the calendar is deleted using the following format: enp://ics/schedreq?calid=cal &method=method&type={event|todo} &uid=uid&rid=rid |
|
"yes" |
If "yes", alarm emails will be sent. |
|
"30" |
Specifies the number of seconds ENS’s alarm thread waits for an acknowledgment from csnotifyd after publishing an alarm notification. If the timeout expires, the alarm thread assumes the alarm notification is no longer processing and publishes the alarm notification again. |
|
"ens" |
Specifies the dispatch type for Calendar Server alarms:
|
|
"10" |
Initial number of server alarm threads. |
|
"-1" |
How many times the alarm thread will consecutively retry and fail to contact ENS. "-1" causes the alarm thread to retry indefinitely. |
|
"10" |
Maximum number of server alarm threads. |
|
"5" |
Number (in seconds) that the alarm thread (in csadmind) waits before attempting to recontact ENS. |
|
"65536" |
Stack frame size for server alarm threads. |
|
"0" |
Total number of seconds Calendar Server keeps trying to contact ENS before failing. This setting is similar to the setting caldb.serveralarms.maxretrytime except that it applies only when the alarm thread is first starting. Once the alarm thread has started successfully, caldb.serveralarms.maxretrytime is used. If "0", the alarm thread exits immediately if it fails to connect to ENS at startup. |
|
"localhost" |
Send alarm emails to this SMTP host. |
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
Parameter |
Default Value |
Description |
---|---|---|
"n" |
If the value is "y", load only the plug-in specified in csapi.plugin.authentication.name. |
|
"n" |
Enable ("y") or disable ("n") Access Control plug-in. |
|
"n" |
If the value is "y", load only the plug-in specified in csapi.plugin.authentication.name. If the value is "n", or if not specified, load all authentication class plug-ins in alphabetical order. For authentication, use each of these plug-ins in alphabetical order. |
|
name |
" " |
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. |
"y" |
If "y", load only the plug-in specified in csapi.plugin.database.name. If "n", or if not specified, load all database plug-ins in alphabetical order. |
|
"cs_caldb _berkeley10" |
If csapi.plugin.loadall is "n" and csapi.plugin.database is "y", load only this plug-in. If not specified or blank (" "), load all database plug-ins in alphabetical order. |
|
"y" |
If "y", load only the plug-in specified in csapi.plugin.datatranslator.name or if not specified, load all data translator class plug-ins in alphabetical order. For data translation, use each of these plug-ins in alphabetical order. |
|
name |
"cs_data translatorcsv10" |
If csapi.plugin.loadall is "n" and csapi.plugin.datatranslator is "y", load this specific plug-in. If blank (" "), or not specified, load all data translator class plug-ins. |
"y" |
Enable ("y") or disable ("n") database-to-output format plug-ins. |
|
"*" |
If csapi.plugin.dbtranslator is "y", then either:
If csapi.plugin.dbtranslator is "n", this setting is ignored. |
|
"n" |
If "y", load all plug-ins found in the plug-ins directory. (Plug-ins have an .so extension.) If "n", only load the specific class of plug-ins flagged by their respective parameters. For example, set csapi.plugin.authentication to "y" to load authentication class plug-ins. |
|
"n" |
If "y", load only the plug-in specified in csapi.plugin.userprefs.name or if not specified, load all user preferences class plug-ins in alphabetical order. For user preferences, use each of these plug-ins in alphabetical order. |
|
" " |
If csapi.plugin.loadall is "n" and csapi.plugin.userprefs is "y", this parameter is used. If not specified or blank (" "), load all user preferences class plug-ins. Otherwise, only load this specific plug-in. |
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-- |