2.92 pdplgset (Set up a plug-in)

Organization of this section
(1) Function
(2) Executor
(3) Format
(4) Options
(5) Command arguments
(6) Rules
(7) Notes

(1) Function

The pdplgset command sets up a plug-in in the HiRDB environment.

This command copies files stored in the installation directory to the HiRDB environment ($PDDIR/plugin/).

Each execution of the pdplgset command sets up one plug-in.

This command can also uninstall previously set up plug-ins from the HiRDB environment.

(2) Executor

This command can be executed by HiRDB administrators.

(3) Format

pdplgset {plug-in-name installation-directory|-d plug-in-name}

(4) Options

(a) -d plug-in-name

This option uninstalls a previously set up plug-in.

With this option, any files related to the plug-in are deleted from the HiRDB environment, with the exception of the directory conf and what follows in the plug-in operation directory. The installation directory, if specified, will be ignored.

Any libraries associated with the HiRDB Datareplicator (lib-plug-in-name_rpl.sl, lib-plug-in-name_rpl64.sl), if any, are also deleted.

(5) Command arguments

(a) plug-in-name

Specifies the name of the plug-in to be set up.

(b) installation-directory

Specifies the directory containing the plug-in that corresponds to the HiRDB load type (POSIX or non-POSIX library version) installed on the server machine.

If the platform for the plug-in is HP-UX, Solaris, or AIX, the installation directory may be corrected automatically according to the combination of the HiRDB load type and the plug-in type, as shown below:

Structure of plug-in directoryInstallation directory specified in pdplgsetHiRDB load type
Value corrected automatically for non-POSIX library versionValue corrected automatically for POSIX library version
./_plugin only./_plugin./_pluginError
./_plugin/posix./_pluginError
./_plugin/posix only./_pluginError./_plugin/posix
./_plugin/posixError./_plugin/posix
./_plugin and ./_plugin/posix./_plugin./_plugin./_plugin/posix
./_plugin/posix./_plugin./_plugin/posix

(6) Rules

  1. The pdplgset command can be executed only when the HiRDB is stopped.
  2. The pdplgset command must be executed at each server machine.

(7) Notes

  1. The results of execution of the pdplgset command can be checked by reviewing the return code generated from the command execution process. A command execution return code of 0 indicates normal termination; 8 indicates an abnormal termination.
  2. The $PDDIR/plugin directory, if it does not exist, is automatically created.
  3. The same plug-in cannot be set up multiple times for one HiRDB environment.
  4. Set up the plug-in to be used by executing the pdplgset command on all the units on which the plug-in is to operate.
  5. If a setup fails before the plug-in specified in the command argument is set up, or a KFPY01204-E message is generated because a setup was executed on a plug-in whose setup failed, uninstall the plug-in and rerun the setup process.
  6. Uninstalling a plug-in causes all the files under the path $PPDIR/plugin/plug-in-name to be deleted. Therefore, back up any needed files before running an uninstallation process.
  7. If the conf directory is already set up under the plug-in operation directory, the execution of the pdplgset command does not update or delete the conf directory files and what follows.