You can use a custom script task to run a script that resides on a remote host. After the script runs, you can monitor the script progress and capture the script response, which you can pass as input to other release pipeline tasks.

Prerequisites

  • Verify that you defined and configured the plug-ins. An instance of this plug-in must be created in vRealize Orchestrator to enable the plug-ins in the pipeline. See Registering Plug-in Instances for Release Pipeline.

  • Verify that an artifact task is configured. See Configure an Artifact Task.

  • Verify that your script exists on a remote host that is configured in the script task. The script must have executable permission for a remote user to run it.

  • Verify that the folder where the script exists has permission to allow a file to be created.

Procedure

  1. Select Release Automation.
  2. Select the pipeline to configure from the Pipeline tab.
  3. Select Edit > Stages.
  4. Select Add Task.
  5. Select Custom from the Category drop-down menu.
  6. Select Custom Script from the Provider drop-down menu.
  7. Enter a name for this custom task and click OK.
  8. Select the new task from the stage column.
  9. Confirm to save the pipeline for configuration.
  10. Enter the script properties.

    Option

    Description

    Execute on Host

    Select the host type.

    • User defined host: IP Address of the host. You can enter multiple IP Addresses and pipeline input variables.

      For example, the input variable machine_ip can be 10.116.7.1. The user defined host can also have $machine_ip along with static hostname and IP Address.

    • Variables: A variable output of vRealize Automation provisioning.

    User credentials

    Enter the Host User name and Host Password.

    Execute Script File path

    Enter the Execute Script File path for the .sh script file.

    The host files must have a common location and the same file name for all the hosts.

    Script Type

    Select the supported Bash or PowerShell script type.

  11. Enter the Script Input parameters.
    1. Select the Artifact Source from the drop-down menu.
    2. Click Add to define the Artifact input parameters.
    3. Click Add to define the General Input Parameters.
  12. Provide a unique name prefixed with a dollar sign ($) to bind to for the Output Parameters.
  13. Click Save.

Task Output Format for a Custom Script Task

The following task output format is an example for a custom script task.

[
  {
    "description": "Host Response",
    "name": "10.110.15.205",
    "value": "Sample Response of Linux Host 01. Sample Response of Linux Host 01.",
    "type": "STRING"
  },
  {
    "description": "Host Response",
    "name": "10.110.15.206",
    "value": "Sample Response of Linux Host 02. Sample Response of Linux Host 02.",
    "type": "STRING"
  }
]