Creating a Command

Commands allow connecting users to execute programs with command line arguments on the Server. The connecting user would issue the command directly from their FTP client.

Alternately, you can create a Command using the Custom Command wizard.

To create a command

  1. In the Administrator, connect to the server, then click the Server tab.

  2. In the left pane, expand the node of the Site you want to configure, then click Commands.

  3. In the right pane, click New. The Commands appear under the Commands node.

  4. The Commands List tab appears in the right pane.



    On the Commands List tab, you can view and remove Commands, and add new Commands.

  5. In the Command Name box, type the name of the command. You will reference the Command Name in the Event Rule pane and Custom Command dialog box (in the Select Command drop-down menu), so you should give the Command an intuitive name. For example, instead of Command 1, you might call it Run CScript.

  6. Type a Description that will help you identify the command.

  7. In the Executable box, browse to or type the path to the executable. For example, you can specify a program, a batch file, or a Windows scripting executable (cscript.exe or wscript.exe).

  8. Select the Redirect output to system log check box. This creates a log in the Server installation folder that you can use to troubleshoot the command in case of failure. Redirect output to client is used in the extremely rare case in which the command will be launched by a connecting FTP client (if configured to do so).

  9. Leave all fields in the Advanced tab as is if you will be running a command from the Server’s Event Rule system (most common scenario). In the rare case this command will be launched from a connecting FTP client, type the parameters (if any) that will be passed to the command line. The variable format used is %N%. You may specify multiple variables or hard-coded values. (For example: -c %1% %2%).

  10. If you want to force the FTP client to send a minimum number of parameters, select the Require parameters check box and specify the minimum number of parameters required. You can also write a message in the Invalid parameter count message text box that users will receive when the parameter number is not met.

  11. If you want the Server to return an error if the launched process fails to respond, select the Enable process timeout check box and specify the number of seconds the Server should wait before terminating the command.

  12. If you want a connecting FTP client to execute the command, click the Permissions tab and verify that the appropriate users have permissions to run the newly created command. If you only want to allow the Server to run the command (from the Event Rule system), leave the Permission tab as is.

  13. Click Apply.