Sun Java System Calendar Server 6 2005Q4 Administration Guide

cstool

The cstool utility can ping one of the following:

The cstool utility can also display its version number.

The cstool can not be used to ping the following processes:

Note –

To refresh the configuration, use stop-cal, then start-cal to stop and then restart Calendar Server.

Do not use cstool to refresh the configuration. It could cause unpredictable negative outcomes.

Requirements

Calendar Server must be running.
You must be logged in as the user and group under which Calendar Server is running (such as icsuser and icsgroup) that was specified during installation, or as root.

cstool [-q|-v] 
       [-h host] 
       [-p port] 
       [-t timeout] 
       ping [http|ens]

cstool [-q|-v] 
       [-h host] 
       version

The following table describes cstool commands and their parameters.

Table D–36 cstool Utility Commands


Command	Parameters	Description
`ping`	`[http\|admin\|ens]` neither parameter specified	Ping the `cshttpd` process, the `csadmind` process, or the ENS process (`enpd`) Ping the server where Calendar Server is located.
`version`	none	Display the version of the utility.

The following table describes the cstool utility options.

Table D–37 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 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.

Ping the cshttpd service:

cstool ping http
Ping ENS on the server with host name sesta:

cstool -h sesta ping ens
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