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

  • Usage Rules for Command-Line Utilities

• Descriptions of Command-Line Utilities (table)

  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:

  /opt/SUNWics5/cal/bin

• On UNIX systems other than Solaris:

  /opt/iPlanet/CalendarServer5/cal/bin

• On Windows NT systems

  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 ]

where:

utility is the executable name of the utility, such as cscal or csuser.

option determines which action the command performs. Options are in lowercase and preceded by a hyphen (-), such as -d. An option enclosed in brackets ([]) is optional. If indicated, of two or more options can be used at the same time.

value further qualifies the action specified by option, such as a description used with the -d option. A value enclosed in brackets ([]) 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.

• The version command is available for each utility.

Descriptions of Command-Line Utilities

---

Table 7-1    iPlanet Calendar Server Command-Line Utilities Summary 

Utility	Description
csattribute	Manages the LDAP attributes of a calendar user or resource.
csbackup	Backs up individual calendars, users, and the calendar database.
cscal	Manages calendars and their properties.
cscomponents	Manages calendar components: events and tasks (todos).
csdb	Manages the calendar database.
csexport	Exports a calendar in iCalendar (.ics) or XML (.xml) format.
csimport	Imports a calendar in iCalendar (.ics) or XML (.xml) format.
csplugin	Views, enables, or disables configured Calendar Server API (CSAPI) plug-ins.
csresource	Manages calendar resources such as conference rooms and equipment.
csrestore	Restores individual calendars, users, and the calendar database.
csschedule	Manages scheduling entries in the Group Scheduling Engine (GSE) queue.
csstart	Starts the Calendar Server.
csstats	Displays counters in a Calendar Server.
csstop	Stops the Calendar Server.
cstool	Pings a running Calendar Server instance or causes the Calendar Server to refresh its configuration.
csuser	Manages calendar users.

 

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

• list the attributes of a target object.

• delete an attribute from a target.

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

csattribute [-q|-v] -a attribute =value [-t resource | user] add target

csattribute [-q|-v] -a attribute [=value ] [-t resource | user]   delete target

csattribute [-q | -v] [-t resource | user] list target

Table 7-2 describes the commands available for csattribute.

Table 7-2    csattribute Utility Commands 

Command	Description
add target	Adds an LDAP attribute and value to a specified target (user or resource object).
list target	Lists the attributes of a target object.
delete target	Deletes an attribute from a target.
version	Displays the version of the utility.

Table 7-2 describes the csattribute utility command options.

Table 7-3    csattribute Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a attribute =value or -a attribute [=value ]	An LDAP attribute and value: attribute is required when using the -a option. value is required when the -a option is used with the add command, but it is optional when the -a option is used with the delete and list commands.
-t user | resource	The type of target (user or resource object). Default is user.

Examples

• Add the LDAP attribute icsCalendar with the value tchang to the user ID TChang:

  csattribute -a icsCalendar=tchang add TChang

• Delete the LDAP attribute icsCalendar from TChang:

  csattribute -a icsCalendar delete TChang

• Display the attributes of 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.

• calendar to backup a specified calendar.

• defcal to backup a user's default calendar.

• version displays the version number of the utility currently installed.

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

For information about csrestore, see "csrestore".

Requirements

• 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-4    csbackup Utility Commands 

Command	Description
database target	Backs up the calendar database to the specified target database directory. By default, the target database directory is: server-root/cal/bin/target-directory If you specify only the target database directory, do not include the slash (/) before the directory name. For example: csbackup database backupdir
calendar calid target	Backs up the specified calendar ID to the specified target output file. The data format of the file is assumed by the file extension, .ics for text/calendar or .xml for text/xml.
defcal userid target	Backs up the default calendar of the specified user ID to the specified target file. The data format of the file is assumed by the file extension, .ics for text/calendar and .xml for text/xml.
version	Displays the version of the utility.

Table 7-5 describes the csbackup utility command options.

Table 7-5    csbackup Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a userid	The user ID of the calendar user to backup. This option is required for the 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 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.
-c calid	The calendar ID to backup. This option is required with the calendar command. There is no default. For more information, see "Calendar Identifiers (calids)".
-f	To force any existing backup files to be deleted. In the current release, you must include the -f option if the backup target directory already exists, even if the directory is empty.
-l	To prepare the backup file for use with the Solstice™ Backup™ or the Legato Networker™ backup programs. For more information, see Chapter 6 "Backing Up and Restoring Calendar Server Data."

Examples

• Backup the calendar database to a directory named backupdir:

  csbackup database backupdir

• Backup the calendar with the calendar ID tchang to the file tchang.ics as text/calendar:

  csbackup -c tchang calendar tchang.ics

• Backup the default calendar for tchang to the file tchang.xml as text/xml:

  csbackup -a tchang defcal tchang.xml

cscal

---

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

• create a calendar

• delete a calendar

• disable a calendar

• enable a calendar

• list calendars

• modify calendar properties and group scheduling access control

• reset calendar properties to the default settings

• version displays the version number of the utility currently installed

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

cscal [-q|-v] [-a aces] [-c charset] [-d description] [-g categories]   [-k yes|no] [-l langcode] [-m email] [-n name] [-o owner]   [-y otherowners] create|modify calid

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

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

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

Table 7-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]	Enables the calendar specified as calid. If the -o owner option is specified, enables all calendars whose primary owner is the specified owner.
disable [calid]	Disables the calendar specified as calid. If the -o owner option is specified, disables all calendars whose primary owner is the specified owner.
list [calid]	Lists 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	Modifies the properties of the calendar specified by calid.
reset [calid]	Resets the properties of the calendar specified by calid to the default configuration settings.
version	Displays the version of the utility.

Table 7-7 describes the cscal utility command options.

Table 7-7    cscal Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a [aces]	Access Control Entries (ACEs) for a specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (""). The default is the calstore.calendar.default.acl parameter in the ics.conf file. For details about the ACE format, see Chapter 4 "Managing Calendar Server Access Control."
-c charset	Character set. The default is no character set.
-d description	Description (a viewable comment about the purpose of the calendar). The default is no description.
-g category	Category. Multiple categories must be enclosed in quotation marks ("") and separated by spaces. The default is no category.
-k yes|no	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.
-l langcode	Language code. The default is no language code.
-m email	Email address. The default is no email.
-n name	Name. The default is no name.
-o owner	Primary owner. The default setting is the calendar ID (calid), which is usually the same as the user ID.
-y otherowners	Other calendar owners. Multiple owners must be enclosed in quotation marks("") and separated by spaces. The default is no other owners.

Examples

• Create the calendar with the calendar ID tchang with TChang as the primary owner with the visible name Public_Calendar using the default access control settings (as defined by calstore.calendar.default.acl in the ics.conf file):

  cscal -o TChang -n Public_Calendar create tchang

• Modify calendar chang so that anyone has read and write access, it is associated with the category sports, and it is co-owned by JSmith:

  cscal -a "@^a^rw^g" -g sports -y JSmith modify tchang

• Disable the calendar with the calendar ID tchang (users will not be allowed to read, write to, or locate it using the user interface):

  cscal disable tchang

• Enable the calendar with the calendar ID tchang (users are allowed to read or write to it using the user interface), but it does not allow double-booking:

  cscal -k no enable tchang

• List the properties of tchang:

  cscal list tchang

• List all the properties of tchang:

  cscal -v list tchang

• List all the calendars in the database:

  cscal list

• Reset the calendar with the calendar ID tchang to the default configuration settings:

  cscal reset tchang

• Remove a description from the calendar with the calendar ID tchang:

  cscal -d "" modify tchang

• Remove all categories from the calendar with the calendar ID tchang:

  cscal -g "" modify tchang

• Remove other owners from the calendar with the calendar ID tchang:

  cscal -y "" modify tchang

• Delete tchang from the calendar database:

  cscal delete tchang

• Delete all calendars from the calendar database whose primary owner is TChang:

  cscal -o TChang delete

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 calid

Table 7-8 describes the commands available for the cscomponent utility.

Table 7-8    cscomponent Utility Commands 

Command	Description
delete calid	Deletes events and tasks in the calendar with the specified calendar ID.
list calid	Lists events and tasks in the calendar with the specified calendar ID.
version	Prints the version of the utility to the screen.

Table 7-9 describes the cscomponent utility command options.

Table 7-9    cscomponent Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-e endtime	Ending time of the components. An end time of 0 means to the end of time. The default is 0.
-s starttime	Starting time of the components. 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.

Examples

• Delete all 2000 events in the calendar with the calendar ID tchang:

  cscomponents -s 20000101T000000Z -e 20001231T000000Z delete tchang

• List all events and tasks with details in the calendar with the calendar ID 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-10    csdb Utility Commands 

Command	Description
create [dbdir]	Creates the databases in the specified database directory. If a database directory is not specified, the current directory is used. If a database does not exist when the server is started, the Calendar Server creates one automatically.
delete [dbdir]	Deletes the databases in the specified database directory. If a database directory is not specified, the current directory is used. A database cannot be deleted while it is open (when the Calendar Server is running).
list [dbdir]	Lists information about the databases in the specified database directory. If a database directory is not specified, the current directory is used.
recover [dbdir]	Attempts to recover damaged databases in the specified database directory. If a database directory is not specified, the current directory is used.
check [dbdir]	Scans a calendar database in the specified database directory to determine if any corruption has occurred and reports the results in its output. If a database directory is not specified, the current directory is used.
rebuild [dbdir]	Scans a calendar database in the specified database directory to determine if any corruption has occurred and if so, generates a rebuilt calendar database (.db files). If a database directory is not specified, the current directory is used.
version	Displays the version of the utility.

Table 7-11 describes the csdb utility command options.

Table 7-11    csdb Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-f	Force the recovery of the calendar database.
-t caldb|sessdb|statdb	Specifies the target database: caldb (calendar) sessdb (session) statdb (statistics) Note: If -t is not specified, csdb operates on all databases, except for the check and rebuilt commands, which operate only on caldb (calendar).

Examples

• Create new, unpopulated databases in the current directory:

  csdb -t caldb create

• Delete the databases in the current directory:

  csdb -t caldb delete

• List information about the calendar database in the current directory:

  csdb -v -t caldb list

• Attempt to recover all damaged databases in the current directory:

  csdb recover

• List information about the sessions database in the current directory:

  csdb -t sessdb list

• Attempt to recover a damaged statistics database in the current directory:

  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
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 7-13 describes the csexport utility command options.

Table 7-13    csexport Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-c calid	The calendar ID of the calendar to export. This option is required with the calendar command. There is no default.

Examples

• Export the calendar with the calendar ID tchang in iCalendar (text/calendar) format to a file named tchang.ics:

  csexport -c tchang calendar 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.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
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 7-15 describes the csimport utility command options.

Table 7-15    csimport Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-c calid	The calendar ID of the calendar to import. This option is required with the calendar command. If the specified calendar ID already exits, the imported data is merged with the current calendar. There is no default. For more information, see "Calendar Identifiers (calids)".

Examples

• Import the calendar with the calendar ID tchang from the file tchang.ics and expect iCalendar (text/calendar file) format:

  csimport -c tchang calendar tchang.ics

• 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.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
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 7-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 7-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 7-17.)
version	Display the version of the utility.

Table 7-17 describes the csplugin utility command options.

Table 7-17    csplugin Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-r	When used with the activate command, physically copies the plug-in into the Calendar Server plugin directory. When used with the deactivate command, deletes the plug-in from the plugin directory.
-t type	Specifies one of the following supported types of plug-ins: ac — augments or overrides the default group scheduling access control mechanism. attr — augments or overrides the mechanism for storing and retrieving user attributes. auth — augments or overrides the login authentication mechanism. locate — retrieves a calendar ID for the specified qualified URL. lookup — augments or overrides the default calendar lookup mechanism. xlate — augments or overrides the format translation of incoming and outgoing data..

Examples

• 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 -v list

• Load and enable the lookup type plug-in with the file named mylookup:

  csplugin activate -t lookup mylookup

• Disable the lookup type plug-in with the file named mylookup and then delete it from the plugin directory:

  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

• enable enables a resource or all resources

• list displays a single resource or a list of 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.

Table 7-18    csresource Utility Commands 

Command	Description
create name	Create a new resource for a specified calendar ID.
delete [name]	Delete a resource or, if no resource name is specified, delete all resources.
enable [name]	Enable a resource or, if no resource name is specified, enable all resources.
disable [name]	Disable a resource or, if no resource name is specified, disable all resources.
list [name]	Display a single resource calendar or, if no resource name is specified, list of all resource calendars.

---

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
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a [aces]	Access Control Entries (ACEs) for the specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (""). The default is the resource.default.acl parameter in the ics.conf file. For information about the ACE format, see Chapter 4 "Managing Calendar Server Access Control.
-b [basedn]	LDAP base DN (distinguished name) to be used for the specified resource. Default is taken from the local.ugldapbasedn setting in the ics.conf file.
-c calid	The icsCalendar attribute. This option is required with the create command. For more information, see "Calendar Identifiers (calids)".
-d [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 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.
-o owner	Primary owner. Default is taken from the setting service.admin.calmaster.userid in the ics.conf file.
-y otherowners	Other owners. Multiple owners must be enclosed in quotation marks ("") and separated by spaces. The default is no other owners.
version [name]	Display the version of the utility.

Examples

• Display a list of all resource calendars and their LDAP attributes.

  csresource -v list

• Create a resource calendar with the calendar ID (calid) room100 and the viewable name (LDAP cn attribute) MeetingRoom100:

  csresource -c room100 create MeetingRoom100

• Display the LDAP attributes of the resource calendar with the viewable name MeetingRoom100:

  csresource -v list MeetingRoom100

• Disable the resource calendar with the viewable name MeetingRoom100:

  csresource disable MeetingRoom100

• Enable the calendar with the resource calendar with the viewable name MeetingRoom100 and allow double-booking:

  csresource -k yes enable MeetingRoom100

• Delete the resource calendar with the viewable name 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.

• calendar restores a specified calendar.

• defcal restores a user's default calendar.

• version displays the version number of the utility currently installed.

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

---

Caution

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

---

Requirements

• 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-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 operation overwrites all previous contents of the current calendar database.
calendar inputfile	Restore the specified calendar ID from the specified input file. The data format of the file is determined by the file-name extension: .ics for iCalendar (text/calendar). .xml for XML (text/xml). If the specified calendar ID already exists, the calendar's data is cleared before it is restored.
defcal inputfile	Restore the default calendar of the specified user ID from the input file specified. The data format of the file is determined by the file-name extension: .ics for iCalendar (text/calendar). .xml for XML (text/xml).
version	Display the version of the utility.

Table 7-21 describes the csrestore utility command options.

Table 7-21    csrestore Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a userid	The user ID to restore. This option is required with the defcal command. There is no default.
-b basedn	The LDAP base DN (distinguished name) to be used for the specified user ID. The default is taken from the setting local.ugldapbasedn defined in the ics.conf file.
-f	To force any existing database files to be deleted.
-c calid	The calendar ID to restore. This option is required with the calendar command. There is no default. For more information, see "Calendar Identifiers (calids)".

Examples

• Restore the calendar database stored in the directory backupdir that was previously saved using csbackup:

  csrestore database backupdir

• 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 -c tchang calendar backupdir/tchang.ics

• Restore tchang from the calendar database in backupdir that was previously saved using csbackup:

  csrestore -c tchang calendar backupdir

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

csschedule [-q|-v] [-c count] [-e endtime] [-s starttime]

[-t scheduletime -o offset] [-u uid] list [calid]

csschedule [-q|-v] [-t scheduletime -o offset -u uid -n sequencenumber   -r rid] list [calid]

csschedule [-q|-v] [-t scheduletime -o offset -u uid -n sequencenumber   -r rid] delete [calid]

csschedule [-q|-v] [-s starttime] [-e endtime] delete [calid]

Table 7-22 describes the commands available for the csschedule utility.

Table 7-22    csschedule Utility Commands 

Command	Description
list	Display entries held in the GSE queue requested by a specified calendar ID.
delete	Delete an entry from the GSE queue requested by a specified calendar ID.
version	Display the version of the utility.

Table 7-23 describes the csschedule utility command options.

Table 7-23    csschedule Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-c count	The number of GSE queue entries to list. For example, specify 10 if you want to examine ten entries in the queue.
-e endtime	The ending time of the entry in the GSE queue where 0 means to the end of time. The default is 0.
-n sequencenumber	The sequence number of the event or task in the queue.
-o offset	An offset number for a schedule time. The offset number uniquely identifies an entry in the GSE queue when there is more than one entry scheduled at the same time.
-r rid	The recurrence ID (RID) of the event or todo. An RID is a semicolon delimited list of strings that identify each occurrence of a recurring event or todo.
-s starttime	The starting time of the entry in the GSE queue where 0 means from the beginning of time. The default is 0.
-t scheduletime	A schedule time, for example: 20001231T103045Z
-u uid	The unique identifier (UID) of an entry in the GSE queue.

Examples

• List in detail all entries stored in the GSE queue:

  csschedule -v list

• List the first ten entries stored in the GSE queue:

  csschedule -c 10 list

• List the entries in the GSE queue scheduled between 10:30:45 to 11:30:45 on 12/31/2000:

  csschedule -s 20001231T103045Z -e 20001231T113045Z 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 -v -t 20001231T103045Z -o 2 -u 1111 -r 0 -n 0 list tchang

• 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 1 -u 1111 -r 0 -n 0 delete tchang

• Delete entries in the GSE that are scheduled between 10:30:45 and 16:30:45 on 12/31/2000:

  csschedule -v -s 20001231T103045Z -e 20001231T163045Z delete

• Delete all entries in the GSE queue:

  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.

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

On Windows NT systems, you can also start the Calendar Server using the Services dialog box accessed from the Control Panel.

Requirements

• You must run the utility locally on the machine where the Calendar Server is installed.

• The Calendar Server must be stopped.

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-24    cscstart Utility Commands 

Command	Description
check | list [servicename]	Check if a specified Calendar Server service is running, or check if all Calendar Server services are running if a service name is not specified Or list all Calendar Server services (or a specified service) and their session IDs. servicename can be one of the following: ens — a generic event registration and notification service that can be shared by other iPlanet servers notify — Calendar Server notification service admin — Calendar Server administration service (required on every server machine) dwp — Calendar Server Database service (started only with remote database configuration) http — Calendar Server service
service [servicename]	Start a specified Calendar Server service or all of its services if no service name is specified. The Calendar Server 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 service admin — Calendar Server administration service (required on every server machine) dwp — Calendar Server database service (started only with remote database configuration) http — Calendar Server service For more information about Calendar Server services, see the following sections: "Calendar Server Access Control". "Starting and Stopping the Calendar Server"." "Services Configuration".
version	Display the version of the utility.

Table 7-25 describes the csstart utility command options.

Table 7-25    csstart Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-f	To force a specified Calendar Server service (or all currently running services if a service is not specified) to: 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: iPlanet recommends that you use the stop-cal and start-cal utilities instead to stop and start the Calendar Server.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.

Examples

• Start all local Calendar Server services using the default ports and in the default start order:

  csstart service

• Start the local Calendar Server HTTP service:

  csstart service http

• Check if all local Calendar Server services are started:

  csstart check

• List all local Calendar Server services that are started:

  csstart list

csstats

---

The csstats utility displays Calendar Server statistics. Commands are:

• list counter statistics about a specified Calendar Server subsystem.

• version displays the version number of the utility currently installed.

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

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

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

Table 7-26 describes the commands available for the csstats utility.

Table 7-26    csstats Utility Commands 

Command	Description
list [subsystem]	List counter statistics about a specified Calendar Server subsystem or. If subsystem is not specified, display basic information about the available subsystems, which are: alarm — monitoring of services alarm notifications auth — login authentication db — calendar database disk — disk usage monitoring gse — Group Scheduling Engine (GSE) http — HTTP transport response — server response times sess — server session status wcap — Web Calendar Access Protocol
Version	Display the version of the utility.

Table 7-27 describes the csstats utility command options.

Table 7-27    csstats Utility Command Options

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-i iterations	The number of times to repeat statistical lookups. Default is 1.
-r registry	The name and location of the file that stores counter statistics. The default is: 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.

Examples

• Display basic information about counters and what types are available:

  csstats list

• List counter statistics about the HTTP service subsystem (hpptstat):

  csstats list http

• List counter statistics about the WCAP subsystem (wcapstat) every 10 seconds for one hour (3600 seconds):

  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.

• version displays the version number of the utility currently installed.

On Windows NT systems, you can also stop the Calendar Server using the Services dialog box accessed from the Control Panel.

Requirements

• You must run the utility locally on the machine where the Calendar Server is installed.

• The Calendar Server must be running.

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-28    csstop Utility Commands  

Command	Description
check | list [servicename]	Check if a specified Calendar Server service is running or check if all services are running if a service name is not specified. Or list all Calendar Server services or a specified service and their session IDs. servicename can be one of the following: ens — a generic event registration and notification service that can be shared by other iPlanet servers. notify — Calendar Server notification service. admin — Calendar Server administration service (admin is required on every server machine). dwp — Calendar Server database service (started only with remote database configuration). http — Calendar Server service.
service [servicename]	Stop a specified Calendar Server service or all of its services if no service name is specified. Calendar Server services should be started in the following order and stopped in the reverse order: ens — a generic event registration and notification service that can be shared by other iPlanet servers. notify — Calendar Server notification service. admin — Calendar Server administration service (admin is required on every server machine). dwp — Calendar Server dataBase service (only started with remote database configuration). http — Calendar Server service. For more information about Calendar Server services, see the following sections: "Calendar Server Access Control". "Starting and Stopping the Calendar Server". "Services Configuration".
version	Display the version of the utility.

.

Table 7-29 describes the csstop utility command options.

Table 7-29    csstop Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-f	To force a Calendar Server service to stop (similar to a kill -9 command 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.

Examples

• Stop all local Calendar Server services:

  csstop service

• Stop the local Calendar Server HTTP service:

  csstop service http

• Check if all local Calendar Server services are stopped:

  csstop check

• List all local Calendar Server services that are started:

  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.

---

Requirements

• 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-30    cstool Utility Commands 

Command	Description
ping http	Ping the specified Calendar Server http service.
refresh [servicename]	Force the Calendar Server to refresh the configuration of a specified service, or if no service is specified, refresh the configuration of all Calendar Server services. The Calendar Server service options are: admin (csdamind service) dwp (csdwpd service) http (cshttpd service) notify (csnotifyd service)
version	Display the version of the utility.

Table 7-31 describes the cstool utility command options.

Table 7-31    cstool Utility Command Options 

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-h host	Specifies host name of the machine on which the Calendar Server is running. The default value is set at installation and taken from the local.hostname parameter in the ics.conf file. Use this option if you are accessing a Calendar Server running on a remote machine.
-p port	The port of the specified service, or if no service is specified, use the default value of the port as defined in the ics.conf file.
-t timeout	The amount of time (in seconds) to wait for a response from the server. The default is 120 seconds.

Examples

• Ping the cshttpd service:

  cstool ping http

• Ping the machine with the host name calserver to see if the Calendar Server cshttpd service is listening on port 80:

  cstool -p 80 -h calserver -p 80 ping http

• Force a local Calendar Server to refresh all service's configurations:

  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.

• delete a user.

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

  
  

  ---

  Note

  In the current release, iPlanet recommends that you provision user LDAP attributes using a directory service utility or a customized user provisioning tool. For example, if you are using Netscape Directory Server, use the ldapsearch and ldapmodify utilities. For information about these utilities, see the Netscape Directory Server documentation on the following web site: http://docs.iplanet.com/docs/manuals/

  ---

  
  

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

csuser [-q|-v] [-a aces] [-b basedn] [-c calid] -g givenname   [-k yes|no] [-l langcode] -s surname -y userpassword create userid

csuser [-q|-v] [-b basedn]   check|delete|disable|enable|list|reset [userid]

Table 7-32 describes the commands available for the csuser utility.

Table 7-32    csuser Utility Commands 

Command	Description
check [userid]	Check if the specified user ID is enabled for calendaring. If a user ID is not specified, it checks all users.
create userid	Create the specified user ID and enable this user to log into the Calendar Server.
delete [userid]	Delete the specified user ID. If no user ID is specified, all users are deleted.
disable [userid]	Disable the specified user ID for calendaring. The utility defines http as the value of the nswcalDisallowAccess attribute. If no user ID is specified, all users are disabled.
enable [userid]	Enable the specified user ID for calendaring. (The utility adds the specified calendar ID to the nswcalCALID attribute.) If a user ID is not specified, all users are enabled.
list [userid]	List all the calendar attributes for the specified user ID. If no user ID is specified, it lists all enabled users.
reset [userid]	Reset all calendar attributes for a user ID to the default settings. If no user ID is specified, it resets the attribute of all users.
version	Display the version of the utility.

Table 7-33 describes the csuser utility command options.

Table 7-33    csuser Utility Command Options  

Option	Description
-v	Run in verbose mode: Display all available information about the command being performed. Default is off.
-q	Run in quiet mode: Display no information if the operation is successful (errors, if they occur, are displayed). Suppress confirmation prompting for dangerous commands. Default is off.
-a [aces]	Access Control Entries (ACEs) for a specified calendar. ACEs determine who can access a calendar for group scheduling and the types of permissions they have, such as create, delete, read, and write privileges. An ACE string or Access Control List (ACL), must be enclosed in quotation marks (""). The default is the calstore.calendar.default.acl parameter in the ics.conf file. For details about the ACE format, see "Services Configuration".
-b [basedn]	The LDAP base DN (distinguished name) of the specified user ID. The default is taken from the local.ugldapbasedn parameter in the ics.conf file.
-c [calid]	The calendar ID of the default calendar to associate with the specified user ID. The default is the user ID. This command does not create a calendar. For more information, see "Calendar Identifiers (calids)".
-g givenname	The user's LDAP given name (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.
-l [langcode]	Language code. Default is the value of local.sitelanguage in ics.conf.
-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.

Examples

• Check if the calendar user JSmith is enabled for calendaring (if the existing calendar user has access to calendar data for this Calendar Server):

  csuser check JSmith

• Create an LDAP user with the user ID JSmith with the given name John, surname Smith, and the calendar ID JSmithcal:

  csuser -g John -s Smith -y password -c JSmithcal create JSmith

• Delete the calendar user JSmith:

  csuser delete JSmith

• Disable the calendar user JSmith from logging in to the Calendar Server:

  csuser disable JSmith

  
  

  ---

  Note	This command prevents JSmith from logging into the Calendar Server to access calendar data, but JSmith's data is not deleted from the local calendar database. If JSmith is currently logged into the Calendar Server, JSmith retains access to calendar data until he logs off.

  ---

  
  

• Enable JSmith for calendaring (lets existing calendar user JSmith log in to the Calendar Server):

  csuser enable JSmith

• List all calendar attributes for JSmith:

  csuser -v list JSmith

• List all calendar user IDs prefixed with the string user:

  csuser -v list "user*"

• Reset all calendar attributes for JSmith to the default configuration settings:

  csuser reset JSmith