CMDNAME Statement—Specify Commands to Run on Windows and UNIX

C-LANG Statements › CMDNAME Statement—Specify Commands to Run on Windows and UNIX

CMDNAME Statement—Specify Commands to Run on Windows and UNIX

The CMDNAME statement specifies a command to run on a Windows or UNIX computer.

Supported Job Types

This statement is required for the Windows job type.

To run binary files on UNIX, this statement is required for the UNIX job type.

Note: All UNIX job definitions require a SCRIPTNAME statement or a CMDNAME statement. Use the SCRIPTNAME statement to run shell scripts and the CMDNAME statement to run binary files.

Syntax

This statement has the following format:

CMDNAME command_file

command_file

Specifies the full path and name of the command to run. It must be a legal executable Windows file name or a valid binary UNIX file name.

Limits: Up to 512 characters; case-sensitive

Notes:

Enclose values that contain delimiters (such as spaces) in double quotation marks.
Encryption must be enabled on the agent to use the CMDNAME statement.
COMMAND and COMMANDNAME are aliases of CMDNAME.

UNIX Notes:

When running a binary file using the CMDNAME statement, you must include the USER statement in the job definition. The USER statement specifies the user ID that the command runs under.
The CMDNAME statement usually requires the full path to the command name you want to run. However, you can specify the command name without the full path if all of the following conditions are true:
- The agent is running under the root account.
- The agent is configured to resolve environment variables.
- Using the USER statement, you specify a user ID that has the authority to run the job on the agent computer. The agent uses the user default shell.
- The path to the command name is set in the PATH system environment variable for the specified user ID.
When you define a job that runs a script that calls a second script, the fully qualified path of the called script must be provided.
You can specify the command name using an environment variable, for example $MY_PATH/myscript.sh, if all of the following conditions are true:
- The agent is running under the root account.
- The agent is configured to resolve environment variables.
- Using the USER statement, you specify a user ID that has the authority to run the job on the agent computer. The agent uses the user default shell.
- The environment variable used, for example $MY_PATH, is set in the specified user ID's profile file.

Windows Notes:

You can run the following executable file types using the CMDNAME statement:
- Binary files (.exe)
- Batch files (.bat, .cmd)
- Command files (.com)
To run Windows applications, such as ipconfig.exe, specify the command file on the CMDNAME statement, as shown in the following example:
```
CMDNAME c:\winnt\system32\ipconfig.exe
```
To run Windows operating system commands, such as DIR or TYPE, invoke the command interpreter CMD.EXE, as shown in the following example:
```
CMDNAME c:\winnt\system32\cmd.exe
ARGS /c "dir c:\temp\"
```
You can run other types of executable files from the Windows command line than those that are directly supported by the CMDNAME statement. (The executable files you can run are defined in the Windows system variable PATHEXT.) There are two ways to run those executable files using the agent:
- Run the executable from a batch file (.bat) or command file (.cmd)
- Invoke the program's interpreter with the CMDNAME statement and use the ARGS statement to pass the command as a parameter.
For some GUI applications, if there is a command line interface, you can run the application by specifying the batch file name using the CMDNAME statement. For example, you can transfer files using the FTP DOS commands or send e-mail in a batch file using software such as BatMail.
By default, the agent's working directory is the directory where you install the agent. If your executable file inputs or outputs to a different directory, or runs another executable file in a different directory, specify that directory. For example, if your batch file runs an executable file, you can do the following:
- Specify the full path of the executable within the batch file:
```
C:\Program files\esp\espcmd1.bat
C:\Program files\esp\espcmd2.bat
C:\payroll\data\pay.exe
```
- Use the Change Directory (cd) command to switch to the directory:
```
cd C:\Program files\esp
espcmd1.bat
espcmd2.bat
cd C:\payroll\data
pay.exe
```
  If your batch file takes input and output information, use the cd command to switch to the directory where the input and output files reside. In this example, file ftptest.bat reads the ftp command from the file ftpscript.src. The batch file outputs to file ftp.out in the current working directory.
```
cd d:\temp\script
ftp -n -i -s:ftpscript.src 131.50.30.28 >ftp.out
user guest
verbose
lcd d:\temp\data
cd /u1/guest
get data1
quit
```
  If you run ftptest.bat from the command line, manually switch to the d:\temp\script directory before running the file. The Windows operating system knows the current working directory, so you do not need to include the cd d:\temp\script command in the batch file.
  
  If you run ftptest.bat using the agent, however, the agent does not know the working directory. Specify the cd d:\temp\script command in the batch file, or the ftp command will fail.
The CMDNAME statement usually requires the full path to the command or script name you want to run. However, you can specify the command or script name without the full path if all of the following conditions are true:
- The agent is configured to search for paths to command or script files.
- The script or command file is located in one of the following directories:
  - The directory the agent is installed in
  - WINDOWS\system32 directory on the agent computer
  - WINDOWS\system directory on the agent computer
  - WINDOWS directory on the agent computer
  - Any other directory whose path is set in the system path or user path on the agent computer
Environment variables are not currently supported in the CMDNAME statement for Windows jobs.

Example: Identify a Command to Run Within a Job

In this example, sort is the name of the command and c:\payroll\test is the path.

CMDNAME c:\payroll\test\sort

Example: Run a Visual Basic Script

In this example, the agent invokes the Visual Basic interpreter wscript.exe using the CMDNAME statement and passes the Visual Basic script notify.vbs as a parameter using the ARGS statement:

AGENT NT_NY
CMDNAME c:\winnt\system32\wscript.exe
ARGS c:\programs\vbs\notify.vbs

Example: Run a UNIX Command

This example runs the report command under the user1 user ID on agent UNIX_NY:

AGENT UNIX_NY
CMDNAME /mfg/report
USER user1

Example: Redirect I/O and Pipe Output

This example redirects I/O and pipes output from a command. The agent runs the UNIX command ps -ef|grep cybAgent and pipes output to the /tmp/log file. The shell interpreter is invoked in the CMDNAME statement and the command is included in the ARGS statement.

AGENT SUN30RD
CMDNAME /usr/bin/ksh
ARGS -c "ps -ef|grep cybAgent >>/tmp/log"
USER user1

Example: Specify a Script Name Without the Full Path

In this example, an agent named WINAGENT runs a script named procscript.bat. The path to procscript.bat is set in the system path on the agent computer and the agent is configured to search for paths to command and script files.

AGENT WINAGENT
CMDNAME procscript.bat