Complete Contents |
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
iPlanet Calendar Server provides the following tools for server administration:
|Starting and Stopping the Server|
You can start and stop the Calendar Server the using:
Using start-cal and stop-cal
The start-cal and stop-cal utilities are located in the server-root/cal/bin directory. Both can be run either on a remote machine or the local machine where the Calendar Server is installed. To start the Calendar Server, go to the server-root/cal/bin directory and type: start-cal on the command line. For example: To stop the Calendar Server, go to the server-root/cal/bin directory and type: stop-cal on the command line. For example, enter: Using iplncal.sh (Unix only)
The iplncal.sh program is located in /etc directory. It must be run on the local machine where the Calendar Server is installed. To start the Calendar Server using iplncal.sh, go to the /etc directory and execute the program from the command line. It takes the following syntax: iplncal.sh [-h] [-r ServerRoot] start|refresh|stop|list [service]
On Windows NT, you can open the Services dialog box from the Control Panel to start and stop the Calendar Server. Refer to the documentation provided with the operating system for instructions.
|Using the Command Line Utilities|
This section describes the tasks you can perform to administer Calendar Server using the command line utilities. The examples in this section use the most commonly used commands and options. For complete details on the command utilities syntax and usage, see Appendix A, "Command Line Utilities."
This section includes the following topics:
The following command line utilities let you perform administrative tasks on calendar users. Use the csuser command line utility to:
Use the csuser utility's create command to create a calendar user. For example, to create the calendar user JSmith using the default configuration settings, enter the following command on the command line: csuser -g John -s Smith -y password -c calJSmith create JSmith
Use the csuser utility's delete command to delete a user from the Calendar Server. Note. The delete command removes all of the user's information from the LDAP server. (Calendar database information can be recovered from a calendar database that has been saved to a backup. See Backing-Up the Calendar Database.) For example, to delete JSmith from the Calendar Server, enter the following command: csuser delete JSmith
Enabling a Calendar User
Use the csuser utility's disable command to prevent a user from logging into the Calendar Server. The disable command prohibits a user from accessing calendar data, but does not remove the user's information from the calendar database. For example, to disable JSmith from access to Calendar Server data, enter the following command: csuser disable JSmith
Note. If a user is currently logged on to the Calendar Server, the disable command has no affect until the user logs off. The cssession utility lets you logout a calendar user (see Logging Out a User).Checking if a User is Enabled
Use the csuser utility's check command to determine if a specified user is enabled to access calendar data. For example, to check if JSmith is enabled for calendaring using the default configuration settings, enter the following command: csuser check JSmith For example: To list all users enabled for calendaring, enter the following command: csuser list csuser -v list JSmith
Resetting User Calendar Attributes
Every calendar has a primary owner and, optionally, other owners. A primary owner can update the events and tasks of a calendar as well as change the properties of a calendar, such as the name, description, additional owners, and display settings. Other owners can update a calendar's events and tasks, but cannot change a calendar's properties. Calendars can also be private or public. Public calendars can be viewed by any calendar-enabled user, but only the owners can make changes to the calendar. Private calendars can be viewed only by the calendar's owners. Use the cscal utility's create command to create a calendar. For example, to create a calendar owned by JSmith that can be read by anyone, enter the following command on the command line: cscal -n exampleA -o JSmith -r public create calA
Use the cscal utility's delete command to delete one or more calendars from the Calendar Server. Note. The delete command removes all of the calendar's information from the calendar database and cannot be undone. (Database information, however, can be recovered from a database that has been saved to a backup. See Backing-Up the Calendar Database.) The cscal utility lets you delete a single calendar or multiple calendars. For example, to delete a specific calendar with the CALID calendarA, enter the following command: cscal delete calendarA cscalutil -o JSmith delete cscal enable calendarA cscal -g John -h airius.com -p 80 enable JSmith
Disabling a Calendar User
Modifying Calendar Properties
Resetting Calendar Properties
Use the csdb command line utility to view the statistics of the local calendar databases, and to create, delete, backup and restore the calendar database. You must run the csdb utility on the local machine where your Calendar Server is installed. This section describes how to use csdb to view database statistics and to create and delete databases. For csdb backup and restore options, see Backup and Restore Procedures. Warning. You must stop the Calendar Server before restoring, creating, or deleting the calendar database. For example: To view calendar database status and statistical information, enter the following command: csdb list csdb create csdb delete csdb recover Note. The csexport and csimport utilities must be run locally on the machine where your Calendar Server is installed and can be executed while the server is either running or stopped. To export the calendar with the CALID JSmithcal in ICAL (text/calendar MIME) format to a file named jsmith.ics, enter the following command: csexport -c JSmith calendar jsmith.ics csexport -c JSmithcal calendar jsmith.xml
Importing Calendar Data
|Backup and Restore Procedures|
This section describes how to use the command line utilities to backup and restore Calendar Server data:
Use the csbackup utility's calendar command to backup a calendar to a plain text file using ICAL or XML format. The file name extension (.ics or .xml) that you specify for the output file determines which format is used. For example: To backup the calendar JSmithcal in ICAL (text/calendar MIME) format, enter the following command: csbackup -c JSmithcal calendar jsmith.ics csbackup -c JSmithcal calendar jsmith.xml Restoring a Calendar from a File
Use the csrestore utility's calendar command to restore a calendar that was saved to a backup file using the csbackup utility. The file name extension (.ics or .xml) of the backup file indicates the format in which it was saved. For example: To restore the calendar JSmithcal that was saved in ICAL (text/calendar MIME) format to the file jsmith.ics located in the bcakupdir directory, enter the following command: csrestore -c JSmithcal calendar backupdir/jsmith.ics csrestore -c JSmithcal calendar backupdir/jsmith.xml
Restoring a Calendar from a Database
Backing-Up a User's Default Calendar
Restoring a User's Default Calendar
Backing-Up the Calendar Database
Use the csdb utility's recover command to recover a calendar database that was accidentally corrupted or deleted. For example, to attempt to recover a damaged calendar database in the current directory, enter the following command:csdb recover
Using Solstice or Legato Software to Backup Calendar Server
Use the following steps to backup calendar data:
The backup procedure creates a backup directory under the current directory. This directory is not the actual directory calendar data is stored, but a directory image of how calendars are stored. This files in this directory are empty and are used only to provide information to the backup program on how calendars will be stored on the backup media. If the backup directory already exists, it is synchronized with the directory structure of the current hierarchy.
Note: Do not use the Solstice Backup incremental backup feature because the backup directory is only an image of the folder structure and contains no actual data. The incremental backup feature is not supported in iPlanet Calendar Server.
The preceding steps describe how to run a backup manually. It is recommended that you set up the backup program's backup command to run the Calendar Server csbackup command line utility before the running backup program's save command to achieve an automated backup process.
Use the Solstice nwrestore feature or the recover command to restore backed up calendar information. If you use nwrestore, you will receive the message: "File already exists. Do you want to overwrite, skip, backup, or rename?" Choose overwrite. (This message appears because the backup tree is just the directory hierarchy, that is, it consists of empty files and stays that way permanently.) Note. If you use the Solstice recover command, you can use the -A and -iy arguments to suppress this message.