test

Sun Java System Calendar Server 6 2005Q4 Administration Guide

Appendix D Calendar Server Command-Line Utilities Reference

csattribute

csexport

csrestore

csbackup

csimport

csschedule

cscal

csmonitor

csstats

csclean

csplugin

cstool

cscomponents

cspurge

csuser

csdb

csrename

start-cal

csdomain

csresource

stop-cal

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.

Note –

Error messages from these administrative tools are written to the admin.log file found in the csdb directory.

This chapter provides the following information:

Running the Command-Line Utilities

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

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

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.

Short Description of Command-Line Utilities

The following table gives a short description the Calendar Server command-line utilities.

Table D–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 Delegated Administrator. 

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

csrename

Allows the renaming of user ID's. Causes the whole database to be rewritten. 

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. 

csstats

Displays counters in a Calendar Server. 

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 user or resource LDAP entry attributes. Commands are:

Note –

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

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

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

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

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: 

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

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’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]
Note –

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: 

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

Examples

csclean

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.

Requirements

Syntax


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

The following table describes the csclean utility command options.

Table D–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. 

domain

Specifies the domain in which to remove calendars for all users and resources. 

An asterisk (*) removes all calendars for all users and resources in all domains.

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

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

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. A start time of 0 means from the beginning of time. The default is 0.

Note –

For tasks only, you must specify this option and the starting date specified must be a DateTime Z String. If the option is not specified, or the option is specified but the value is set to zero, all tasks for this calendar will be deleted.

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

Option  

Description  

-a

For rebuild command only, rebuilds only the alarms database.

-V

Must be passed in with -a for rebuilding the alarms database. Causes verify to be run against all databases, including alarms.

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

  • caldb (calendar)

  • sessdb (session)

  • statdb (statistics)

    Note: If -t is not specified, csdb operates on all database groups, except for the check, recover and rebuild 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

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: 

  • 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 1 – Specifies the node under which all users and resources are created. For example: o=node2,o=node1,o=sesta

  • For LDAP Schema 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

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. 

icsExtendedDomainPrefs Attribute: csdomain Utility

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)

Other LDAP Directory Attributes: csdomain Utility

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

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 

(undefined) 

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 default time-zone ID. 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

The following table describes the commands available for the csexport utility.

Table D–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 filename extension: 

  • .ics for iCalendar (text/calendar)

  • .xml for XML (text/xml)

version

Display the version of the utility. 

The following table describes the csexport utility command options.

Table D–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:

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.

Requirements

Syntax


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

The following table describes the commands available for the csimport utility.

Table D–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 filename extension: 

  • .ics for iCalendar (text/calendar)

  • .xml for XML (text/xml)

version

Display the version of the utility. 

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: 

  • 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 Creating Calendar Unique Identifiers (calid's).

Examples

csmonitor

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

Syntax


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

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

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

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

The following table describes the cspurge utility command options.

Table D–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

csrename

The csrename utility allows you to rename one or more calendar users. This utility renames calendar users as follows:

The csrename utility is located in the following directory:

cal_svr_base/SUNWics5/cal/sbin

Requirements

Before you run csrename, you must first:

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.

Syntax

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.

Examples

csresource

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:

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

Note –

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: 

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

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 – Caution –

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.

Requirements

Syntax


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

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

  • .ics for iCalendar (text/calendar).

  • .xml for XML (text/xml).

version

Display the version of the utility. 

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: 

  • 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 Creating Calendar Unique Identifiers (calid's).

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]

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

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

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]

The following table describes the commands available for the csstats utility.

Table D–34 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. 

The following table describes the csstats utility command options.

Table D–35 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

cstool

The cstool utility can ping one of the following:

The cstool utility can also display its version number.

The cstool can not be used to ping the following processes:

Note –

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.

Requirements

Syntax


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: 

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

Note –

This utility does not enable users for Address Book as is required for Communications Express. This will have to be done manually with ldapmodify.

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

Requirements

Syntax


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: 

  • Display no information if the operation is successful (errors, if they occur, are displayed).

  • Suppress confirmation prompting for dangerous commands.

    Default is off.

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

Examples

Note –

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.

start-cal

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

Requirements

Syntax


start-cal

Example

cal_svr_base/SUNWics5/cal/sbin/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

cal_svr_base/SUNWics5/cal/sbin/stop-cal

For more information, see Starting and Stopping Calendar Server.