Create a custom command

Custom 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.

To add a custom site command
  1. Start the Administrator Interface and connect to the Server.

  2. At the bottom of the left pane, click the Server tab.

  3. In the left pane, expand the Server and Site you want to configure.

  4. Select the Commands icon in the left window.

  5. In the right pane, click the New button and click the Command tab.

Note: You may also launch a Commands Wizard from the toolbar icon represented by the command prompt (black box)

  1. Enter the name of the command in the Command box. This is the command name that the connect user will issue in his/her FTP client.

  2. Type in a Description that will help you identify what this command is for.

  3. Choose the path to the executable by browsing, or typing the path in the Executable box.

  4. Select the Redirect output to client or Redirect output to system log check box, depending on where you want the output of the command sent. You can select both or neither.

  5. In the Advanced tab 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. Example (-c %1% %2%).

  6. Select the Require Parameter check box if you want to force the FTP client to send a minimum number of parameters. You may also specify the minimum number and the message users will receive should that number not be met.

  7. Select the Enable process timeout check box if you want the FTP Server to return an error should the launched process fail to respond.

  8. Choose the number of seconds the server will wait before terminating the command.

  9. Click the Permissions tab and verify that the appropriate users have permissions to run the newly created command.

  10. Click Apply.

 

Related Topics

Custom command example

File integrity checking (XCRC command)

Multi-Part Uploads (COMB custom command)