Custom Execution Servers - Quick Start Guide

Summary: 6.0 is distributed with a custom execution server sample written in python and is available via the following path. The purpose of this article is to detail the steps needed to run scripts on a remote machine using the provided example.

\CloudShell 6.0 GA [6.0.0.10553]\CloudShell\Integration\Custom Execution Server Sample

Configure the Python execution server:  (In this example we are configuring the server to run TCL scripts)

1. From the installation package, “CloudShell/Integration/” copy the “Custom Execution Server Sample” to the execution server.
2. Install Python 2.7.x https://www.python.org/download/releases/2.7.8/ on the execution server.
3. Edit the config.json file in the "Custom Execution Server" Sample directory.

    4. The "name" and "type" field values in the config.json file should match the "Name" and "Description" in the Execution Server.

Configure the Portal:

1. In the web portal click on the“Job Scheduling” Icon which is the 4^th icon down from the top on the left.
2. On the address bar of the browser add “TestTypes” after “SnQ”+ “/”

    3.  Click on “Add” button to define a "Name" and “Type”.

Start the execution server:

    1. Open the command line to the “Custom Execution Server Sample” folder.
    2. Register the server by executing “ces.py register”.
    3. Run the execution server “ces.py” and leave the window open.

    4.  Upon executing the "ces.py" you should see the # of execution server to increase by the number that is set in the config.json file ("capacity" default is 5).

Scheduling a job:

1. From the “Job Scheduling” tab choose the “Add New” pull down menu and select the name of the server which has been added.

   2. Name the Test Suite and on the far right click on “+” to add a job, then click on “+” in the center of the screen to add a test.
   3. The purpose of the "Name (or Executable)" field is to define the path to the script engine. Example: “C:\tcl\bin\tclsh.exe”.
   4. The purpose of the "Arguments” is to define the location of the test script and any arguments. Example: “myTestSctipt.tcl Apple”.

  5. Run the job immediately or as desired. 

  6. Note that the job should report passed but no report will be available as reporting is not available for this feature.

 7. The dos execution server will display feedback about the script being run and will report an error in reference to reporting which can be ignored.