Sun logo      Previous      Contents      Index      Next     

Sun ONE Calendar Server 6.0 Administrator's Guide

Chapter 11
Calendar Server Command-Line Utilities

Sun ONE Calendar Server provides a set of command-line administration utilities that can be invoked from batch, shell, and scripting programs such as Perl. 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/opt/SUNWics5/cal/sbin

This chapter provides the following information:


Running the Command-Line Utilities

On Solaris Systems, run the command-line utilities while logged in as the user and group under which Calendar Server is running that was specified during installation (defaults are icsuser and icsgroup) or as root. In most cases, you must change to the directory where the utilities are located.For example, on Solaris Systems: cal_svr_base/opt/SUNWics5/cal/sbin.

Syntax for Command-Line Utilities

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 semiclon 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.

Usage Rules for Command-Line Utilities

The following rules are general usage guidelines for the command line utilities:

Return Code in Scripts

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.


Table of Command-Line Utilities

Table 11-1 describes the Calendar Server command-line utilities.

Table 11-1  Calendar Server Command-Line Utilities Summary 

Utility

Description

csattribute

Manages the LDAP attributes of a calendar user or resource.

csbackup

Backs up individual calendars, users, and the calendar database.

cscal

Manages calendars and their properties.

csclean

Removes user and resource calendars for Calendar Server users whose status attribute (inetUserStatus) has been marked as “deleted” by the Sun ONE Identity Server commadmin utility.

cscomponents

Manages calendar components: events and tasks (todos).

csdb

Manages the calendar database.

csdomain

Manages Calendar Server attributes in the LDAP directory for a hosted (virtual) domain.

csexport

Exports a calendar in iCalendar (.ics) or XML (.xml) format.

csimport

Imports a calendar in iCalendar (.ics) or XML (.xml) format.

csmonitor

Monitors LDAP connectivity, log files, and available disk space for the calendar database.

csplugin

Views, enables, or disables configured Calendar Server API (CSAPI) plug-ins.

cspurge

Allows the manual purge of entries in the Delete Log database (ics50deletelog.db).

csresource

Manages calendar resources such as conference rooms and equipment.

csrestore

Restores individual calendars, users, and the calendar database.

csschedule

Manages scheduling entries in the Group Scheduling Engine (GSE) queue.

csstart

Starts the Calendar Server processes.

csstats

Displays counters in a Calendar Server.

csstop

Stops the Calendar Server processes.

csstored.pl

Performs archival operations for the calendar database and log files

cstool

Pings a running Calendar Server instance.

csuser

Manages calendar users.

start-cal

Starts all Calendar Server processes.

stop-cal

Stops all Calendar Server processes.

 


csattribute

The csattribute utility manages Calendar Server attributes in the LDAP server. Commands are:

Requirements

Syntax

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

Table 11-2 describes the commands available for csattribute.

Table 11-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.

Table 11-3 describes the csattribute utility command options.

Table 11-3  csattribute 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-a attribute =value

or

-a attribute [=value ]

An LDAP attribute and value:

  • attribute is required when using the -a option.
  • value is required when the -a option is used with the add command, but it is optional when the -a option is used with the delete and list commands.

-t user | resource

Type of target (user or resource object). Default is user.

[-d domain]

Specifies the name of a hosted (virtual) domain. Default is taken from the service.defaultdomain parameter in the ics.conf file.

Examples


csbackup

The csbackup utility backs up the calendar database, a specified calendar, or a user’s default calendar. Commands are:

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".

Requirements

Syntax

csbackup [-q|-v] -f database target

csbackup [-q|-v] -c calid calendar target

csbackup [-q|-v] -a userid [-b basedn] defcal target

Table 11-4 describes the commands available for csbackup.

Table 11-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/opt/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 non-existent 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.

Table 11-5 describes the csbackup utility command options.

Table 11-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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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 "Calendar Identifiers (calids)".

-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 Solstice™ Backup™ or the Legato Networker™ backup programs. For more information, see Chapter 6, "Backing Up and Restoring Calendar Server Data".”

Examples


cscal

The cscal utility manages calendars and their properties. Commands are:

Requirements

Syntax

cscal [-q|-v] [-a aces] [-c charset] [-d description] [-g categories]

  [-k yes|no] [-l langcode] [-m email] [-n name] [-o owner]

  [-y otherowners] create|modify calid

cscal [-q|-v] [-o owner] [-O] delete|reset calid

cscal [-q|-v] [-o owner] [-O] disable|list [calid]

cscal [-q|-v] [-k yes|no] [-o owner] [-O] enable [calid]

Table 11-6 describes the commands available for the cscal utility.

Table 11-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, you must create a new calendar on the same back-end server where the user’s calendars reside (or will reside), as indicated by the user’s icsDWPHost LDAP attribute. If you try to create a calendar 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 owner.

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 owner.

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 owner.

list [calid]

Lists properties of the calendar specified by calid. If calid is not specified, lists properties of all calendars.

If the -o owner option is specified, lists all calendars whose primary owner is the specified owner.

ACE strings are case insensitive. If the ACE has been modified through the Calendar Express GUI, the ACE characters that were modified show up in upper case.

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.

Table 11-7 describes the cscal utility command options.

Table 11-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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-a [aces]

Access Control Entries (ACEs) for a specified calendar. ACEs 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 Chapter 4, "Managing Calendar Server 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 (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 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.

Examples


csclean

The csclean utility removes user and resource calendars for Calendar Server users whose status attribute (inetUserStatus) has been marked as “deleted” by the Sun ONE Identity Server commadmin utility.

Deletion of a Calendar Server user involves these steps:

  1. Run the commadmin utility user delete command to mark the either the user or the user’s calendar service as “deleted”.
  2. Run the csclean utility to remove the user’s corresponding calendars from the calendar database and to mark the user’s the inetUserStatus attribute as “removed”.
  3. Run the commadmin utility domain purge command to remove the user’s LDAP entry.

For information about the commadmin utility, refer to the Sun ONE Messaging and Collaboration 1.0 User Management Utility Installation and Reference Guide.

Sun ONE Messaging Server uses a similar utility, msuerpurge, to remove users from the message store. For information about the msuserpurge utility, refer to the Sun ONE Messaging Server 6.0 Reference Manual.

Requirements

Syntax

csclean [-q | -v] [-g graceperiod] clean domain

Table 11-8 describes the csclean utility command options.

Table 11-8  csclean Utility Command Options

Option

Description

-q

Run in quiet mode:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-v

Run in verbose mode: Display all available information about the command being performed. Default is off.

-g graceperiod

Specifies the number of days to have elapsed since the calendar service was deleted for a user.

The default is 10 days.

Examples


cscomponents

The cscomponents utility manages calendar components: events and tasks (todos). Commands are:

Requirements

Syntax

cscomponents [-v|-q] [-e endtime] [-s starttime] [-t event|task]

  delete|list calid

Table 11-9 describes the commands available for the cscomponents utility.

Table 11-9  cscomponents Utility Commands 

Command

Description

delete calid

Deletes events and tasks in the calendar with the specified calendar ID.

Special Note: For deleting tasks, you must specify the -s starting time. It must be a non-zero TimeDate Z string. You can lose data if you do not specify the starting date. If the date is not specified, all tasks are removed 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.

Table 11-10 describes the cscomponent utility command options.

Table 11-10  cscomponent 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-e endtime

Ending time of the components. An end time of 0 means to the end of time. The default is 0.

-s starttime

Starting time of the components. For events, a start time of 0 means from the beginning of time. The default is 0.

Do not use the default (0)for tasks. Leaving this parameter off, or specifying zero (0) when deleting tasks, causes all tasks in the calendar to be deleted. You must have a valid DateTime Z string for the value of this option when deleting tasks.

-t event|task

Type of components (events or tasks) on which the action is performed. Default is both.

Examples


csdb

The csdb utility manages the calendar databases (calendar, session, and statistics). Commands are:

Requirements

Syntax

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 [-g] [dbdir [dstdir]]

Table 11-11 describes the commands available for the csdb utility.

Table 11-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 databases in the specified database directory. If a database directory is not specified, the current directory is used.

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 [-g] [dbdir [dstdir]]

Scans a calendar database 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.

The -g option rebuilds the group scheduling engine (GSE) database in addition to the other calendar databases, and dstdir specifies an optional destination directory.

version

Displays the version of the utility.

Table 11-12 describes the csdb utility command options.

Table 11-12  csdb 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-f

Force the recovery of the calendar database.

-g

For the rebuild command, rebuild the group scheduling engine (GSE) database in addition to the other calendar databases.

-t caldb|sessdb|statdb

Specifies the target database:

  • caldb (calendar)
  • sessdb (session)
  • statdb (statistics)

Note: If -t is not specified, csdb operates on all databases, except for the check and rebuilt commands, which operate only on caldb (calendar).

Examples


csdomain

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:

Requirements

Syntax

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

Table 11-13 describes the commands available for the csdomain utility.

Table 11-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.

Table 11-14 describes the csdomain utility command options.

Table 11-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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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:

  • For LDAP Schema v.1–Specifies the node under which all users and resources are created. For example: o=node2,o=node1,o=sesta
  • For LDAP Schema v.2–Specifies the name of the node created for this domain. For example: o=west.sesta.com

If node is not specified, the domain name is used.

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

LDAP Attributes and Property Names

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.

icsAllowRights Attribute: csdomain Utility

Table 11-15 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 programatically in bitwise operations, you must first convert its string value to an integer.

Table 11-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 writeable calendars.

Corresponding ics.conf parameter:

service.wcap.allowpublicwriteablecalendars

3

n/a

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,7

n/a

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

 

If set (bit 15=1), do not allow user to set the user's default calendar ID (nswccalid) using the WCAP set_userprefs command.

Corresponding ics.conf parameter:

service.wcap.allowsetprefs.nswccalid

16-31

n/a

Not used in the current release.

 

icsExtendedDomainPrefs Attribute: csdomain Utility

Table 11-16 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) or is not present (service.virtualdomain.support = no”), Calendar Server uses the corresponding ics.conf parameter as the default value.

Table 11-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 Calendar Express 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 Calendar Express 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)

 

Other LDAP Directory Attributes: csdomain Utility

Table 11-17 describes other LDAP attributes and properties that you can set with the csdomain utility.

Table 11-17  Other LDAP Directory Attributes for the csdomain Utility 

LDAP Attribute

Property Name

Description

icsAllowedServiceAccess

allowedAccessProtocols

Specifies whether access to Calendar Server is allowed. If set to “http”, access is denied. If set to any other value, access is allowed.

Calendar Server uses this attribute only if the icsStatus attribute is not set.

icsDefaultAccess

userDefaultAcl

Specifies the ACL for a newly created user calendar.

Corresponding ics.conf parameter:

calstore.calendar.default.acl

icsDomainNames

searchDomainNames

Specifies the external domains that this domain can search when looking for calendars or users.

Corresponding ics.conf parameter: none

icsDWPBackEndHosts

 

Specifies the default back-end host (DNS name) for a user if a host name is not explicitly provided. This attribute is used when Calendar Server is in LDAP CLD mode.

icsStatus

statusCalendarDomain

Specifies that status of Calendar Server:

  • active–Calendar Server is accessible.
  • inactive–Calendar Server is inaccessible. Calendars remain in the database and Calendar Server LDAP attributes remain unchanged.
  • deleted–Calendar Server is inaccessible. because the person is marked as deleted.
  • removed–Calendars have been removed from the calendar database.

If icsStatus is set, its value overrides the icsAllowedServiceAccess attribute.

If icsStatus is not set, Calendar Server uses the icsAllowedServiceAccess attribute.

icsTimezone

timezone

Specifies the time-zone ID used when importing files. For example, America/New_York or Asia/Tokyo.

For the supported time zones, refer to the timezones.ics file.

Examples


csexport

The csexport utility exports a calendar to a file in iCalendar (.ics) or XML (.xml) format. Commands are:

Requirements

Syntax

csexport [-v|-q] -c calid calendar outputfile

Table 11-18 describes the commands available for the csexport utility.

Table 11-18  csexport Utility Commands 

Command

Description

calendar outputfile

Export the calendar to the specified output file. The data format of the file is determined by the specified file-name extension:

  • .ics for iCalendar (text/calendar)
  • .xml for XML (text/xml)

version

Display the version of the utility.

Table 11-19 describes the csexport utility command options.

Table 11-19  csexport 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-c calid

The calendar ID of the calendar to export. This option is required with the calendar command. There is no default.

Examples


csimport

The csimport utility imports a calendar from a file in iCalendar (ics) or XML format that was saved with the csexport utility. Commands are:

Requirements

Syntax

csimport [-v|-q] -c calid calendar inputfile

Table 11-20 describes the commands available for the csimport utility.

Table 11-20  csimport Utility Commands 

Command

Description

calendar inputfile

Import the calendar from the specified input file. The data format of the file is determined by the file-name extension:

  • .ics for iCalendar (text/calendar)
  • .xml for XML (text/xml)

version

Display the version of the utility.

Table 11-21 describes the csimport utility command options.

Table 11-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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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 "Calendar Identifiers (calids)".

Examples


csmonitor

The csmonitor utility is a script that performs these monitoring functions:

Syntax

csmonitor [ -k | -c | -help]

Table 11-22 describes the commands for the csmonitor utility.

Table 11-22  csmonitor Utility Command Options

Parameter

Description

-k

Stops csmonitor.

-c

Backs up the csmonitor log and purges it.

-help

Displays the csmonitor usage.

Table 11-23 csmonitor.

Table 11-23  csmonitor Configuration Parameters 

Parameter

Description

service.monitor.continuous

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.

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 the disk occupation where the calendar database (csdb directory) resides 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".

 


csplugin

The csplugin manages CSAPI plug-ins configured for your Calendar Server installation. Commands are:

Requirements

Syntax

csplugin [-q|-v] [-r] -t ac|attr|auth|locate|lookup|xlate

  activate|deactivate plugin

csplugin [-q|-v] list

Table 11-24 describes the commands available for the csplugin utility.

Table 11-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 11-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 11-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 11-25.)

version

Display the version of the utility.

Table 11-25 describes the csplugin utility command options.

Table 11-25  csplugin 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-r

When used with the activate command, physically copies the plug-in into the Calendar Server plugin directory.

When used with the deactivate command, deletes the plug-in from the plugin directory.

-t type

Specifies one of the following supported types of plug-ins:

  • ac — augments or overrides the default group scheduling access control mechanism.
  • attr — augments or overrides the mechanism for storing and retrieving user attributes.
  • auth — augments or overrides the login authentication mechanism.
  • locate — retrieves a calendar ID for the specified qualified URL.
  • lookup — augments or overrides the default calendar lookup mechanism.
  • xlate — augments or overrides the format translation of incoming and outgoing data.

Examples


cspurge

The cspurge utility allows the manual purge of entries in the Delete Log database (ics50deletelog.db).

Requirements

Syntax

cspurge [-q|-v] -e endtime -s starttime

Table 11-26 describes the cspurge utility command options.

Table 11-26  cspurge 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-e endtime

Specifies the ending time in GMT (also referred to as UTC or Zulu). This value is up to (less than) the specified time.

The default is 0, which means to the end of time.

-s starttime

Specifies the starting time in GMT (also referred to as UTC or Zulu). This value includes (greater than or equal to) the specified time.

The default is 0, which means from the beginning of time.

Examples


csresource

The csresource utility manages calendars for resources such as conference rooms or equipment stored in the LDAP server and the Calendar Server database. (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:

Requirements

Syntax

csresource [-q|-v] [-a aces] [-b basedn] [-d domain] [-t description] [-k yes|no] [-o owner] [-y otherowners] -m email -c calid create name

csresource [-q|-v] [-b basedn] [-d domain]

delete|disable|enable [name]

csresource [-q|-v] [-b basedn] [-d domain] [-h host] list [name]

Table 11-27 describes the commands available for the csresource utility.

Table 11-27  csresource Utility Commands 

Command

Description

create name

Create a new resource for a specified calendar ID.

delete [name]

Delete a resource or, if no resource name is specified, delete all resources.

enable [name]

Enable a resource or, if no resource name is specified, enable all resources.

disable [name]

Disable a resource or, if no resource name is specified, disable all resources.

list [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.


Note

If the name contains a space in any of the above commands, it must be enclosed in quotation marks (" ").


Table 11-28 describes the csresource utility command options.

Table 11-28  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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-a [aces]

Access Control Entries (ACEs) for the specified calendar. ACEs 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 Chapter 4, "Managing Calendar Server 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 "Calendar Identifiers (calids)".

-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 (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 [name]

Display the version of the utility.

Examples


csrestore

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:

The caldb.conf version file located in the specified backup directory shows the version number of the database that was backed up.


Caution

Calendar Server 6.x csrestore is not compatible with the 2.x version of csrestore. Do not try to restore data that was backed up using Calendar Server 2.x csrestore because data loss can occur.


Requirements

Syntax

csrestore [-v|-q] [-f] database inputdir

csrestore [-v|-q] -c calid calendar inputfile

csrestore [-v|-q] -a userid [-b basedn] defcal inputfile

Table 11-29 describes the commands available for the csrestore utility.

Table 11-29  csrestore Utility Commands 

Command

Description

database inputdir

Restore the calendar database from the specified input directory or input file that contains a backup calendar database. This operation overwrites all previous contents of the current calendar database.

calendar inputfile

Restore the specified calendar ID from the specified input file. The data format of the file is determined by the file-name extension:

  • .ics for iCalendar (text/calendar).
  • .xml for XML (text/xml).

If the specified calendar ID already exists, the calendar's data is cleared before it is restored.

defcal inputfile

Restore the default calendar of the specified user ID from the input file specified. The data format of the file is determined by the file-name extension:

  • .ics for iCalendar (text/calendar).
  • .xml for XML (text/xml).

version

Display the version of the utility.

Table 11-30 describes the csrestore utility command options.

Table 11-30  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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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 "Calendar Identifiers (calids)".

Examples


csschedule

The csschedule utility manages schedule entries stored in the Group Scheduling Engine (GSE) queue. Commands are:

Requirements

Syntax

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]

Table 11-31 describes the commands available for the csschedule utility.

Table 11-31  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.

Table 11-32 describes the csschedule utility command options.

Table 11-32  csschedule 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-c count

The number of GSE queue entries to list. For example, specify 10 if you want to examine ten entries in the queue.

-e endtime

The ending time of the entry in the GSE queue where 0 means to the end of time. The default is 0.

-n sequencenumber

The sequence number of the event or task in the queue.

-o offset

An offset number for a schedule time. The offset number uniquely identifies an entry in the GSE queue when there is more than one entry scheduled at the same time.

-r rid

The recurrence ID (RID) of the event or todo. An RID is a semicolon delimited list of strings that identify each occurrence of a recurring event or todo.

-s starttime

The starting time of the entry in the GSE queue where 0 means from the beginning of time. The default is 0.

-t scheduletime

A schedule time, for example: 20001231T103045Z

-u uid

The unique identifier (UID) of an entry in the GSE queue.

Examples


csstart


Note

Calendar Server provides the csstart and csstop utilities only to provide compatibility with earlier releases.

It is recommended that you use the start-cal and stop-cal commands to start and stop Calendar Server. For more information, see "Starting and Stopping Calendar Server".


The csstart utility starts Calendar Server. Commands are:

Requirements

Syntax

csstart [-q|-v] check|list [servicename]

csstart [-q|-v] [-f] service [servicename]

Table 11-33 describes the commands available for the csstart utility.

Table 11-33  csstart Utility Commands 

Command

Description

check | list
[
servicename]

Check if a specified Calendar Server service is running, or check if all Calendar Server services are running if a service name is not specified

Or list all Calendar Server services (or a specified service) and their session IDs.

servicename can be one of the following:

  • ens — a generic event registration and notification service that can be shared by other Sun ONE servers
  • notify — Calendar Server notification service
  • admin — Calendar Server administration service (required on every server machine)
  • dwp — Calendar Server Database service (started only with remote database configuration)
  • http — Calendar Server HTTP service

service [servicename]

Start a specified Calendar Server service or all of its services if no service name is specified. Calendar Server services should be started in the following order:

1.  ens — a generic event registration and notification service that can be shared by other Sun ONE servers

2.  notify — Calendar Server notification service

3.  admin — Calendar Server administration service (required on every server machine)

4.  dwp — Calendar Server database service (started only with remote database configuration)

5.  http — Calendar Server HTTP service

For more information about Calendar Server services, see the following sections:

version

Display the version of the utility.

Table 11-34 describes the csstart utility command options.

Table 11-34  csstart Utility Command Options 

Option

Description

-v

Run in verbose mode: Display all available information about the command being performed. Default is off.

-f

To force a specified Calendar Server service (or all currently running services if a service is not specified) to:

1.  Stop (similar to a kill -9 command).

2.  Cleanup any database problems.

3.  Start all services.

Note: It is recommended that you use the stop-cal and start-cal utilities instead to stop and start Calendar Server.

-q

Run in quiet mode:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

Examples


csstats

The csstats utility displays Calendar Server statistics. Commands are:

For more information about counters, see Counters Configuration (counter.conf) File.

Requirements

Syntax

csstats [-q|v] [-r registry] [-i iterations] [-s delay]] list [subsystem]

Table 11-35 describes the commands available for the csstats utility.

Table 11-35  csstats Utility Commands 

Command

Description

list [subsystem]

List counter statistics about a specified Calendar Server subsystem or. If subsystem is not specified, display basic information about the available subsystems, which are:

  • alarm — monitoring of services alarm notifications
  • auth — login authentication
  • db — calendar database
  • disk — disk usage monitoring
  • gse — Group Scheduling Engine (GSE)
  • http — HTTP transport
  • response — server response times
  • sess — server session status
  • wcap — Web Calendar Access Protocol

Version

Display the version of the utility.

Table 11-36 describes the csstats utility command options.

Table 11-36  csstats 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-i iterations

The number of times to repeat statistical lookups. Default is 1.

-r registry

The name and location of the file that stores counter statistics. The default is:

/opt/SUNWics5/cal/lib/counter/counter

-s delay

The amount of time (in seconds) to wait before displaying each statistical lookup. The default is 1 second.

Examples


csstop


Note

Calendar Server provides the csstop and csstart utilities only to provide compatibility with earlier releases.

It is recommended that you use the start-cal and stop-cal utilities to start and stop Calendar Server. For more information, see "Starting and Stopping Calendar Server".


The csstop utility stops Calendar Server. Commands are:

 

Requirements

Syntax

csstop [-q|-v] check | list [servicename]

csstop [-q|-v] [-f] service [servicename]

Table 11-37 describes the commands available for the csstop utility.

Table 11-37  csstop Utility Commands  

Command

Description

check | list
[servicename]

Check if a specified Calendar Server service is running or check if all services are running if a service name is not specified.

Or list all Calendar Server services or a specified service and their session IDs. servicename can be one of the following:

  • ens — a generic event registration and notification service that can be shared by other Sun ONE servers.
  • notify — Calendar Server notification service.
  • admin — Calendar Server administration service (admin is required on every server machine).
  • dwp — Calendar Server database service (started only with remote database configuration).
  • http — Calendar Server HTTP service.

service [servicename]

Stop a specified Calendar Server service or all of its services if no service name is specified. Calendar Server services should be started in the following order and stopped in the reverse order:

1.  ens — a generic event registration and notification service that can be shared by other Sun ONE servers.

2.  notify — Calendar Server notification service.

3.  admin — Calendar Server administration service (admin is required on every server machine).

4.  dwp — Calendar Server dataBase service (only started with remote database configuration).

5.  http — Calendar Server HTTP service.

For more information about Calendar Server services, see the following sections:

version

Display the version of the utility.

.

Table 11-38 describes the csstop utility command options.

Table 11-38  csstop 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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-f

To force a Calendar Server service to stop (similar to a kill -9 command if previous attempts have failed).

This option is available only with the service command.

Examples


csstored.pl

The csstored.pl utility is a Perl script that performs the following online or “hot” archival operations for the calendar database and log files:

For documentation about the Berkeley database utilities, refer to the Sleepycat Software Web site:

http://www.sleepycat.com/docs/utility/index.html

Requirements

Syntax

perl csstored.pl

Table 11-39 describes the parameters in the ics.conf file used by the csstored.pl utility:

Table 11-39  Parameters in the ics.conf file Used by the csstored.pl Utility

Parameter

Description

caldb.berkeleydb.homedir.path

Specifies the path to the directory where the calendar database files are stored.

The default is “.”, which specifies this directory:

cal_svr_base/var/opt/SUNWics5/csdb

caldb.berkeleydb.archive.path

Specifies the path for the calendar database archive directory. There is no default.

To run csstored.pl, specify a path that is different from the calendar database directory and the “hot” backup directory.

caldb.berkeleydb.hotbackup.path

Specifies the path to the “hot” backup directory. There is no default.

To run csstored.pl, specify a path that is different from the calendar database directory and the archive directory.

caldb.berkeleydb.archive.enable

Enables (“yes”) or disables (“no”) the archive option for the calendar database.

The default is “no”.

To run csstored.pl, set this parameter to “yes“.

caldb.berkeleydb.hotbackup.enable

Enables (“yes”) or disables (“no”) the “hot” backup option for the calendar database

The default is “no”.

To run csstored.pl, set this parameter to “yes“.

caldb.berkeleydb.circularlogging

Specifies (“yes” or “no”) whether to remove database checkpoint files after their transactions are synchronized.

The default is “yes”.

To run csstored.pl, set this parameter to “no“.

caldb.berkeleydb.archive.interval

Specifies the interval in seconds for archiving the calendar database.

The default is “120” seconds.

 


cstool

The cstool utility pings Calendar Server or either the cshttpd service or Event Notification Service (ENS). cstool also forces Calendar Server or a specific service to refresh its configuration. Commands are:


Note

In the current release, do not use cstool refresh to refresh a configuration. Instead, use the stop-cal and start-cal utilities to stop and then restart Calendar Server.

For more information, see "Starting and Stopping Calendar Server" and "Editing the ics.conf Configuration File".


Requirements

Syntax

cstool [-q|-v] [-h host] [-p port] [-t timeout] ping [http|ens]

cstool [-q|-v] [-h host] refresh [servicename]

Table 11-40 describes the commands available for the cstool utility.

Table 11-40  cstool Utility Commands 

Command

Description

ping [http|ens]

Ping the cshttpd or ENS service.

refresh [servicename]

Force Calendar Server to refresh the configuration of a specified service, or if no service is specified, refresh the configuration of all Calendar Server services. The Calendar Server service options are:

  • admin (csadmind service)
  • dwp (csdwpd service)
  • http (cshttpd service)
  • notify (csnotifyd service)

version

Display the version of the utility.

Table 11-41 describes the cstool utility command options.

Table 11-41  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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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.

Examples


csuser

The csuser utility manages calendar user information stored in an LDAP directory server and the Calendar Server calendar database. Commands are:

If you are using Sun ONE Directory Server, you can also use the ldapsearch and ldapmodify utilities. For information about these utilities, see the Sun ONE Directory Server documentation on the following Web site:

http://docs.sun.com/coll/S1_DirectoryServer_52

Requirements

Syntax

csuser [-q|-v] [-a aces] [-b basedn] -m email [-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

Table 11-42 describes the commands available for the csuser utility.

Table 11-42  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 nswcalDisallowAccess attribute.

enable userid

Enable the specified user ID for calendaring. (The utility adds the specified calendar ID to the nswcalCALID attribute.)

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 -h server-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.

Table 11-43 describes the csuser utility command options.

Table 11-43  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:

  • Display no information if the operation is successful (errors, if they occur, are displayed).
  • Suppress confirmation prompting for dangerous commands.

Default is off.

-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 (ACEs) for a specified calendar. ACEs 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".

-b [basedn]

The LDAP base DN (distinguished name) of the specified user ID.

The default is taken from the local.ugldapbasedn parameter in the ics.conf file.

-c [calid]

The calendar ID of the default calendar to associate with the specified user ID. The default is the user ID. This option is not valid for the create command.

For more information, see "Calendar Identifiers (calids)".

-f filename

File name to specify a password for options that require a password (-y parameter). If you are running csuser from a script, it is recommended for added security that you 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.

-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

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.

-y userpassword

The required calendar user's password. There is no default.

Examples


start-cal

The start-cal utility starts the Calendar Server services in this order:

Requirements

Syntax

start-cal

Example

./start-cal

For more information, see "Starting and Stopping Calendar Server".


stop-cal

The stop-cal utility stops all Calendar Server services.

Requirements

Syntax

stop-cal

Example

./stop-cal

For more information, see "Starting and Stopping Calendar Server".



Previous      Contents      Index      Next     


Copyright 2003 Sun Microsystems, Inc. All rights reserved.