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: Sybase ETL Server command line parameters

Command

UNIX

Windows

Description

install or inst

No

Yes

Installs the application as a Unix daemon or Windows service.

remove or rm

No

Yes

Removes system service start.

setoptions or so

No

Yes

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

getoptions or go

No

Yes

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

background or bg

Yes

No

Sets background processes that do not overuse system resources.

no_pidfile or nopid

Yes

No

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

console or con

Yes

Yes

Writes detailed error information and trace messages to the console.

diagnosis or diag

Yes

Yes

Lists application environment.

tracelevel or tl

Yes

Yes

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

server or s

Yes

Yes

Identifies the remote server to be used.

port or p

Yes

Yes

Identifies the port number to operate on.

version or V

Yes

Yes

Displays the application version information.

help or h

Yes

Yes

Displays help information.

licenses or ll

Yes

Yes

Identifies the short information about available licenses and their status.

nodelist or nl

Yes

Yes

Lists all known peer nodes.

shutdown or sh

Yes

Yes

Shuts down the node.

nodename or n

Yes

Yes

Sets a node name.

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.

perflog [args]

Yes

Yes

Set performance log level to 0 or 1.

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.

repcdcinstancename or ri

Yes

Yes

Specify the Replication CDC Service Name.