Command line parameters

This section describes all Sybase ETL Server command line parameters.

To display an overview of the available parameters, enter GridNode --help, or GridNode -h at the command prompt. The console output shows you the long and short forms for each parameter, for example:

--version,  -V    Displays version information

NoteThe full parameter name is always prefixed by two minus signs, whereas the short form has only one.

Table 6-1: Command line parameters

Command

Abbreviation

UNIX

Windows

Description

install

inst

yes

yes

Installs the application as a Unix daemon or Windows service.

remove

rm

yes

yes

Removes daemon or system service start.

setoptions

so

no

yes

Sets the command line options to be used when running as a Windows service.

getoptions

go

no

yes

Prints the command line options to be used when running as a Windows service.

background

bg

yes

no

Sets background processes that do not overuse system resources.

no_pidfile

nopid

yes

no

Sets the file to which the server records the process ID of the daemon.

console

con

yes

yes

Writes detailed error information and trace messages on the console.

diagnosis

diag

yes

yes

Lists application environment.

tracelevel

tl

yes

yes

Sets trace level for debugging from 0 (no trace) to 5 (very verbose).

server

s

yes

yes

Identifies the remote server to be used.

port

p

yes

yes

Identifies the port number to operate on.

version

V

yes

yes

Identifies the application version information.

help

h

yes

yes

Displays help information.

licenses

ll

yes

yes

Identifies the short information about available licenses and their status.

nodelist

nl

yes

yes

Lists all known peer nodes.

shutdown

sh

yes

yes

Shuts down the node.

Command line parameters for executing projects and jobs

dbhost host

yes

yes

Repository database host name or data source name (DSN).

dbinterface interface

yes

yes

Repository database interface.

dbdatabase database

yes

yes

Repository database name.

dbschema schema

yes

yes

Repository database schema.

dbuser user

yes

yes

Repository database user.

dbpassword encrypted password

yes

yes

Repository database password.

client client

yes

yes

Repository client name.

user user

yes

yes

Repository client user.

password encrypted password

yes

yes

Repository client password.

project [name | ID]

yes

yes

Execute a project by specifying the project name or ID.

job [name | ID]

yes

yes

Execute a job by specifying the project name or ID.

paramset [name | ID]

yes

yes

Specify a parameter set by name or ID for a project or job.

encrypt password

yes

yes

Encrypts a password, and displays the encrypted value. Use encrypt to generate the encrypted passwords you must use with dbpassword and password.

ping host:port

yes

yes

Checks if ETL Server is running at the host and port you specify.

envvariable1=value; variable2=value; ...;variableN=value

yes

yes

Specify additional environment variables to run with ETL Server. Use semicolons to separate multiple environment variables and enclose the entire string of variables in double quotes.