Creating remote dispatcher scripts

Remote dispatcher scripts are  Ruby automation scripts that run on the engine server. They implement various transport protocols (agent types) for running remote shell scripts or copying files on remote hosts.  Remote dispatcher automation scripts are executed based on the agent type of the target server, SSH or NSH.

Before you create a remote dispatcher script, ensure that you configured an integration server.

You can create new automation categories to sort your remote dispatcher scripts.

In addition, you can use one of your existing scripts with a Template type as a template for creating new scripts.

To create a new remote dispatcher script

1. Go to Environment > Automation.
2. On the right pane, click Create Automation.
3. In the To use as list, select Remote Dispatcher.
4. In the Choose Automation Category list, select one of the available automation categories.
5. In the File Path box, enter the directory path for exporting or importing the automation script.
6. In the Apply template list, select a template that you want to use as a base for creating your script. 

7. In the Script integration server list, select that integration server that you want to use for connecting with the external system.

   Warning

   Notes

   • When you select a server from the list, the details related to that integration server are automatically added to the script body.
   • You cannot add an integration server if the script body is empty.
   • A general script that you do not plan to use for performing some actions in a particular target external system does not require an integration server.

8. In the Script Name box, enter a unique name for the script.

   Warning

   Note

    For remote dispatcher scripts, you can use the same names if the scripts have different agent types.

9. In the Description box, enter a short description for the script.
10. In the Agent Type list, select the agent type used by the target server.
11. In the Script body area, enter specify the code for the automation that runs in a step.
    The script body is the core of an automation script. The action that you want to perform and how you want to execute it depends on how you design the arguments and the logic in the script body.
12. In the Script type list, select one of the following options as appropriate:
    1. Template—To save this script as a template for future use.
    2. System—To save this script as a base script that can be only viewed or copied but not modified by anyone apart from the Administrator.
    3. User—To save this script as a normal script for your personal use and available for viewing, copying, and modifying. 
13. To save the script, click Add script.
14. (Optional) To make the script available for other users, change the automation script status to the state other than Draft.