Complete Contents
Preface
Chapter 1 Installation and Deployment
Chapter 2 Configuring Calendar Server
Chapter 3 Admininistering Calendar Server
Chapter 4 Monitoring the Calendar Server
Appendix A Commnand Line Utilities
Appendix B Monitoring Tools
Appendix C Time Zones
Appendix D Calendar Server LDAP Schema
Index
iPlanet Calendar Server: Administration Guide: Command Line Utilities
Previous Next Contents Index


Appendix A Command Line Utilities

This appendix provides complete details on the available commands, options, values, syntax notation, and usage rules for the Calendar Server command line utilities. It provides supporting reference material for the topics described in Chapter 3, Administering Calendar Server.

Administration for iPlanet Calendar Server is provided by a set of command line utilities. Each utility accepts options from the command line and can be invoked from batch, shell, and scripting programs such as Perl. Where applicable, default values for the available option are taken from the server.conf configuration file.


Command Line Utility Syntax
Calendar Server command line utilities use the following syntax:

utility [-option [value]] command [target]

where:

Usage Rules
The following rules provide general usage guidelines for the command line utilities:

Command Line Utility Summary
Table A.1 summarizes the command line utilities.

Table A.1 Command Line Utilities Summary
Utility
Run from...
Use to...
csbackup

local machine
backup individual calendars, users, and the calendar database.
cscal
local machine
manage calendars and their properties.
cscomponents
local machine
manage components in a calendar (components are events and tasks).
csdb
local machine
manage the calendar database.
csexport
local machine
export a calendar in ICAL or XML format.
csimport
local machine
import a calendar in ICAL or XML format.
csrestore
local machine
restore individual calendars, users, and the calendar database.
cssession
local or remote machine
manage sessions in a Calendar Server.
csstart
local machine
start the Calendar Server (on Windows NT, the server can also be started using the NT services dialog accessed from the Control Panel.).
csstats
local machine
display counters in a Calendar Server.
csstop
local or remote machine
stop the Calendar Server (on Windows NT, the server can also be stopped using the NT services dialog accessed from the Control Panel).
cstool
local or remote machine
ping a Calendar Server or command the server to refresh its configuration.
csuser
local or remote machine
manage calendar users.


csbackup
The csbackup utility lets you backup individual calendars, users, and the calendar database. It provides the following commands:

Syntax

csbackup [-v | -q] database outputdir

csbackup [-v | -q] -c CALID calendar outputfile

csbackup [-v | -q] -a USERID [-b BASEDN] [-h host] [-p port] [-u adminuser] [-w password] defcal outputfile

Requirements:

Examples

csbackup database backupdir

The above example backs up the calendar database to a directory named backupdir.

csbackup -c calA calendar calA.ics

The above example backs up the calendar with the CALID calA to the file calA.ics as text/calendar.

csbackup -a userA defcal userA.xml

The above example backs up the default calendar for user userA to the file userA.xml as text/xml.

Table A.2 describes the commands available for the csbackup utility.

Table A.2 csbackup Utility Commands
Command
Description
database outputdir
Backup the calendar database to the specified output directory.
calendar CALID outputfile
Backup the specified CALID to the specified output file. The data format of the file is assumed by the file extension, .ics for text/calendar and .xml for text/xml.
defcal USERID outputfile
Backup the default calendar of the specified USERID to the specified target file. The data format of the file is assumed by the file extension, .ics for text/calendar and .xml for text/xml.
version
Displays the version of the utility.

Table A.3 describes the csbackup utility command options.

Table A.3 csbackup Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-a USERID
The USERID of the calendar user to backup. This option is required for the defcal command. There is no default.
-b BASEDN
BASEDN used for all LDAP users. The default value is taken from the configuration setting local.ugldapbasedn defined in the server.conf file.
-c CALID
CALID to backup. This option is required with the calendar command. There is no default.
-h host
The host name of the machine where the LDAP server that stores user information for this Calendar Server is running. The default value is taken from the configuration setting local.ugldaphost defined in the server.conf file.
-p port
The port number that the LDAP server is listening to. The default value is taken from the configuration setting local.ugldapport defined in the server.conf file.
-u adminDN
The LDAP distinguished name (DN) of the person with administration rights to the LDAP server that stores user authentication information accesses by this Calendar Server. The default value is taken from the configuration setting local.enduseradmindn defined in the server.conf file.
-w adminpassword
Password of the LDAP administrator DN specified by the -u option. The default value is taken from the configuration setting local.enduseradmincred defined in the server.conf file. This option is required if you use the -u option.


cscal
The cscal utility lets you manage calendars and their properties. It provides the following commands:

Syntax

cscal [-v | -q] [-c charset] [-d description] [-g categories] [-l langcode]

[-m email] [-n name] [-o owner] [-r public | private]

[-w public | private] [-y otherowners] create | modify CALID

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

Requirements:

Examples

cscal -n exampleA -o userA -r public create calA

The above example creates the calendar with the CALID calA for userA with the visible name exampleA which can be read by anyone.

cscal delete calA

The above example deletes calA (removes it from the calendar database).

cscal -o userA delete

The above example deletes all calendars whose primary owner is userA (removes them from the calendar database).

cscal disable calA

The above example disables the calendar with the CALID calA (users will not be allowed to read, write to, or locate it using the user interface).

cscal enable calA

The above example enables the calendar with the CALID calA (users are allowed to read or write to it using the user interface).

cscal list calA

The above example lists the properties of calA.

cscal -v list calA

The above example lists all the properties of calA.

cscal list

The above example lists all the calendars in the database.

cscal -g sports -y userB -r private -v modify calA

The above example modifies calA so that it is associated with the category sports, is co-owned by userB, and can be read only by the owners.

cscal reset calA

The above example resets the calendar with the CALID calA to the default configuration settings.

cscal -d "" modify calA

The above example removes a description from the calendar with the CALID calA.

cscal -g "" modify calA

The above example removes all categories from the calendar with the CALID calA.

cscal -y "" modify calA

The above example removes other owners from the calendar with the CALID calA.

Table A.4 describes the commands available for the cscal utility.

Table A.4 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]
List properties of the calendar with the specified CALID.
If the -o owner option is specified, lists all calendars whose primary owner is the specified owner.
modify CALID
Modifies the properties of the calendar specified as CALID.
reset [CALID]
Resets the properties of the calendar specified as CALID.
version
Displays the version of the utility.

Table A.5 describes the cscal utility command options.

Table A.5 cscal Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-c charset
Character set. The default is no character set.
-d description
Description. The default is no description.
-g category
Category. Multiple categories must be surrounded by quotation marks ("") and separated by spaces. The default is no category.
-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 is the CALID.
-r public | private
Read access which can be public or private. The default is private.
-w public | private
Write access which can be public or private. The default is private.
-y otherowners
Other owners. Multiple owners must be surrounded by quotation marks ("") and separated by spaces. The default is no other owners.


cscomponents
The cscomponents utility lets you manage components (events and tasks) in a calendar. It provides the following commands:

Syntax

cscomponents [-v | -q] [-e endtime] [-s starttime] [-t event | task] delete | list CALID

Requirements:

Examples

cscomponents -s 19980101T000000Z -e 19981231T000000Z delete calA

The above command deletes all 1998 events in the calendar with the CALID calA.

cscomponents -v list calA

The above command lists all events and tasks, with details, in the calendar with the CALID calA.

Table A.6 describes the commands available for the cscomponent utility.

Table A.6 cscomponent Utility Commands
Command
Description
delete CALID
Deletes events in the calendar with the specified CALID.
list CALID
Lists events in the calendar with the specified CALID.
version
Prints the version of the utility to the screen.

Table A.7 describes the cscomponent utility command options.

Table A.7 cscomponent Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-e endtime
Ending time of the components. An end time of 0 means to the end of time. The default is 0.
-s starttime
Starting time of the components. A start time of 0 means from the beginning of time. The default is 0.
-t event | task
Type of components (events or tasks) on which the action is performed. Default is both.


csdb
The csdb utility lets you manage the calendar databases. It provides the following commands:

Note. For more information on Calendar Server databases, see Database Technology.

Syntax

csdb [-v | -q] [-t cal | sess | stats] list

csdb [-v | -q] [-t cal | sess | stats] [-h host] [-p port] create | delete | recover [dbdir]

Requirements:

Examples

csdb -v create

The above command creates new, un-populated databases in the current directory.

csdb -v delete

The above command deletes the databases in the current directory.

csdb -v list

The above command lists information about the databases in the current directory.

csdb recover

The above command attempts to recover damaged databases in the current directory.

csdb -t sess list

The above command lists information about the sessions database in the current directory.

csdb -t stat recover

The above command attempts to recover a damaged statistics database in the current directory.

Table A.8 describes the commands available for the csdb utility.

Table A.8 csdb Utility Commands
Command
Description
create [dbdir]
Creates databases in the specified database directory. If a database directory is not specified, the current directory is used.
delete [dbdir]
Deletes databases in the specified database directory. If a database directory is not specified, the current directory is used.
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.
version
Displays the version of the utility.

Table A.9 describes the csdb utility command options.

Table A.9 csdb Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-t cal | stat | sess
Which database to perform an action on: calendar (cal), statistics (stat), or session (sess). If -t is not specified or if -t is specified without a database value, all databases are assumed.
-h host
The host name of the machine where the LDAP server that stores user information for this Calendar Server is running. The default is taken from the setting local.ugldaphost defined in the server.conf file.
-p port
The port number that the LDAP server is listening to. The default is taken from the setting local.ugldapport defined in the server.conf file.


csexport
The csexport utility lets you export a calendar to a file in ICAL or XML format. It provides the following commands:

calendar specifies the calendar on which to perform an action

Syntax

csexport [-v | -q] -c CALID calendar outputfile

Requirements:

Examples

csexport -c calA calendar calA.ics

The above command exports the calendar with the CALID calA in ICAL (text/calendar) format to file named calA.ics.

csexport -c calA calendar calA.xml

The above command exports the calendar with the CALID calA in XML (text/xml) format to file named calA.xml.

Table A.10 describes the commands available for the csexport utility.

Table A.10 csexport Utility Commands
Command
Description
calendar outputfile
Exports the calendar to the specified output file. The data format of the file is determined by the specified file name extension:
.ics for ICAL (text/calendar)
.xml for XML (text/xml)
version
Displays the version of the utility.

Table A.11 describes the csexport utility command options.

Table A.11 csexport Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-c CALID
The CALID of the calendar to export. This option is required with the calendar command. There is no default.


csimport
The csimport utility lets you import a calendar from a file in ICAL or XML format that was saved with the csexport utility. It provides the following commands:

Syntax

csimport [-v | -q] -c CALID calendar inputputfile

Requirements:

Examples

csimport -c calA calendar calA.ics

The above command imports the calendar with the CALID calA from the file calA.ics and expects ICAL (text/calendar file) format.

csexport -c calA calendar calA.xml

The above command imports the calendar with the CALID calA from the file calA.xml and expects XML (text/calendar file) format.

Table A.12 describes the commands available for the csimport utility.

Table A.12 csimport Utility Commands
Command
Description
calendar inputfile
Imports the calendar from the specified input file. The data format of the file is determined by the file name extension:
.ics for ICAL (text/calendar)
.xml for XML (text/xml)
version
Displays the version of the utility.

Table A.13 describes the csimport utility command options.

Table A.13 csimport Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-c CALID
The CALID to of the calendar to import. This option is required with the calendar command.
Note: If the specified CALID already exits, the imported data is merged with the current calendar. There is no default.


csrestore
The csrestore utility lets you restore individual calendars, users, and the calendar database. It provides the following commands:

Syntax

csrestore [-v | -q] database inputdir

csrestore [-v | -q] -c CALID calendar inputfile

csrestore [-v | -q] -a USERID [-b BASEDN] [-h host] [-p port] [-u adminuser] [-w password] defcal inputfile

Requirements:

Examples

csrestore database backupdir

The above command restores the calendar database stored in the directory backupdir that was previously saved using the csbackup command line utility.

csrestore -c calA calendar backupdir/calA.ics

The above command restores the calendar with the CALID calA from the file calA.ics located in the directory backupdir that was previously saved in ICAL (text/calendar file) format using the csbackup or csexport utility.

csrestore -c calA calendar backupdir

The above command restores calA from the calendar database in backupdir that was previously saved using csbackup.

csrestore -a userA defcal backupdir/userA.ics

The above command restores the default calendar owned by userA from the file userA.ics located in the directory backupdir that was previously saved in ICAL (text/calendar file) format using the csbackup or csexport utility.

Table A.14 describes the commands available for the csrestore utility.

csrestore Utility Commands "> Table A.14 csrestore Utility Commands
Command
Description
database inputdir
Restore the calendar database from the specified input directory or input file that contains a backup calendar database. This will destroy and overwrite all previous contents of the current calendar database.
calendar inputfile
Restore the specified CALID from the specified input file. The data format of the file is determined by the file name extension:
.ics for ICAL (text/calendar).
.xml for XML (text/xml).
If the specified CALID already exists, the calendar's data is cleared before it is restored.
defcal inputfile
Restores the default calendar of the specified USERID from the input file specified. The data format of the file is determined by the file name extension:
.ics for ICAL (text/calendar).
.xml for XML (text/xml).
Version
Displays the version of the utility.

Table A.15 describes the csrestore utility command options.

Table A.15 csrestore Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-a USERID
The USERID to restore. This option is required with the defcal command. There is no default.
-b BASEDN
The BASEDN to be used for all LDAP users. The default is taken from the setting local.ugldapbasedn defined in the server.conf file.
-c CALID
The CALID to restore. This option is required with the calendar command. There is no default.
-h host
The host name of the machine where the LDAP server that stores user information for this Calendar Server is running. The default is taken from the setting local.ugldaphost defined in the server.conf file.
-p port
The port number that the LDAP server is listening to. The default is taken from the setting local.ugldapport defined in the server.conf file.
-u adminDN
The LDAP distinguished name (DN) of the person with administration rights to the LDAP server that stores user authentication information accessed by this Calendar Server. The default value is taken from the configuration setting local.enduseradmindn defined in the server.conf file. For example: uid=admin,ou=Administrators,ou=TopologyManagement,o=NetscapeRoot.
-w adminpassword
Password of the LDAP administrator DN specified by the -u option. The default value is taken from the configuration setting local.enduseradmincred defined in the server.conf file. This option is required if you use the -u option.


cssession
The cssession command line utility lets you manage sessions in a Calendar Server. It provides the following commands:

Syntax

cssession [-v | -q] [-h host] [-a port] [-s sessionid | -t tcpaddress] [-u calmaster] [-w password] list | logout [USERID]

Requirements:

Examples

cssession -p 81 -u calmaster -v -w calmasterpwd list userA

The above command lists the status for userA using the calmaster as the USERID of the administrator accessing the Calendar Server admin port at port number 81.

cssession -p 81 -u calmaster -w calmasterpwd list

The above command lists all logged-in users using the calmaster as the USERID of the administrator accessing the Calendar Server admin port at port number 81.

cssession -p 81 -u calmaster -w calmasterpwd logout userA

The above command will logout userA using the calmaster as the USERID of the administrator accessing the Calendar Server admin port at port number 81.

Table A.16 describes the commands available for the cssession utility.

Table A.16 cssession Utility Commands
Command
Description
list [USERID]
Displays the status for the specified USERID. If a USERID is not specified, it lists the status for all logged in users.
logout [USERID]
Logs out the specified USERID. If a USERID is not specified, it logs out all users.
version
Displays the version of the utility.

Table A.17 describes the cssession utility command options.

Table A.17 cssession Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-h host
The host name of the machine on which Calendar Server is installed. The default is taken from the setting local.hostname defined in the server.conf file
-a port
The port number that the Calendar Server administration port is listening to. The default is taken from the configuration setting service.http.admin.port defined in the server.conf file.
-s sessionID
The user's current session ID. There is no default.
-t tcpaddress
The user's current TCP/IP address. There is no default.
-u calmaster
The USERID of the person with administration rights to this Calendar Server that was specified during installation. The default value is taken from the configuration setting service.http.calmaster.admin defined in the server.conf file. This option is required.
-w password
The password for the calmaster USERID specified with the -u option. The default value is taken from the configuration setting service.http.calmaster.cred defined in the server.conf file. This option is required.


csstart
The csstart utility lets you start the Calendar Server. It provides the following command:

Syntax

csstart [-q | -v] [-a port] [-p port] [-g groupid] [-l listenaddr] [-u USERID] service [servicename]

Requirements:

Examples

csstart service

The above command starts all Calendar Server services using the default ports.

csstart -p 80 -a 81 service http

The above command starts the HTTP service listening on port 80 and the administration port listening on port 81.

Table A.18 describes the commands available for the csstart utility.

Table A.18 cscstart Utility Commands
Command
Description
service [servicename]
Stops a specified Calendar Server service (such as http), or all Calendar Server services if no service name is specified.
version
Display the version of the utility.

Table A.19 describes the csstart utility command options.

Table A.19 csstart Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-a port
The Calendar Server administration port. If not specified, an administration port will not be opened and:
The default value is taken from the configuration setting service.http.admin.port defined in the server.conf file.
-p port
Specifies the Calendar Server user port. The default value is taken from the setting service.http.port defined in the server.conf file.
-g groupid
The Unix group that the Calendar Server is running as (such as icsgroup) that was specified during installation.
(Unix systems only.)
-l listenaddr
The address that the HTTP service is listening to. The default is: INADDR_ANY.
-u USERID
The Unix user that the Calendar Server is running as (such as icsuser) that was specified during installation.
(Unix systems only.)


csstats
The csstats utility lets you display the statistics of a Calendar Server and provides the following commands:

Note. For more information on counters, see Counters.

Syntax

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

Requirements:

Examples

csstats list

The above command displays basic information about counters and what types are available.

csstats list http

The above command lists counter statistics about the HTTP service subsystem (hpptstat).

csstats -i 3600 -s 10 list wcap

The above command lists counter statistics about the wcap subsystem (wcapstat) every 10 seconds for one hour (3600 seconds).

Table A.20 describes the commands available for the csstats utility.

Table A.20 csstats Utility Commands
Command
Description
list [subsystem]
Lists statistics about a Calendar Server counter. If a counter is not specified, it displays basic information about what types are available.
Version
Displays the version of the utility.

Table A.21 describes the csstats utility command options.

Table A.21 csstats Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-i iterations
The number of times to repeat statistical lookups. Default is 1.
-r registry
The counter statistics file. Default is:
server-root/cal/bin/counter/counter
-s delay
The amount of time (in seconds) to wait between each statistical lookup. The default is 1 second.


csstop
The csstop utility lets you stop the Calendar Server. It provides the following commands:

Syntax

csstop [-v | -q] [-a port] [-r] [-u calmaster] [-w password] service [servicename]

Requirements:

Examples

csstop service

The above command stops all local Calendar Server services.

csstop service http

The above command stops a local Calendar Server http service.

Table A.22 describes the commands available for the csstop utility.

Table A.22 csstop Utility Commands
Command
Description
service [servicename]
Stops a specified Calendar Server service (such as http), or all Calendar Server services if no service name is specified.
version
Displays the version of the utility.

Table A.23 describes the csstop utility command options.

Table A.23 csstop Utility Command Options
Option
Specifies
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-a port
The port number that the Calendar Server administration port is listening to. The default value is taken from the setting service.http.admin.port defined in the server.conf file.
-h host
Specifies the host name if the machine where the Calendar Server is installed. The default value is taken from the setting local.hostname defined in the server.conf file.
-r
To stop a remote Calendar Server. The default is to stop locally by sending UNIX signals or NT service interrupts.
-u calmaster
The USERID of the person with administration rights to this Calendar Server that was specified during installation. The default value is taken from the configuration setting service.http.calmaster.admin defined in the server.conf file.
-w password
The password for the calmaster USERID specified with the -u option. The default value is taken from the configuration setting service.http.calmaster.cred defined in the server.conf file. This option is required if the -u option is specified.


cstool
The cstool utility lets you ping a Calendar Server or force the Calendar Server to refresh its configuration. It provides the following commands:

Syntax

cstool [-q | -v] [-p port] [-t timeout] ping [hostname]

cstool [-q | -v] [-p port] [-r] [-t timeout] [-u calmaster] [-w password] refresh [hostname]

Requirements:

Examples

cstool -p 80 ping calserver

The above command pings the machine with the host name calserver to see if a Calendar Server is listening on port 80.

cstool refresh

The above command forces a local Calendar Server to refresh its configuration.

Table A.24 describes the commands available for the cstool utility.

Table A.24 cstool Utility Commands
Command
Description
ping [hostname]
Ping a Calendar Server running on a remote machine with the specified host name, or, if no host name is specified, ping the local Calendar Server.
refresh [hostname]
Force a Calendar Server running on a remote machine with the specified host name to refresh its configuration, or, if no host name is specified, force the local Calendar Server to refresh its configuration.
version
Display the version of the utility.

Table A.25 describes the cstool utility command options.

Table A.25 cstool Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-p port
The Calendar Server port. The default value is taken from the setting service.http.port defined in the server.conf file.
-r
To command a remote Calendar Server. The default is to send the command locally by sending UNIX signals or NT service interrupts.
-t timeout
The amount of time (in seconds) to wait for a response from the server. The default is 120 seconds.
-u calmaster
The USERID of the person with administration rights to this Calendar Server that was specified during installation. The default value is taken from the configuration setting service.http.calmaster.admin defined in the server.conf file.
-w password
The password for the calmaster USERID specified with the -u option. The default value is taken from the configuration setting service.http.calmaster.cred defined in the server.conf file. This option is required if the -u option is specified.


csuser
The csuser utility lets you manage calendar user information stored in an LDAP directory server. It provides the following commands:

Syntax

csuser [-v | -q] [-b BASEDN] [-c CALID] -g givenname [-h host] [-p port]

-s surname [-u ldapadmin] [-w password] -y userpassword create USERID

csuser [-v | -q] [-b BASEDN] [-h host] [-p port] [-u adminuser] [-w password]

check | delete | disable | enable | list | reset [USERID]

Requirements:

Examples

csuser check JSmith

The above example checks if the calendar user JSmith is enabled for calendaring (if the existing calendar user has access to calendar data on this Calendar Server).

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

The above example creates an LDAP user with the USERID JSmith with the givenname John, surname Smith, and the CALID JSmithcal.

csuser delete JSmith

The above example deletes the user JSmith.

csuser disable JSmith

The above example disables the calendar user JSmith from logging in to the Calendar Server.

Note. The command in this example prevents JSmith from being able to log in to the Calendar Server to access calendar data, but JSmith's data is not deleted from the local calendar database. If JSmith is currently logged in to the Calendar Server, JSmith retains access to calendar data until he logs off or is logged off by the administrator. (The cssession utility's logout command lets an administrator log off a user. For more information see, cssession.)

csuser enable JSmith

The above example enables JSmith for calendaring (lets existing calendar user JSmith log on to the Calendar Server).

csuser -v list JSmith

The above example lists all calendar attributes for JSmith.

csuser reset JSmith

The above example resets all calendar attributes for JSmith to the default configuration settings.

Table A.26 describes the commands available for the csuser utility.

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

Table A.27 describes the csuser utility command options.

Table A.27 csuser Utility Command Options
Option
Specifies...
-v
Verbose mode which displays all available information about the command being performed. Default is off.
-q
Quiet mode which:
Default is off.
-b BASEDN
The BASEDN to be used for all LDAP users. The default value is taken from the setting local.ugldapbasedn defined in the server.conf file.
-c CALID
The CALID of the default calendar to associate with the specified USERID. The default is the USERID.
Note: This command does not create a calendar.
-g givenname
The user's LDAP givenname (first name). This option is required if you use the create command. There is no default.
-h host
The host name of the machine where the LDAP server that stores user information for this Calendar Server is running. The default value is taken from the setting local.ugldaphost defined in the server.conf file.
-p port
The port number that LDAP server is listening to. The default value is taken from the setting local.ugldapport defined in the server.conf file.
-s surname
The user's LDAP surname (last name). This option is required if you use the create command. There is no default.
-u adminDN
The LDAP distinguished name (DN) of the person with administration rights to the LDAP server that stores user authentication information accesses by this Calendar Server. The default value is taken from the configuration setting local.enduseradmindn defined in the server.conf file.
-w password
Password of the LDAP administrator DN specified by the -u option. The default value is taken from the configuration setting local.enduseradmincred defined in the server.conf file. This option is required if you use the -u option.
-y userpassword
The calendar user's password. This option is required if you use the create command. There is no default.

 

© Copyright 2000 Sun Microsystems, Inc. Some preexisting portions Copyright © Netscape Communications Corp. All rights reserved.