The logon clause

By default, the InfoSphere® DataStage® CLI connects to the engine on the local system using the user name and password of the user running the command.

For the dsjob and dsadmin commands, you can specify a different domain, engine, user name, or password using the logon clause, which is equivalent to the API DSSetServerParams function. Its syntax is as follows:

[-url domainURL |
 -domain domain_name ][ -user username ][ -password password ]
     [ -server enginename ]

or, for dsjob command only:


-domain NONE -user username -password password -server enginename

domainURL specifies a full format URL for the domain to log on to. The URL includes the protocol, host, and port information for the domain in this format: https://domain:port. The port defaults to 9443 if it is not specified.

domain_name specifies the domain to log on to. For dsjob, you can set -domain NONE to log on to the engine rather than the domain. In this case the user name and password are for the engine, not for the domain.

enginename specifies a different engine to log on to. A port number may be specified for the connection using enginename:port. The port defaults to 31538 if it is not specified.

username specifies a different user name to use when logging on.

password specifies a different password to use when logging on.

Encrypted user names and passwords are not supported on the command line, use a credentials file if you want to use encrypted values.

If you do not want to type your credentials in the command line and you do not want to use a credentials file, specify only the -url or the -domain parameter, and the -server parameter, and you are prompted for the user name and password. (The password is hidden as you type in the command window.) If you include the -url or the -domain parameter, and the -server and -user parameters in your command, then you are prompted for the password. Here is a sample command and interaction:

C:\IBM\InformationServer\Clients\Classic>dsjob 
-domain [2002:920:c000:217:9:32:217:32]:9443 -server RemoteServer
-ljobs newTest
Please type user name:admin
Please type password:
Job_ODBC

Status code = 0

For computers that do not use the default ports, to connect to a project that is on a local server, specify the -server option with only the port number and do not specify the server name. You do not need to specify your user name and password. For example:

dsjob -server :31539 -lprojects

For a more secure login for the dsjob and dsadmin commands, you can use a credentials file that can contain encrypted data:

-authfile credentials_filename

credentials_filename is the full path and name of the file that contains the logon details. This file supports encrypted and unencrypted data. See The credentials file for details and sample contents for the file.

You could alternatively specify the unencrypted details in a credentials file by using the following syntax:


-file credentials_filename domainname enginename

Note: The -file credentials file cannot contain encrypted data.

For the dsjob command, you can also use the command:

-file credentials_filename NONE enginename

domainname specifies the domain for which the file contains logon details. For dsjob, you can set NONE to log on to the engine rather than the domain. In this case the username and password are for the engine, not for the domain.

enginename specifies the engine for which the file contains logon details.

credentials_filename is the full path and name of the file that contains the logon details. This file supports only unencrypted data. The file should contain the following information if logging on to the domain:

domainname,enginename, username, password

The file must contain the following information if logging on to the engine:

enginename, username, password

Including the logon clause in your commands can expose your username and password. It is better to use the -authfile option and hold the encrypted logon information in a separate file, or to let the computer prompt you for your password.