Appendix A
Command Line Utilities
This appendix provides complete details on the available commands, options, values, syntax notation, and usage rules for the iPlanet Calendar Server command line utilities. It provides supporting reference material for the topics described in Chapter 3 "Administering iPlanet Calendar Server.
Administration for iPlanet Calendar Server is provided by a set of command line utilities. Each utility accepts options from the command line and can be invoked from batch, shell, and scripting programs such as Perl. Where applicable, default values for the available option are taken from the ics.conf configuration file.
Command Line Utility Syntax
iPlanet 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.
option determines which action the command performs. Options are in lowercase and preceded by a hyphen (-), such as -d. An option enclosed in brackets ([]) indicates it is available, but is not required. When available, a combination of two or more options can be used at the same time.
value further qualifies the action specified by an option, such as a description used with the -d option. A value enclosed in brackets ([]) indicates it is available, but is not required. Values that include spaces must be enclosed in quotation marks (" "). Multiple values must be enclosed in quotation marks ("") and each value separated by a space unless indicated otherwise, such as the use of a semiclon delimited list in some cases.
command is an action the utility can perform, such as list. 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 CALID (calendar ID) or USERID.
Usage Rules
The following rules provide general usage guidelines for the command line utilities:
If no command is specified, the utility lists all options and commands along with examples.
When required passwords are not specified, the utility will prompt for it.
The -v (verbose) and -q (quiet) options are available for every utility.
When a command is dangerous (one that can result in data loss), the utility will prompt for confirmation before executing the command. An example of a dangerous command is deleting a calendar or user. The -q (quiet) option, however, disables confirmation prompting.
The version command is available for every command line utility.
Command Line Utility Summary
Table A-1 summarizes the command line utilities.
Table A-1 Command Line Utilities Summary
|
Utility
|
Run from...
|
Use to...
|
|
csattribute
|
local machine
|
manage the LDAP attributes of a calendar user or a calendar resource.
|
|
csbackup
|
local machine
|
backup individual calendars, users, and the calendar database.
|
|
cscal
|
local machine
|
manage calendars and their properties.
|
|
cscomponents
|
local machine
|
manage components in a calendar (components are events and tasks).
|
|
csdb
|
local machine
|
manage the calendar database.
|
|
csexport
|
local machine
|
export a calendar in iCalendar or XML format.
|
|
csimport
|
local machine
|
import a calendar in iCalendar or XML format.
|
|
csplugin
|
local machine
|
view, enable, or disable configured Calendar Server API (CSAPI) plug-ins.
|
|
csresource
|
local machine
|
manage calendar resource objects such as conference rooms and equipment.
|
|
csrestore
|
local machine
|
restore individual calendars, users, and the calendar database.
|
|
csschedule
|
local machine
|
manage scheduling entries in the Group Scheduling Engine (GSE) queue.
|
|
csstart
|
local machine
|
start the iPlanet Calendar Server (on Windows NT, the server can also be started using the NT services dialog accessed from the Control Panel).
|
|
csstats
|
local machine
|
display counters in a Calendar Server.
|
|
csstop
|
local machine
|
stop the iPlanet Calendar Server (on Windows NT, the server can also be stopped using the NT services dialog accessed from the Control Panel).
|
|
cstool
|
local machine
|
ping a running iPlanet Calendar Server instance or command the server to refresh its configuration.
|
|
csuser
|
local machine
|
manage calendar users.
|
csattribute
The csattribute utility lets you manage the iPlanet Calendar Server attributes in the LDAP Server. It provides the following commands:
add creates an LDAP attribute and value for a specified object.
delete removes an LDAP attribute of a specified object.
list displays the LDAP attributes of a specified object.
Syntax
csattribute [-q|-v] -a attribute=val [-t resource | user] add target
or
csattribute [-q|-v] -a attribute[=val] [-t resource | user] delete target
Requirements:
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csattribute -a icsCalendar=calA add userA
The above command adds the LDAP attribute icsCalendar with the value calA to the userID userA.
csattribute -a icsCalendar delete userA
The above command deletes the LDAP attribute icsCalendar from userA.
csattribute list userA
The above command displays the attributes of userA.
Table A-2 describes the commands available for the csattribute utility.
Table A-2 csattribute Utility Commands
|
Command
|
Description
|
|
add target
|
Add an LDAP attribute and value to a specified target (user or resource object).
|
|
list target
|
List the attributes of a target object.
|
|
delete target
|
Delete an attribute from a target.
|
|
version
|
Display the version of the utility.
|
Table A-3 describes the csattribute utility command options.
Table A-3 csattribute Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a attribute=val
or
-a attribute=[val]
|
An LDAP attribute and value:
An attribute is required when using the -a option.
A value is required when the -a option is used with the add command, but is optional when the -a option is used with the delete and list commands.
|
|
-t user|resource
|
The type of target (a user or a resource object). The default is user.
|
csbackup
The csbackup utility lets you backup individual calendars, users, and the calendar database. It provides the following commands:
database to backup the calendar database.
calendar to backup a specified calendar.
defcal to backup a user's default calendar.
version displays the version number of the utility currently installed.
|
Note
|
The version file caldb.conf located in the specified backup directory shows the version number of the database that was backed up.
Do not attempt to restore data backed up using iPlanet Calendar Server version 2.x because the utilities provided in versions 2.x and 5.0 are incompatible and doing so could result in data loss.
|
Syntax
csbackup [-q|-v] [-f] database target
or
csbackup [-q|-v] -c CALID calendar target
or
csbackup [-q|-v] -a USERID [-b BASEDN] defcal target
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csbackup database backupdir
The above example backs up the calendar database to a directory named backupdir.
csbackup -c calA calendar calA.ics
The above example backs up the calendar with the CALID calA to the file calA.ics as text/calendar.
csbackup -a userA defcal userA.xml
The above example backs up the default calendar for user userA to the file userA.xml as text/xml.
Table A-4 describes the commands available for the csbackup utility.
Table A-4 csbackup Utility Commands
|
Command
|
Description
|
|
database target
|
Backup the calendar database to the specified target database output directory.
|
|
calendar CALID target
|
Backup the specified CALID to the specified target output file. The data format of the file is assumed by the file extension, .ics for text/calendar and .xml for text/xml.
|
|
defcal USERID target
|
Backup the default calendar of the specified USERID 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
|
Display the version of the utility.
|
Table A-5 describes the csbackup utility command options.
Table A-5 csbackup Utility Command Options
|
Option
|
Specifies
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a USERID
|
The USERID of the calendar user to backup. This option is required for the defcal command. 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 will occur. For example, if you specify a base DN of ou=people, o=siroe.com, all LDAP search operations executed by iPlanet Calendar Server will examine only the ou=people subtree in the o=siroe.com directory tree.
|
|
-c CALID
|
The CALID to backup. This option is required with the calendar command. There is no default.
|
|
-f
|
To force any existing backup files to be deleted.
|
|
-l
|
To prepare the backup file for use with the Solstace or Legato backup programs. For more information, see Backup and Restore Procedures.
|
cscal
The cscal utility lets you manage calendars and their properties. It provides the following commands:
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
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
or
cscal [-q|-v] [-o owner] delete|disable|list|reset [CALID]
or
cscal [-q|-v] [-k yes|no] [-o owner] enable [CALID]
|
Note
|
Calendar Ids are case sensitive. For example, if you type JSMITH and the calendar ID is actually jsmith, you will not find the right calendar. This distinction differs from email addresses which are not case sensitive, such as jsmith@siroe.com which is equivalent to JSMITH@SIROE.COM.
|
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
cscal -o userA -n calA create calA
The above example creates the calendar with the CALID calA with userA as the primary owner with the visible name exampleA using the default access control settings (as defined by the setting calstore.calendar.default.acl in the ics.conf file).
cscal -a "@^a^rw^g" -g sports -y userB modify calA
The above example modifies calendar calA so that it can be read and written to anyone, is associated with the category sports, and is co-owned by userB.
cscal delete calA
The above example deletes calA (removes it from the calendar database).
cscal -o userA delete
The above example deletes all calendars whose primary owner is userA (removes them from the calendar database).
cscal disable calA
The above example disables the calendar with the CALID calA (users will not be allowed to read, write to, or locate it using the user interface).
cscal -k no enable calA
The above example enables the calendar with the CALID calA (users are allowed to read or write to it using the user interface), but does not allow double-booking.
cscal list calA
The above example lists the properties of calA.
cscal -v list calA
The above example lists all the properties of calA.
cscal list
The above example lists all the calendars in the database.
cscal reset calA
The above example resets the calendar with the CALID calA to the default configuration settings.
cscal -d "" modify calA
The above example removes a description from the calendar with the CALID calA.
cscal -g "" modify calA
The above example removes all categories from the calendar with the CALID calA.
cscal -y "" modify calA
The above example removes other owners from the calendar with the CALID calA.
Table A-6 describes the commands available for the cscal utility.
Table A-6 cscal Utility Commands
|
Command
|
Description
|
|
create CALID
|
Creates the calendar specified by CALID.
|
|
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]
|
Enable the calendar specified as CALID.
If the -o owner option is specified, enables all calendars whose primary owner is the specified owner.
|
|
disable [CALID]
|
Disable the calendar specified as CALID.
If the -o owner option is specified, disables all calendars whose primary owner is the specified owner.
|
|
list [CALID]
|
List properties of the calendar with the specified CALID.
If the -o owner option is specified, lists all calendars whose primary owner is the specified owner.
|
|
modify CALID
|
Modify the properties of the calendar specified as CALID.
|
|
reset [CALID]
|
Reset the properties of the calendar specified as CALID to the default configuration settings.
|
|
version
|
Display the version of the utility.
|
Table A-7 describes the cscal utility command options.
Table A-7 cscal Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a [ACEs]
|
Access Control Entries (ACE) for a specified calendar which determines who can access a calendar for group scheduling and what types of permissions they have, such as create, delete, read, and write privileges. An ACE string, called an Access Control List (ACL), must be enclosed in quotation marks ("").
Default is taken from the setting calstore.calendar.default.acl defined in the ics.conf file.
For details on the ACE format, see 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
|
If double booking is allowed for a calendar. For example, yes means the calendar can have more than one event scheduled for the same time slot. The default is taken from the setting user.allow.doublebook defined in the ics.conf file
Note that this option is available only for calendars associated with a resource and will return an error if issued against a user's calendar.
|
|
-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 CALID which is usually the same as the USERID.
|
|
-y otherowners
|
Other owners. Multiple owners must be enclosed in quotation marks ("") and separated by spaces. The default is no other owners.
|
cscomponents
The cscomponents utility lets you manage components (events and todos) in a calendar. It provides the following commands:
delete events and tasks in a calendar.
list events and tasks in a calendar.
version displays the version number of the utility currently installed.
Syntax
cscomponents [-v|-q] [-e endtime] [-s starttime] [-t event|task] delete|list CALID
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
cscomponents -s 19980101T000000Z -e 19981231T000000Z delete calA
The above command deletes all 1998 events in the calendar with the CALID calA.
cscomponents -v list calA
The above command lists all events and tasks, with details, in the calendar with the CALID calA.
Table A-8 describes the commands available for the cscomponent utility.
Table A-8 cscomponent Utility Commands
|
Command
|
Description
|
|
delete CALID
|
Deletes events in the calendar with the specified CALID.
|
|
list CALID
|
Lists events in the calendar with the specified CALID.
|
|
version
|
Prints the version of the utility to the screen.
|
Table A-9 describes the cscomponent utility command options.
Table A-9 cscomponent Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
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.
|
|
-t event|task
|
Type of components (events or tasks) on which the action is performed. Default is both.
|
csdb
The csdb utility lets you manage the calendar databases. It provides the following commands:
create a new database. If a database does not exist when the server is started, iPlanet Calendar Server creates one automatically.
delete an existing calendar database. A database cannot be deleted while it is open (when the iPlanet Calendar Server is running).
list information about the database.
recover a damaged calendar database.
version displays the version number of the utility currently installed.
Syntax
csdb [-q|-v] [-t caldb|sessdb|statdb] create|delete [dbdir]
or
csdb [-q|-v] [-t caldb|sessdb|statdb] list [dbdir]
or
csdb [-q|-v] [-f] [-t caldb|sessdb|statdb] recover [dbdir]
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server cannot be running if creating or deleting the database.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csdb -t caldb create
The above command creates new, un-populated databases in the current directory.
csdb -t caldb delete
The above command deletes the databases in the current directory.
csdb -v -t caldb list
The above command lists information about the calendar database in the current directory.
csdb recover
The above command attempts to recover all damaged databases in the current directory.
csdb -t sessdb list
The above command lists information about the sessions database in the current directory.
csdb -t statdb recover
The above command attempts to recover a damaged statistics database in the current directory.
Table A-10 describes the commands available for the csdb utility.
Table A-10 csdb Utility Commands
|
Command
|
Description
|
|
create [dbdir]
|
Create databases in the specified database directory. If a database directory is not specified, the current directory is used.
|
|
delete [dbdir]
|
Delete databases in the specified database directory. If a database directory is not specified, the current directory is used.
|
|
list [dbdir]
|
List information about the databases in the specified database directory. If a database directory is not specified, the current directory is used.
|
|
recover [dbdir]
|
Attempt to recover damaged databases in the specified database directory. If a database directory is not specified, the current directory is used.
|
|
version
|
Display the version of the utility.
|
Table A-11 describes the csdb utility command options.
Table A-11 csdb Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-f
|
To force the recovery of the calendar database.
|
|
-t caldb|sessdb|statdb
|
Which database to perform an action on one of the following database types:
caldb (calendar)
sessdb (session)
statdb (statistics)
Note: If -t is not specified all databases are assumed.
|
csexport
The csexport utility lets you export a calendar to a file in iCalendar or XML format. It provides the following commands:
Syntax
csexport [-v|-q] -c CALID calendar outputfile
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csexport -c calA calendar calA.ics
The above command exports the calendar with the CALID calA in iCalendar (text/calendar) format to file named calA.ics.
csexport -c calA calendar calA.xml
The above command exports the calendar with the CALID calA in XML (text/xml) format to file named calA.xml.
Table A-12 describes the commands available for the csexport utility.
Table A-12 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 A-13 describes the csexport utility command options.
Table A-13 csexport Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-c CALID
|
The CALID of the calendar to export. This option is required with the calendar command. There is no default.
|
csimport
The csimport utility lets you import a calendar from a file in iCalendar or XML format that was saved with the csexport utility. It provides the following commands:
Syntax
csimport [-v|-q] -c CALID calendar inputfile
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csimport -c calA calendar calA.ics
The above command imports the calendar with the CALID calA from the file calA.ics and expects iCalendar (text/calendar file) format.
csimport -c calA calendar calA.xml
The above command imports the calendar with the CALID calA from the file calA.xml and expects XML (text/calendar file) format.
Table A-14 describes the commands available for the csimport utility.
Table A-14 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 A-15 describes the csimport utility command options.
Table A-15 csimport Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-c CALID
|
The CALID to of the calendar to import. This option is required with the calendar command.
Note: If the specified CALID already exits, the imported data is merged with the current calendar. There is no default.
|
csplugin
The csplugin utility lets you manage the CSAPI plug-ins configured for your iPlanet Calendar Server installation. It provides the following commands:
activate loads and starts a specified plug-in.
deactivate shut downs and disables the specified plug-in type and plug-in name. (For descriptions of the supported plug-in types, see the "-t" option in Table A-17.)
list displays all supported plug-ins.
version displays the version number of the utility currently installed.
Syntax
csplugin [-q|-v] [-r] -t ac|attr|auth|locate|lookup|xlate activate|deactivate plugin
csplugin [-q|-v] list
Requirements:
Must be run on the local machine on which iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csplugin -v list
The above command list details about all the supported plug-ins, including the type, name and the activation status of each plug-in configured for use with this server instance.
csplugin activate -t lookup mylookup
The above command loads and enables the lookup type plug-in with the filename mylookup.
csplugin deactivate -t lookup mylookup -r
The above command disables the lookup type plug-in with the filename mylookup and then deletes it from the plugin directory.
Table A-16 describes the commands available for the csplugin utility.
Table A-16 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 A-17.)
|
|
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 A-17.)
|
|
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 A-17.)
|
|
version
|
Display the version of the utility.
|
Table A-17 describes the csplugin utility command options.
Table A-17 csplugin Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-r
|
When used with the activate command, physically copies the plug-in into the iPlanet 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..
|
csresource
The csresource utility lets you manage calendar resources objects stored in the LDAP server and in the iPlanet Calendar Server calendar database. It provides the following commands:
create adds a new resource for a specified calid
delete removes a resource or all resources
disable disables a resource or all resources
enable enables a resource or all resources
list displays a single resource or a list of all resources
|
Note
|
The csresource utility is available only for calendars associated with a resource and will return an error if issued against a user's calendar.
Calendar Ids are case sensitive. For example, if you type ROOM1 and the calendar ID is actually room1, you will not find the right calendar. This distinction differs from email addresses which are not case sensitive, such as jsmith@siroe.com which is equivalent to JSMITH@SIROE.COM.
|
Syntax
csresource [-q|-v] [-a ACEs] [-b BASEDN] -c CALID [-d description] [-k yes|no] [-o
owner] [-y otherowners] create name
csresource [-q|-v] [-b BASEDN] delete|disable|enable|list [name]
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csresource list
The above command displays a list of all resource calendars and their LDAP attributes.
csresource -c room1 create meetingroom1
The above command creates a resource calendar with the calendar ID room1 and the viewable name (LDAP cn attribute) meetingroom1.
csresource delete meetinggroom1
The above command deletes the resource calendar with the viewable name meetinggroom1.
csresource disable meetinggroom1
The above command disables the resource calendar with the viewable name meetinggroom1.
csresource -b enable meetinggroom1
The above example enables the calendar with the resource calendar with the viewable name meetinggroom1 (users are allowed to read or write to it using the user interface) and allows double-booking.
csresource -a "@^a^rw^g" -y userB modify meetinggroom1
The above example modifies calendar calA so that it can be read by and written to anyone, is associated with the category sports, and is co-owned by userB.
csresource -v list meetinggroom1
The above command displays the LDAP attributes of the resource calendar with the viewable name meetinggroom1.
Table A-18 describes the commands available for the csresource utility.
Table A-18 csresource Utility Commands
|
Command
|
Description
|
|
create name
|
Create a new resource for a specified calendar ID. If the name contains a space, it must be enclosed in quotation marks (" ").
|
|
delete [name]
|
Delete a resource or, if no resource name is specified, delete all resources. If the name contains a space, it must be enclosed in quotation marks (" ").
|
|
enable [name]
|
Enable a resource or, if no resource name is specified, enable all resources. all resources. If the name contains a space, it must be enclosed in quotation marks (" ").
|
|
disable [name]
|
Disable a resource or, if no resource name is specified, disable all resources. If the name contains a space, it must be enclosed in quotation marks (" ").
|
|
list [name]
|
Display a single resource calendar or, if no resource name is specified, list of all resource calendars. If the name contains a space, it must be enclosed in quotation marks (" ").
|
Table A-19 describes the csresource utility command options.
Table A-19 csresource Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a ACEs
|
Access Control Entries (ACE) for a specified calendar which determines who can access a calendar associated with a resource object (such as a conference room) for group scheduling and what types of permissions they have, such as create, delete, read, and write privileges. An ACE string, called an Access Control List (ACL), must be enclosed in quotation marks ("").
Default is taken from the setting resource.default.acl defined in the ics.conf file.
For details on the ACE format, see Access Control.
|
|
-b BASEDN
|
The LDAP base DN (distinguished name) to be used for the specified resource. The default is taken from the setting local.ugldapbasedn defined in the ics.conf file.
|
|
-c CALID
|
The icsCalendar attribute. This option is required with the create command and there is no default.
|
|
-d description
|
Description (a viewable comment about the purpose of the calendar). The default is no description.
|
|
-k yes|no
|
If double booking is allowed for a calendar associated with a resource object such as a conference room. If yes, the resource calendar can have more than one event scheduled for the same time slot.
.Default is taken from the setting resource.allow.doublebook defined in the ics.conf file.
|
|
-o owner
|
Primary owner.
Default is taken from the setting service.admin.calmaster.userid defined 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.
|
csrestore
The csrestore utility lets you restore individual calendars, users, and the calendar database. It provides the following commands:
database restores the calendar database.
calendar restores a calendar.
defcal restores a user's default calendar.
version displays the version number of the utility currently installed.
|
Note
|
The version file caldb.conf located in the specified backup directory shows the version number of the database that was backed up.
Do not attempt to restore data backed up using iPlanet Calendar Server version 2.x because the utilities provided in versions 2.x and 5.0 are incompatible and doing so could result in data loss.
|
Syntax
csrestore [-v|-q] [-f] database inputdir
or
csrestore [-v|-q] -c CALID calendar inputfile
or
csrestore [-v|-q] -a USERID [-b BASEDN] defcal inputfile
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server cannot be running if restoring the calendar database.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csrestore database backupdir
The above command restores the calendar database stored in the directory backupdir that was previously saved using the csbackup command line utility.
csrestore -c calA calendar backupdir/calA.ics
The above command restores the calendar with the CALID calA from the file calA.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using the csbackup or csexport utility.
csrestore -c calA calendar backupdir
The above command restores calA from the calendar database in backupdir that was previously saved using csbackup.
csrestore -a userA defcal backupdir/userA.ics
The above command restores the default calendar owned by userA from the file userA.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using the csbackup or csexport utility.
Table A-20 describes the commands available for the csrestore utility.
Table A-20 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 will destroy and overwrite all previous contents of the current calendar database.
|
|
calendar inputfile
|
Restore the specified CALID 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 CALID already exists, the calendar's data is cleared before it is restored.
|
|
defcal inputfile
|
Restore the default calendar of the specified USERID 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 A-21 describes the csrestore utility command options.
Table A-21 csrestore Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a USERID
|
The USERID to restore. This option is required with the defcal command. There is no default.
|
|
-b BASEDN
|
The LDAP base DN (distinguished name) to be used for the specified USERID. 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 CALID (calendar ID) to restore. This option is required with the calendar command. There is no default.
|
csschedule
The csschedul utility lets you manage schedule entries stored in the Group Scheduling Engine (GSE) queue. It provides the following commands:
list displays entries held in the Group Scheduling Engine queue requested by a specifed calendar ID.
delete removes an entry from the Group Scheduling Engine queue requested by a specifed calendar ID.
version displays the version number of the utility currently installed.
Syntax
csschedule [-q|-v] [-c count] [-e endtime] [-s starttime] [-t scheduletime -o offset] [-u
uid] list [CALID]
or
csschedule [-q|-v] [-t scheduletime -o offset -u UID -n sequencenumber -r RID] list [CALID]
or
csschedule [-q|-v] [-t scheduletime -o offset -u UID -n sequencenumber -r RID] delete CALID
or
csschedule [-q|-v] [-s starttime] [-e endtime] delete [CALID]
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server must be stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csschedule -v list
The above command lists, in detail, all entries stored in the GSE queue.
csschedule -c 10 list
The above command lists the first ten entries stored in the GSE queue.
csschedule -s 20001231T103045Z -e 20001231T113045Z list
The above command lists the entries in the GSE queue in the scheduled between 10:30:45 to 11:30:45 on 12/31/2000.
csschedule -v -t 20001231T103045Z -o 2 -u 1111 -r 0 -n 0 list calA
The above command lists the entry in the GSE queue for calendar calA that is scheduled at 10:30:45, with an offset number of 2 at the time 10:30:45, on 12/31/2000 with the unique identifier 1111, the recurrence ID 0, and the sequence number 0.
csschedule -v -t 20001231T103045Z -o 1 -u 1111 -r 0 -n 0 delete calA
The above command deletes this one entry in the GSE queue for calendar calA at 13:30:45, the first offset at time 13:30:45, on 12/31/2000, with the unique identifier 1111, the recurrence ID 0, and the sequence number 0.
csschedule -v -s 20001231T103045Z -e 20001231T163045Z delete
The above command deletes entries in the GSE that are scheduled between 10:30:45 and 16:30:45 on 12/31/2000.
csschedule -v delete
The above command deletes all entries in the GSE queue.
Table A-22 describes the commands available for the csschedule utility.
Table A-22 csschedule Utility Commands
|
Command
|
Description
|
|
list
|
Display entries held in the Group Scheduling Engine queue requested by a specified calendar ID.
|
|
delete
|
Delete an entry from the Group Scheduling Engine queue requested by a specified calendar ID.
|
|
version
|
Display the version of the utility.
|
Table A-23 describes the csschedule utility command options.
Table A-23 csschedule Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-c count
|
The number of GSE queue entries to list. For example, enter 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 task (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.
|
csstart
The csstart utility lets you start the iPlanet Calendar Server. It provides the following commands:
check determines if all iPlanet Calendar Server services or a specified service is running.
list displays all the iPlanet Calendar Server services or a specified service.
service starts all iPlanet Calendar Server services or a specified service.
version displays the version number of the utility currently installed.
Syntax
csstart [-q|-v] check|list [servicename]
or
csstart [-q|-v] [-f] service [servicename]
Requirements:
Examples
csstart service
The above command starts all iPlanet Calendar Server services using the default ports and in the default start order.
csstart service http
The above command starts the local iPlanet Calendar Server HTTP service.
csstart check
The above command checks if all local iPlanet Calendar Server services are started.
csstart list
The above command lists all local iPlanet Calendar Server services that are started.
csstart service
The above command starts all local iPlanet Calendar Server services.
Table A-24 describes the commands available for the csstart utility.
Table A-24 cscstart Utility Commands
|
Command
|
Description
|
|
check [servicename]
|
Check if a specified iPlanet Calendar Server service is running, or check if all Calendar Server services are running if a service name is not specified, where servicename can be one of the following:
ens — a generic event registration and notification service that can be shared by other iPlanet servers
notify — Calendar Server notification daemon
admin — Calendar Server administration daemon (installation required on every server machine)
dwp — Calendar Server dataBase daemon (only started with remote database configuration)
http — Calendar Server daemon
|
|
list [servicename]
|
List all iPlanet Calendar Server services (or a specified service) and their session IDs.
|
|
service [servicename]
|
Start a specified iPlanet Calendar Server service or all of its services if no service name is specified. The iPlanet Calendar Server 5.0 services should be started in the following order:
ens — a generic event registration and notification service that can be shared by other iPlanet servers
notify — Calendar Server notification daemon
admin — Calendar Server administration daemon (installation required on every server machine)
dwp — Calendar Server dataBase daemon (only started with remote database configuration)
http — Calendar Server daemon
For more information on iPlanet Calendar Server services, see the following sections:
|
|
version
|
Display the version of the utility.
|
Table A-25 describes the csstart utility command options.
Table A-25 csstart Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-f
|
To force a specified iPlanet Calendar Server service (or all currently running iPlanet Calendar Server services if a service is not specified) to:
Stop (similar to a kill -9 command on Unix or stopping a service from the Windows NT Task Manager if previous attempts have failed).
Cleanup any database problems.
Start all services.
.Note: It is recommended that you use the stop-cal and start-cal utilities instead to stop and start the Calendar Server.
|
|
-q
|
Quiet mode which:
Default is off.
|
csstats
The csstats utility lets you display the statistics of iPlanet Calendar Server and provides the following commands:
list displays various statistics that are recorded as counters on the iPlanet Calendar Server.
version displays the version number of the utility currently installed.
|
Note
|
For more information on counters, see Counters.
|
Syntax
csstats [-q|v] [-r registry] [-i iterations] [-s delay]] list [subsystem]
Requirements:
Must be run locally on the machine where iPlanet Calendar Server is installed.
The iPlanet Calendar Server can be running or stopped.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
csstats list
The above command displays basic information about counters and what types are available.
csstats list http
The above command lists counter statistics about the HTTP service subsystem (hpptstat).
csstats -i 3600 -s 10 list wcap
The above command lists counter statistics about the wcap subsystem (wcapstat) every 10 seconds for one hour (3600 seconds).
Table A-26 describes the commands available for the csstats utility.
Table A-26 csstats Utility Commands
|
Command
|
Description
|
|
list [subsystem]
|
List counter statistics about a specified iPlanet Calendar Server subsystem or, if one 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
http — HTTP transport
response — server response times
sess — server session status
wcap — Web Calendar Access Protocol
|
|
Version
|
Display the version of the utility.
|
Table A-27 describes the csstats utility command options.
Table A-27 csstats Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
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: server-root/cal/bin/counter/counter. For example:
/opt/SUNWics5/cal/bin/counter/counter
|
|
-s delay
|
The amount of time (in seconds) to wait before displaying each statistical lookup. The default is 1 second.
|
csstop
The csstop utility lets you stop the iPlanet Calendar Server. It provides the following commands:
Syntax
csstop [-q|-v] check | list [servicename]
or
csstop [-q|-v] [-f] service [servicename]
Requirements:
Examples
csstop service
The above command stops all local iPlanet Calendar Server services.
csstop service http
The above command stops the local iPlanet Calendar Server HTTP service.
csstop check
The above command checks if all local iPlanet Calendar Server services are stopped.
csstop list
The above command lists all local iPlanet Calendar Server services that are started.
Table A-28 describes the commands available for the csstop utility.
Table A-28 csstop Utility Commands
|
Command
|
Description
|
|
check [servicename]
|
Check if a specified iPlanet Calendar Server service is running or check if all of its services are running if no service name is specified.
Check if a specified iPlanet Calendar Server service is running (or check if all Calendar Server services are running if a service name is not specified) where servicename can be one of the following:
ens — a generic event registration and notification service that can be shared by other iPlanet servers
notify — Calendar Server notification daemon
admin — Calendar Server administration daemon (installation required on every server machine)
dwp — Calendar Server dataBase daemon (only started with remote database configuration)
http — Calendar Server daemon
|
|
list [servicename]
|
List all iPlanet Calendar Server services (or a specified service) and their session IDs.
|
|
service [servicename]
|
Stop a specified iPlanet Calendar Server service or all of its services if no service name is specified. The iPlanet Calendar Server 5.0 services should be started in the following order and stopped in the reverse order as follows:
ens — a generic event registration and notification service that can be shared by other iPlanet servers
notify — Calendar Server notification daemon
admin — Calendar Server administration daemon (installation required on every server machine)
dwp — Calendar Server database daemon (only started with remote database configuration)
http — Calendar Server daemon
For more information on iPlanet Calendar Server services, see the following sections:
|
|
version
|
Display the version of the utility.
|
Table A-29 describes the csstop utility command options.
Table A-29 csstop Utility Command Options
|
Option
|
Specifies
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-f
|
To force an iPlanet Calendar Server service to stop (similar to a kill -9 command on Unix or stopping a service from the Windows NT Task Manager) if previous attempts have failed.
This option is available only with the service command.
Note: It is recommended that you use the stop-cal and start-cal utilities instead to stop and start the Calendar Server.
|
cstool
The cstool utility lets you ping an iPlanet Calendar Server or force it to refresh its configuration. It provides the following commands:
ping a Calendar Server service to verify that it is listening on a specified port.
refresh a Calendar Server service to force it to refresh its configuration settings.
version lets you display the version number of the utility currently installed.
Syntax
cstool [-q|-v] [-h host] [-p port] [-t timeout] ping [servicename]
or
cstool [-q|-v] [-h host] refresh [servicename]
Requirements:
The Calendar Server must be running.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
Examples
cstool ping http
The above command pings the cshttpd service.
cstool -p 80 -h calserver -p 80 ping http
The above command pings the machine with the host name calserver to see if the iPlanet Calendar Server cshttpd service is listening on port 80.
cstool refresh
The above command forces a local iPlanet Calendar Server to refresh the cshttpd service's configuration.
Table A-30 describes the commands available for the cstool utility.
Table A-30 cstool Utility Commands
|
Command
|
Description
|
|
ping [http]
|
Ping the iPlanet Calendar Server http service.
|
|
refresh [hostname]
|
Force iPlanet Calendar Server to refresh the configuration of a specified service or if no service is specified, refresh the configuration of all iPlanet Calendar Server services. The iPlanet Calendar Server service options are:
|
|
version
|
Display the version of the utility.
|
Table A-31 describes the cstool utility command options.
Table A-31 cstool Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-h host
|
Specifies host name of the machine on which iPlanet Calendar Server is running. The default value is set at installation and taken from the setting local.hostname defined in the ics.conf file. Use this option if you are accessing an iPlanet Calendar Server running on a remote machine.
|
|
-p port
|
The port of the specified service of 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.
|
csuser
The csuser utility lets you manage calendar user information stored in an LDAP directory server and in the iPlanet Calendar Server calendar database. It provides the following commands:
check if user is enabled for calendaring.
create and enable a user for calendaring.
delete a user.
disable a user from logging in to the iPlanet Calendar Server.
enable a user to log on to the iPlanet Calendar Server.
list a user's calendar attributes.
reset a user's calendar attributes to the default settings.
|
Note
|
This tool is provided as a convenience, but it is recommended that administrators provision user attributes using a directory service or a customized user provisioning mechanism.
|
Syntax
csuser [-q|-v] [-a ACEs] [-b BASEDN] [-c CALID] -g givenname [-k yes|no] -s
surname -y userpassword create USERID
or
csuser [-q|-v] [-b BASEDN] check|delete|disable|enable|list|reset [USERID]
Requirements:
The Calendar Server can be running or stopped.
Must be run locally on the machine where iPlanet Calendar Server is installed.
The LDAP server that stores calendar user information must be running.
On Unix systems, must be run while logged in as the user and group under which the iPlanet Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.
|
Note
|
User IDs are sometimes case sensitive and sometimes not case sensitive depending on the application. For example, in iPlanet Calendar Server 5.0, the user jsmith can log in as JSMITH or jsmith, but other users cannot invite JSMITH as an attendee, but instead must specify jsmith.
Calendar Ids are case sensitive. For example, if you type ROOM1 and the calendar ID is actually room1, you will not find the right calendar. This distinction differs from email addresses which are not case sensitive, such as jsmith@siroe.com which is equivalent to JSMITH@SIROE.COM.
|
Examples
csuser check JSmith
The above example checks if the calendar user JSmith is enabled for calendaring (if the existing calendar user has access to calendar data on this iPlanet Calendar Server).
csuser -g John -s Smith -y password -c JSmithcal create JSmith
The above example creates an LDAP user with the USERID JSmith with the givenname John, surname Smith, and the CALID JSmithcal.
csuser delete JSmith
The above example deletes the user JSmith.
csuser disable JSmith
The above example disables the calendar user JSmith from logging in to the iPlanet Calendar Server.
|
Note
|
The command in this example prevents JSmith from being able to log in to the iPlanet Calendar Server to access calendar data, but JSmith's data is not deleted from the local calendar database. If JSmith is currently logged in to the iPlanet Calendar Server, JSmith retains access to calendar data until he logs off.
|
csuser enable JSmith
The above example enables JSmith for calendaring (lets existing calendar user JSmith log on to the iPlanet Calendar Server).
csuser -v list JSmith
The above example lists all calendar attributes for JSmith.
csuser -v list "user*"
The above example lists all calendar USERIDs prefixed with the string: user
csuser reset JSmith
The above example resets all calendar attributes for JSmith to the default configuration settings.
Table A-32 describes the commands available for the csuser utility.
Table A-32 csuser Utility Commands
|
Command
|
Description
|
|
check [USERID]
|
Check if the specified USERID is enabled for calendaring. If a USERID is not specified, it checks all users.
|
|
create USERID
|
Create the specified USERID and enable this user to log in to the iPlanet Calendar Server.
|
|
delete [USERID]
|
Delete the specified USERID. If no USERID is specified, all users are deleted.
|
|
disable [USERID]
|
Disable the specified USERID for calendaring. The utility defines http as the value of the nswcalDisallowAccess attribute. If no USERID is specified, all users are disabled.
|
|
enable [USERID]
|
Enable the specified USERID for calendaring. (The utility adds the specified CALID to the nswcalCALID attribute.) If a USERID is not specified, all users are enabled.
|
|
list [USERID]
|
List all the calendar attributes for the specified USERID. If no USERID is specified, it lists all enabled users.
|
|
reset [USERID]
|
Reset all calendar attributes for a USERID to the default settings. If no USERID is specified, it resets the attribute of all users.
|
|
version
|
Display the version of the utility.
|
Table A-33 describes the csuser utility command options.
Table A-33 csuser Utility Command Options
|
Option
|
Specifies...
|
|
-v
|
Verbose mode which displays all available information about the command being performed. Default is off.
|
|
-q
|
Quiet mode which:
Default is off.
|
|
-a [ACEs]
|
Access Control Entries (ACE) for a specified calendar which determines who can access a calendar for group scheduling and what types of permissions they have, such as create, delete, read, and write privileges. An ACE string, called an Access Control List (ACL), must be enclosed in quotation marks ("").
Default is taken from the setting calstore.calendar.default.acl defined in the ics.conf file.
For details on the ACE format, see Access Control.
|
|
-b BASEDN
|
The LDAP base DN (distinguished name) of the specified USERID. The default is taken from the setting local.ugldapbasedn defined in the ics.conf file.
|
|
-c CALID
|
The CALID of the default calendar to associate with the specified USERID. The default is the USERID.
Note: This command does not create a calendar.
|
|
-g givenname
|
The user's LDAP givenname (first name). This option is required. There is no default.
|
|
-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.
|
|
-s surname
|
The user's LDAP surname (last name). This option is required. There is no default.
|
|
-y userpassword
|
The calendar user's password. This option is required. There is no default.
|