Previous Contents Index Next |
iPlanet Calendar Server Administrator's Guide |
Chapter 7 Calendar Server Command-Line Utilities
iPlanet Calendar Server provides a set of command-line administration utilities that can be invoked from batch, shell, and scripting programs such as Perl. If needed, these utilities use default values from the ics.conf configuration file.The command-line utilities are located in the server-root/cal/bin directory.
This chapter provides the following information:
Running the Command-Line Utilities
Syntax for Command-Line Utilities
Descriptions of Command-Line Utilities (table)Usage Rules for Command-Line Utilities
csattribute
csbackup
cscal
cscomponents
csdb
csexport
csplugin
csresource
csrestore
csschedule
csstart
csstats
csstop
cstool
csuser
Running the Command-Line Utilities
On UNIX systems, run the command-line utilities while logged in as the user and group under which the iPlanet Calendar Server is running (defaults are icsuser and icsgroup) that was specified during installation, or as root. To run the command-line utilities on Windows NT systems, the user must have full administrator privileges.In most cases, you must change to the directory where the utilities are located (server-root/cal/bin). For example:
On Solaris:
On UNIX systems other than Solaris:
- /opt/SUNWics5/cal/bin
On Windows NT systems
- /opt/iPlanet/CalendarServer5/cal/bin
- c:\ProgramFiles\iPlanet\CalendarServer5\cal\bin
Syntax for Command-Line Utilities
The Calendar Server command-line utilities use the following syntax:
utility [ -option [ value ] ] command [ target ] 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 ([]) indicates it is optional. Values that include spaces must be enclosed in quotation marks (" "). Multiple values must be enclosed in quotation marks (""), and each value must be separated by a space unless indicated otherwise, such as the use of a semiclon delimited list in some cases.
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:
If you do not specify a command, the utility lists all options and commands along with examples.
If you do not specify a required password, the utility prompts for it.
The -v (verbose) and -q (quiet) options are available for each utility.
If a command is dangerous (that is, one that can result in data loss), the utility prompts for confirmation before executing the command. Examples of dangerous commands are cscal, which can delete a calendar, and csuser, which can delete a user. The -q (quiet) option, however, disables confirmation prompting.
Descriptions of Command-Line Utilities
csattribute
The csattribute utility manages the Calendar Server attributes in the LDAP server. Commands are:
add an LDAP attribute and value to a specified target (user or resource object).
Requirements
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
Table 7-2 describes the commands available for csattribute.
Table 7-2    csattribute Utility Commands
Command
Description
Adds an LDAP attribute and value to a specified target (user or resource object).
Table 7-2 describes the csattribute utility command options.
Add the LDAP attribute icsCalendar with the value tchang to the user ID TChang:
Delete the LDAP attribute icsCalendar from TChang:
- csattribute -a icsCalendar=tchang add TChang
Display the attributes of TChang:
- csattribute -a icsCalendar delete TChang
- csattribute list TChang
csbackup
The csbackup utility backs up the calendar database, a specified calendar, or a user's default calendar. Commands are:
database to backup the calendar database.
The caldb.conf version file located in the specified backup directory shows the version number of the database that was backed up.calendar to backup a specified calendar.
defcal to backup a user's default calendar.
version displays the version number of the utility currently installed.
For information about csrestore, see "csrestore".
The Calendar Server can be running or stopped.
You must run the utility locally on the machine where the Calendar Server is installed.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csbackup [-q|-v] -f database target
csbackup [-q|-v] -c calid calendar target
csbackup [-q|-v] -a userid [-b basedn] defcal target Table 7-4 describes the commands available for csbackup.
Table 7-5 describes the csbackup utility command options.
Table 7-5    csbackup Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
The user ID of the calendar user to backup. This option is required for the defcal command. There is no default.
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 the Calendar Server examine only the ou=people subtree in the o=sesta.com directory tree.
The calendar ID to backup. This option is required with the calendar command. There is no default.
For more information, see "Calendar Identifiers (calids)".
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.
To prepare the backup file for use with the Solstice Backup or the Legato Networker backup programs. For more information, see Chapter 6 "Backing Up and Restoring Calendar Server Data."
Backup the calendar database to a directory named backupdir:
Backup the calendar with the calendar ID tchang to the file tchang.ics as text/calendar:
- csbackup database backupdir
Backup the default calendar for tchang to the file tchang.xml as text/xml:
- csbackup -c tchang calendar tchang.ics
- csbackup -a tchang defcal tchang.xml
cscal
The cscal utility manages calendars and their properties. Commands are:
create a calendar
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
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
Table 7-6 describes the commands available for the cscal utility.
Table 7-7 describes the cscal utility command options.
Table 7-7    cscal Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
Access Control Entries (ACEs) for a specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks ("").
The default is the calstore.calendar.default.acl parameter in the ics.conf file.
For details about the ACE format, see Chapter 4 "Managing Calendar Server Access Control."
Description (a viewable comment about the purpose of the calendar). The default is no description.
Category. Multiple categories must be enclosed in quotation marks ("") and separated by spaces. The default is no category.
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.
Primary owner. The default setting is the calendar ID (calid), which is usually the same as the user ID.
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):
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:
- cscal -o TChang -n Public_Calendar create 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 -a "@^a^rw^g" -g sports -y JSmith modify 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 double-booking:
- cscal disable tchang
List the properties of tchang:
- cscal -k no enable tchang
List all the properties of tchang:
- cscal list tchang
List all the calendars in the database:
- cscal -v list tchang
Reset the calendar with the calendar ID tchang to the default configuration settings:
- cscal list
Remove a description from the calendar with the calendar ID tchang:
- cscal reset tchang
Remove all categories from the calendar with the calendar ID tchang:
- cscal -d "" modify tchang
Remove other owners from the calendar with the calendar ID tchang:
- cscal -g "" modify tchang
Delete tchang from the calendar database:
- cscal -y "" modify tchang
Delete all calendars from the calendar database whose primary owner is TChang:
- cscal delete tchang
- cscal -o TChang delete
cscomponents
The cscomponents utility manages calendar components: events and tasks (todos). Commands are:
delete events and tasks in a calendar.
list events and tasks in a calendar.
version displays the version number of the utility currently installed.
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
cscomponents [-v|-q] [-e endtime] [-s starttime] [-t event|task]
delete|list calidTable 7-8 describes the commands available for the cscomponent utility.
Table 7-9 describes the cscomponent utility command options.
Delete all 2000 events in the calendar with the calendar ID tchang:
List all events and tasks with details in the calendar with the calendar ID tchang:
- cscomponents -s 20000101T000000Z -e 20001231T000000Z delete tchang
- cscomponents -v list tchang
csdb
The csdb utility manages the calendar databases (calendar, session, and statistics). Commands are:
create a new database. (If a database does not exist when the server is started, the Calendar Server creates one automatically.)
delete an existing calendar database. A database cannot be deleted while it is open (when the Calendar Server is running).
list information about the database.
check a calendar database to determine if any corruption has occurred.
rebuild a corrupted calendar database.
recover a damaged calendar database.
version displays the version number of the utility currently installed.
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server must be stopped for the create, delete, or rebuild commands.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
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|rebuild [dbdir] Table 7-10 describes the commands available for the csdb utility.
Table 7-11 describes the csdb utility command options.
Create new, unpopulated databases in the current directory:
Delete the databases in the current directory:
- csdb -t caldb create
List information about the calendar database in the current directory:
- csdb -t caldb delete
Attempt to recover all damaged databases in the current directory:
- csdb -v -t caldb list
List information about the sessions database in the current directory:
- csdb recover
Attempt to recover a damaged statistics database in the current directory:
- csdb -t sessdb list
- csdb -t statdb recover
csexport
The csexport utility exports a calendar to a file in iCalendar (.ics) or XML (.xml) format. Commands are:
calendar exports a specified calendar.
version displays the version number of the utility currently installed.
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csexport [-v|-q] -c calid calendar outputfile Table 7-12 describes the commands available for the csexport utility.
Table 7-12    csexport Utility Commands
Command
Description
Export the calendar to the specified output file. The data format of the file is determined by the specified file-name extension:
Table 7-13 describes the csexport utility command options.
Export the calendar with the calendar ID tchang in iCalendar (text/calendar) format to a file named tchang.ics:
Exports the calendar with the calendar ID tchang in XML (text/xml) format to a file named tchang.xml:
- csexport -c tchang calendar tchang.ics
- csexport -c tchang calendar tchang.xml
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:
calendar imports a specified calendar.
version displays the version number of the utility currently installed.
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csimport [-v|-q] -c calid calendar inputfile Table 7-14 describes the commands available for the csimport utility.
Table 7-14    csimport Utility Commands
Command
Description
Import the calendar from the specified input file. The data format of the file is determined by the file-name extension:
Table 7-15 describes the csimport utility command options.
Table 7-15    csimport Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
The calendar ID of the calendar to import. This option is required with the calendar command.
If the specified calendar ID already exits, the imported data is merged with the current calendar. There is no default.
For more information, see "Calendar Identifiers (calids)".
Import the calendar with the calendar ID tchang from the file tchang.ics and expect iCalendar (text/calendar file) format:
Import the calendar with the calendar ID tchang from the file tchang.xml and expect XML (text/xml file) format:
- csimport -c tchang calendar tchang.ics
- csimport -c tchang calendar tchang.xml
csplugin
The csplugin manages CSAPI plug-ins configured for your Calendar Server installation. Commands are:
activate loads and starts a specified plug-in.
deactivate shut downs and disables the specified plug-in type and plug-in name. (For descriptions of the supported plug-in types, see the "-t" option in Table A-17.)
list displays all supported plug-ins.
version displays the version number of the utility currently installed.
Requirements
Must be run on the local machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csplugin [-q|-v] [-r] -t ac|attr|auth|locate|lookup|xlate
activate|deactivate plugin
csplugin [-q|-v] list Table 7-16 describes the commands available for the csplugin utility.
Table 7-16    csplugin Utility Commands
Command
Description
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 7-17.)
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 7-17.)
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 7-17.)
Table 7-17 describes the csplugin utility command options.
List details about all the supported plug-ins, including the type, name and the activation status of each plug-in configured for use with this server instance:
Load and enable the lookup type plug-in with the file named mylookup:
- csplugin -v list
Disable the lookup type plug-in with the file named mylookup and then delete it from the plugin directory:
- csplugin activate -t lookup mylookup
- csplugin deactivate -t lookup mylookup -r
csresource
The csresource utility manages calendars for resources such as conference rooms or equipment stored in the LDAP server and the Calendar Server database. (The csresource utility is available only for calendars associated with a resource and returns an error if issued against a user's calendar.) Commands are:
create adds a new resource for a specified calendar ID (calid)
delete removes a resource or all resources
disable disables a resource or all resources
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
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] Table 7-18 describes the commands available for the csresource utility.
Note If the name contains a space in any of the above commands, it must be enclosed in quotation marks (" ").
Table 7-19 describes the csresource utility command options.
Table 7-19    csresource Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
Access Control Entries (ACEs) for the specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks ("").
The default is the resource.default.acl parameter in the ics.conf file.
For information about the ACE format, see Chapter 4 "Managing Calendar Server Access Control.
LDAP base DN (distinguished name) to be used for the specified resource.
Default is taken from the local.ugldapbasedn setting in the ics.conf file.
The icsCalendar attribute. This option is required with the create command. For more information, see "Calendar Identifiers (calids)".
Description: a viewable comment about the purpose of the calendar. The default is no description.
If double booking is allowed for a calendar associated with a resource 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 resource.allow.doublebook setting in the ics.conf file.
Default is taken from the setting service.admin.calmaster.userid in the ics.conf file.
Other owners. Multiple owners must be enclosed in quotation marks ("") and separated by spaces. The default is no other owners.
Display a list of all resource calendars and their LDAP attributes.
Create a resource calendar with the calendar ID (calid) room100 and the viewable name (LDAP cn attribute) MeetingRoom100:
- csresource -v list
Display the LDAP attributes of the resource calendar with the viewable name MeetingRoom100:
- csresource -c room100 create MeetingRoom100
Disable the resource calendar with the viewable name MeetingRoom100:
- csresource -v list MeetingRoom100
Enable the calendar with the resource calendar with the viewable name MeetingRoom100 and allow double-booking:
- csresource disable MeetingRoom100
Delete the resource calendar with the viewable name MeetingRoom100:
- csresource -k yes enable MeetingRoom100
- csresource delete MeetingRoom100
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:
database restores the calendar database.
The caldb.conf version file located in the specified backup directory shows the version number of the database that was backed up.calendar restores a specified calendar.
defcal restores a user's default calendar.
version displays the version number of the utility currently installed.
Calendar Server 5.x csrestore is not compatible with the 2.x version of csrestore. Do not try to restore data that was backed up using Calendar Server 2.x csrestore because data loss can occur.
You must run the utility locally on the machine where the Calendar Server is installed.
If you are restoring the calendar database, the Calendar Server must be stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csrestore [-v|-q] [-f] database inputdir
csrestore [-v|-q] -c calid calendar inputfile
csrestore [-v|-q] -a userid [-b basedn] defcal inputfile Table 7-20 describes the commands available for the csrestore utility.
Table 7-21 describes the csrestore utility command options.
Table 7-21    csrestore Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
The user ID to restore. This option is required with the defcal command. There is no default.
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.
The calendar ID to restore. This option is required with the calendar command. There is no default.
For more information, see "Calendar Identifiers (calids)".
Restore the calendar database stored in the directory backupdir that was previously saved using csbackup:
Restore the calendar with the calendar ID tchang from the file tchang.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using csbackup or csexport:
- csrestore database backupdir
Restore tchang from the calendar database in backupdir that was previously saved using csbackup:
- csrestore -c tchang calendar backupdir/tchang.ics
Restore the default calendar owned by TChang from the file TChang.ics located in the directory backupdir that was previously saved in iCalendar (text/calendar file) format using csbackup or csexport:
- csrestore -c tchang calendar backupdir
- csrestore -a TChang defcal backupdir/TChang.ics
csschedule
The csschedule utility manages schedule entries stored in the Group Scheduling Engine (GSE) queue. Commands are:
list displays entries held in the GSE queue requested by a specifed calendar ID.
delete removes an entry from the GSE queue requested by a specifed calendar ID.
version displays the version number of the utility currently installed.
Requirements
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server must be stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
Table 7-22 describes the commands available for the csschedule utility.
Table 7-23 describes the csschedule utility command options.
List in detail all entries stored in the GSE queue:
List the first ten entries stored in the GSE queue:
- csschedule -v list
List the entries in the GSE queue scheduled between 10:30:45 to 11:30:45 on 12/31/2000:
- csschedule -c 10 list
List the entry in the GSE queue for calendar tchang that is scheduled at 10:30:45, with an offset number of 2 at the time 10:30:45, on 12/31/2000 with the unique identifier 1111, the recurrence ID 0, and the sequence number 0:
- csschedule -s 20001231T103045Z -e 20001231T113045Z list
Delete the entry in the GSE queue for calendar tchang 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 -t 20001231T103045Z -o 2 -u 1111 -r 0 -n 0 list tchang
Delete entries in the GSE that are scheduled between 10:30:45 and 16:30:45 on 12/31/2000:
- csschedule -v -t 20001231T103045Z -o 1 -u 1111 -r 0 -n 0 delete tchang
Delete all entries in the GSE queue:
- csschedule -v -s 20001231T103045Z -e 20001231T163045Z delete
- csschedule -v delete
csstart
Note The Calendar Server provides the csstart and csstop utilities only to provide compatibility with earlier releases. iPlanet recommends that you use the start-cal and stop-cal commands to start and stop the Calendar Server. For more information, see "Starting and Stopping the Calendar Server".
The csstart utility starts the Calendar Server. Commands are:
check determines if all Calendar Server services or a specified service is running.
On Windows NT systems, you can also start the Calendar Server using the Services dialog box accessed from the Control Panel.list displays all Calendar Server services or a specified service.
service starts all Calendar Server services or a specified service.
version displays the version number of the utility currently installed.
You must run the utility locally on the machine where the Calendar Server is installed.
Syntax
csstart [-q|-v] check|list [servicename]
csstart [-q|-v] [-f] service [servicename] Table 7-24 describes the commands available for the csstart utility.
Table 7-25 describes the csstart utility command options.
Start all local Calendar Server services using the default ports and in the default start order:
Start the local Calendar Server HTTP service:
- csstart service
Check if all local Calendar Server services are started:
- csstart service http
List all local Calendar Server services that are started:
- csstart check
- csstart list
csstats
The csstats utility displays Calendar Server statistics. Commands are:
list counter statistics about a specified Calendar Server subsystem.
For more information about counters, see Counters Configuration (counter.conf) File.version displays the version number of the utility currently installed.
You must run the utility locally on the machine where the Calendar Server is installed.
The Calendar Server can be running or stopped.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
csstats [-q|v] [-r registry] [-i iterations] [-s delay]] list [subsystem] Table 7-26 describes the commands available for the csstats utility.
Table 7-27 describes the csstats utility command options.
Display basic information about counters and what types are available:
List counter statistics about the HTTP service subsystem (hpptstat):
- csstats list
List counter statistics about the WCAP subsystem (wcapstat) every 10 seconds for one hour (3600 seconds):
- csstats list http
- csstats -i 3600 -s 10 list wcap
csstop
Note The Calendar Server provides the csstop and csstart utilities only to provide compatibility with earlier releases. iPlanet recommends that you use the start-cal and stop-cal commands to start and stop the Calendar Server. For more information, see "Starting and Stopping the Calendar Server".
The csstop utility stops the Calendar Server. Commands are:
service stops all services or a specified service of the Calendar Server.
On Windows NT systems, you can also stop the Calendar Server using the Services dialog box accessed from the Control Panel.version displays the version number of the utility currently installed.
You must run the utility locally on the machine where the Calendar Server is installed.
Syntax
csstop [-q|-v] check | list [servicename]
csstop [-q|-v] [-f] service [servicename] Table 7-28 describes the commands available for the csstop utility.
.
Table 7-29 describes the csstop utility command options.
Stop all local Calendar Server services:
Stop the local Calendar Server HTTP service:
- csstop service
Check if all local Calendar Server services are stopped:
- csstop service http
List all local Calendar Server services that are started:
- csstop check
- csstop list
cstool
The cstool utility pings a Calendar Server or forces it to refresh its configuration. Commands are:
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.
Note If you modify the settings for parameters in the ics.conf file, you must stop and then restart the Calendar Server for the changes to take effect. See "Editing the ics.conf Configuration File" for more information.
The Calendar Server must be running.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
cstool [-q|-v] [-h host] [-p port] [-t timeout] ping http
cstool [-q|-v] [-h host] refresh [servicename] Table 7-30 describes the commands available for the cstool utility.
Table 7-31 describes the cstool utility command options.
Ping the cshttpd service:
Ping the machine with the host name calserver to see if the Calendar Server cshttpd service is listening on port 80:
- cstool ping http
Force a local Calendar Server to refresh all service's configurations:
- cstool -p 80 -h calserver -p 80 ping http
- cstool refresh
csuser
The csuser utility manages calendar user information stored in an LDAP directory server and the Calendar Server calendar database. Commands are:
check if user is enabled for calendaring.
create and enable a user for calendaring.
disable a user from logging in to the Calendar Server.
enable a user to log on to the Calendar Server.
list a user's calendar attributes.
reset a user's calendar attributes to the default settings.
Requirements
The Calendar Server can be running or stopped.
You must run the utility locally on the machine where the Calendar Server is installed.
The LDAP server that stores calendar user information must be running.
On UNIX systems, you must be logged in as the user and group under which the Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root. On Windows NT systems, you must be logged in as an administrator with full administrator rights to the system.
Syntax
Table 7-32 describes the commands available for the csuser utility.
Table 7-33 describes the csuser utility command options.
Table 7-33    csuser Utility Command Options
Option
Description
Run in verbose mode: Display all available information about the command being performed. Default is off.
Access Control Entries (ACEs) for a specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks ("").
The default is the calstore.calendar.default.acl parameter in the ics.conf file.
For details about the ACE format, see "Services Configuration".
The LDAP base DN (distinguished name) of the specified user ID.
The default is taken from the local.ugldapbasedn parameter in the ics.conf file.
The calendar ID of the default calendar to associate with the specified user ID. The default is the user ID. This command does not create a calendar.
For more information, see "Calendar Identifiers (calids)".
The user's LDAP given name (first name). This option is required. There is no default.
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.
Language code. Default is the value of local.sitelanguage in ics.conf.
The user's LDAP surname (last name). This option is required. There is no default.
The calendar user's password. This option is required. There is no default.
Check if the calendar user JSmith is enabled for calendaring (if the existing calendar user has access to calendar data for this Calendar Server):
Create an LDAP user with the user ID JSmith with the given name John, surname Smith, and the calendar ID JSmithcal:
- csuser check JSmith
Delete the calendar user JSmith:
- csuser -g John -s Smith -y password -c JSmithcal create JSmith
Disable the calendar user JSmith from logging in to the Calendar Server:
- csuser delete JSmith
Enable JSmith for calendaring (lets existing calendar user JSmith log in to the Calendar Server):
- csuser disable JSmith
List all calendar attributes for JSmith:
- csuser enable JSmith
List all calendar user IDs prefixed with the string user:
- csuser -v list JSmith
Reset all calendar attributes for JSmith to the default configuration settings:
- csuser -v list "user*"
- csuser reset JSmith
Previous Contents Index Next
Copyright © 2002 Sun Microsystems, Inc. All rights reserved.
Last Updated January 22, 2002