Sun Java System Calendar Server 6.3 Administration Guide

D.12 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 D–23.)
list displays all supported plug-ins.
version displays the version number of the utility currently installed.

D.12.1 Requirements

Must be run on the local machine where Calendar Server is installed.
Calendar Server can be running or stopped.
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.

csplugin [-q|-v] 
         [-r] 
          -t ac|attr|auth|locate|lookup|xlate
         activate|deactivate plugin

csplugin [-q|-v] list

The following table describes the commands available for the csplugin utility.

Table D–22 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 D–23.)
`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 D–23.)
`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 D–23.)
`version`	Display the version of the utility.

The following table describes the csplugin utility command options.

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

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