The cscal utility manages calendars and their properties. Commands are:
create a calendar
delete a calendar
disable a calendar
enable a calendar
list calendars
modify calendar properties and group scheduling access control
reset calendar properties to the default settings
version displays the version number of the utility currently installed
You must run the utility locally on the machine where Calendar Server is installed.
Calendar Server can be running or stopped.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
cscal [-q|-v] [-a aces] [-c charset] [-d description] [-g categories] [-k yes|no] [-l langcode] [-m email] [-n name] [-o owner’s uid] [-y otherowners] create|modify calid cscal [-q|-v] [-o owner’s uid] [-O] delete|reset calid cscal [-q|-v] [-o owner’s uid] [-O] disable|list [calid] cscal [-q|-v] [-k yes|no] [-o owner’s uid] [-O] enable [calid] |
Despite the fact that cscal does not check case when you enter the -o (owner’s uid), the search is case insensitive.
The following table describes the commands available for the cscal utility.
Table D–6 cscal Utility Commands
Command |
Description |
---|---|
create calid |
Creates the calendar specified by calid. Note: If your site is using the LDAP CLD plug-in, all calendars for a specific user must reside on the same back-end server, as indicated by the user’s icsDWPHost LDAP attribute. If you try to create a calendar for the user on a different back-end server, Calendar Server returns an error. |
delete calid |
Deletes the calendar specified by calid. If the -o owner option is specified, deletes all calendars whose primary owner is the specified uid. |
enable [calid] |
Enables the calendar specified by calid. If calid is not specified, enables all calendars. If the -o owner option is specified, enables all calendars whose primary owner is the specified uid. |
disable [calid] |
Disables the calendar specified by calid. If calid is not specified, disables all calendars. If the -o owner option is specified, disables all calendars whose primary owner is the specified uid. |
list [calid] |
Lists properties of the calendar specified by calid. If calid is not specified, lists properties of all calendars. If the -o owner's uid option is specified, lists all calendars whose primary owner is the specified owner uid. Note – ACE string permissions modified in the Calendar Express user interface may appear capitalized in the list command output. This has no significance. The ACE strings are case insensitive. |
modify calid |
Modifies the properties of the calendar specified by calid. |
reset calid |
Resets the properties of the calendar specified by calid to the default configuration settings. |
version |
Displays the version of the utility. |
The following table describes the cscal utility command options.
Table D–7 cscal Utility Command Options
Option |
Description |
---|---|
-v |
Run in verbose mode: Display all available information about the command being performed. Default is off. |
-q |
Run in quiet mode:
|
-a [aces] |
Access Control Entries (ACE's) for a specified calendar. ACE's determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (" "). The default is the calstore.calendar.default.acl parameter in the ics.conf file. For details about the ACE format, see Calendar Access Control. |
-c charset |
Character set. The default is no character set. |
-d description |
Description (a viewable comment about the purpose of the calendar). The default is no description. |
-g category |
Category. Multiple categories must be enclosed in quotation marks ("") and separated by spaces. The default is no category. |
-k yes|no |
Specifies whether double booking is allowed for a user calendar. For example, yes means the calendar can have more than one event scheduled for the same time slot. If the -k option is omitted, the default is taken from the user.allow.doublebook parameter in the ics.conf file. However, the user.allow.doublebook parameter is used only when a calendar is created. After a calendar is created, Calendar Server checks the calendar properties database, ics50calprops.db, to determine if doublebooking is allowed. If you need to change the calendar properties for a calendar to allow or disallow doublebooking, reissue cscal with the -k option. |
-l langcode |
Language code. The default is no language code. |
-m email |
Email address. The default is no email. |
-n name |
Name. The default is no name. |
-o owner |
Primary owner. The default setting is the calendar ID (calid), which is usually the same as the user ID. |
-O |
Specifies all calendars of the primary owner. Default is the named calendar only. |
-y otherowners |
Other calendar owners. Multiple owners must be enclosed in quotation marks ("") and separated by spaces. The default is no other owners. |
Create the calendar with the calendar ID tchang with tchang as the primary owner with the visible name Public_Calendar using the default access control settings (as defined by calstore.calendar.default.acl in the ics.conf file):
cscal -o tchang -n Public_Calendar create tchang
Modify calendar chang so that anyone has read and write access, it is associated with the category sports, and it is co-owned by jsmith@sesta.com:
cscal -a "@^a^rw^g" -g sports -y jsmith@sesta.com modify tchang
Disable the calendar with the calendar ID tchang (users will not be allowed to read, write to, or locate it using the user interface):
cscal disable tchang
Enable the calendar with the calendar ID tchang (users are allowed to read or write to it using the user interface), but it does not allow doublebooking:
cscal -k no enable tchang
List the properties of tchang:
cscal list tchang
List all the properties of tchang:
cscal -v list tchang
List all the calendars in the database:
cscal list
Reset the calendar with the calendar ID tchang to the default configuration settings:
cscal reset tchang
Remove a description from the calendar with the calendar ID tchang:
cscal -d "" modify tchang
Remove all categories from the calendar with the calendar ID tchang:
cscal -g "" modify tchang
Remove other owners from the calendar with the calendar ID tchang:
cscal -y "" modify tchang
Delete tchang from the calendar database:
cscal delete tchang
Delete all calendars from the calendar database whose primary owner is tchang:
cscal -o tchang delete