Install Plugins¶

The install_plugins script allows you to install one or several plugins at the same time on the Scheduler server. The plugin files are installed on the Scheduler server in the same way as the equivalent option in the administration tool (see section Plugins).

The format in which the script is invoked is as follows:

install_plugins -h <host> -l <login> -p <port> -P <password> -f <files-to-install> [-vdpauth] [-v] [-?]

where:

-h <host> indicates the name or IP address of the machine where the server is launched.

-p <port> indicates the port number at which the server is launched.

-l <login> indicates the login name used to connect to the server.

-P <password> indicates the password used to connect to the server. You can encrypt your password using the script encrypt_password. That way you can avoid entering it in plain text. If the password is encrypted, prefix it with encrypted: E.g. -P encrypted:Gr16MjvuXhRzPtPH/yTXHw==

-f <files-to-install> specifies the path to JAR files (each of which represents a plugin) or to folders that may contain several plugins. Use this format with commas to separate the values: plugin1,plugin2,folder1...

-vdpauth is an optional argument. Using it causes the given user to be authenticated against the Virtual DataPort server configured in Virtual DataPort settings. Otherwise, the authentication is local to Scheduler.

-v is an optional argument. Enables verbose output.

-? prints this help.

Some examples of execution of the install_plugins command are shown below:

Example 1:

install_plugins -h localhost -p 8000 -l admin -P admin -f /tmp/plugins_folder1/

This command recursively finds and installs plugins from the folder /tmp/plugins_folder1/ (plugin JAR files must be compatible with the Scheduler API) on the Scheduler server running on the local machine on port 8000. Access to the server is done using the login admin with the password admin.

Example 2:

install_plugins -h localhost -p 8000 -l admin -P admin -f /tmp/custom/sched_plugin1.jar,/tmp/custom/sched_plugin2.jar,/tmp/plugins_folder1/

This command installs plugins from the paths /tmp/custom/sched_plugin1.jar and /tmp/custom/sched_plugin2.jar, and also recursively finds and installs plugins inside the folder /tmp/plugins_folder1/ on the Scheduler server running on the local machine on port 8000. Access to the server is done using the login admin with the password admin.

Install Drivers¶

The install_drivers script allows you to install one or several drivers at the same time on the Scheduler server. The driver files are installed on the Scheduler server in the same way as the equivalent option in the administration tool (see section Drivers).

Note that it is necessary to create a folder with the format name-version for each driver (e.g. mysql-5.1.47 or myql-8), and inside that folder contain all the necessary JARs of that driver, since a driver may need several JARs for its correct operation.

The format in which the script is invoked is as follows:

install_drivers -h <host> -l <login> -p <port> -P <password> -f <files-to-install> [-vdpauth] [-v] [-?]

where:

-h <host> indicates the name or IP address of the machine where the server is launched.

-p <port> indicates the port number at which the server is launched.

-l <login> indicates the login name used to connect to the server.

-P <password> indicates the password used to connect to the server. You can encrypt your password using the script encrypt_password. That way you can avoid entering it in plain text. If the password is encrypted, prefix it with encrypted: E.g. -P encrypted:Gr16MjvuXhRzPtPH/yTXHw==

-f <files-to-install> specifies the path to folders (containing the JAR files) you want to install as drivers. Use this format with commas to separate the values: driver-1.0,driver-2.0,...

-vdpauth is an optional argument. Using it causes the given user to be authenticated against the Virtual DataPort server configured in Virtual DataPort settings. Otherwise, the authentication is local to Scheduler.

-v is an optional argument. Enables verbose output.

-? prints this help.

Some examples of execution of the install_drivers command are shown below:

Example 1:

install_drivers -h localhost -p 8000 -l admin -P admin -f /tmp/driver-1.0/

This command installs the driver driver-1.0 with all JAR files contained in that folder on the Scheduler server running on the local machine on port 8000. Access to the server is done using the login admin with the password admin.

Example 2:

install_drivers -h localhost -p 8000 -l admin -P admin -f /tmp/driver-1.0/,/tmp/driver-2.0/

This command installs the drivers driver-1.0 and driver-2.0 with all JAR files contained in each folder on the Scheduler server running on the local machine on port 8000. Access to the server is done using the login admin with the password admin.