executeCommand
- Karl Henselin
Executes commands/scripts on an EBS Instance. Use this operation when you need to execute commands like compile all forms, download AOL from EBS instance, etc. In addition, the plugin provides the ability for the user to define any number of outputs from the execution of the script that could be utilized in subsequent steps in the workflow.
Target Properties
Property Name | Property Source | Required | Description |
|---|---|---|---|
EBS Source Script |
| Yes | Source Script with full path. If you would like to apply changes directly to run edition for EBS R 12.2+, specify the run param after the script. By default, it connects to patch edition when performing the deploy operation. All other operations are sourced from run by default. e.g. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Command |
| Yes | The commands and/or scripts that are to be executed on the EBS instance. |
Artifacts
This operation delegates consumes/produces artifacts decision to the workflow developer. Check Consumes Artifacts on the workflow step editor if this operation requires artifacts to be delivered prior to execution of the script. Check Produces Artifacts on the workflow step editor if this operation creates artifacts. The artifacts folder is available via the FD_ARTIFACTS_DIR variable.
Endpoint Selection
This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to All, which selects all available endpoints associated to the Target. Selecting a specific resource will result in selection of endpoints associated to the Target which have that resource defined.
Endpoint Execution
This operation delegates endpoint execution to the workflow developer. The workflow editor will default to Any, which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to All to will result in execution on all selected endpoints.
Special Considerations
User defined outputs – an output must be defined in the workflow editor to be accessible. Within your script, use the following built-in function to set the output with the appropriate value and have it returned to the workflow process. Any number of outputs can be used.
Outputs Syntax
setOutput {output name} {output value}
#Example
setOutput STATUS ${STATUS_VARIABLE}
To load a file into an output, consider syntax like this:
setOutput OUTPUT_NAME "`cat /path/to/file.txt `"- style