Runbook Exec
Start a execution using a Runbook as input
Path Parameters
The name of the connection
Body
The relative path name of the runbook file from the git source
Additional arguments to pass down to the connection
Environment Variables that will be included in the runtime
- { envvar:[env-key]: [base64-val] } - Expose the value as environment variable
- { filesystem:[env-key]: [base64-val] } - Expose the value as a temporary file path creating the value in the filesystem
Metadata attributes to add in the session
The parameters of the runbook. It must match with the declared attributes
The commit sha reference to obtain the file
Response
The amount of time the execution took in miliseconds
The shell exit code, any non zero code means an error
- 0 - Linux success exit code
- -2 - internal gateway code that means it was unable to obtain a valid exit code number from the agent outcome packet
- 254 - internal agent code that means it was unable to obtain a valid exit code number from the process
Inform if the connection has review enabled
Output contains an utf-8 output containing the outcome of the ad-hoc execution
Status reports if the outcome of the execution
- success - The execution was executed with success
- failed - In case of internal error or when the agent returns an exit code greater than 0 or different than -2
- running - The execution may still be running.
success
, failed
, running
Each execution creates a unique session id
If the `output`` field is truncated or not