This endpoint performs ad-hoc executions. It will wait 50 seconds for a sucessful response (200), otherwise return an Accepted status code (202) meaning the execution will be held asynchronously. The outcome could be obtained later on by fetching the resource using the attribute id.
The payload of this request is used with the Connection resource to construct the command to be executed in the remote agent.
script attribute is passed as stdin to the Connection resource command attribute.client_args is appended to the suffix of the command.For example, the following connection:
{
"name": "bash-connection",
"command": ["/bin/bash"],
"type": "custom"
}
With the following payload:
{
"script": "echo 'hello world'",
"client_args": ["-x"],
"connection": "bash-connection"
}
Will perform an ad-hoc shell execution as:
/bin/bash -x <<EOF
echo 'hello world'
EOF
The request body resource
Additional arguments that will be joined when construction the command to be executed
["--verbose"]The target connection
"bash"
DEPRECATED in flavor of metadata
Metadata contains attributes that is going to be available in the Session resource
The input of the execution
"echo 'hello from hoop'"
The execution has finished
The amount of time the execution took in miliseconds
5903
The shell exit code, any non zero code means an error
1
Inform if the connection has review enabled
false
Output contains an utf-8 output containing the outcome of the ad-hoc execution
Status reports if the outcome of the execution
success, failed, running "failed"
Each execution creates a unique session id
"5701046A-7B7A-4A78-ABB0-A24C95E6FE54"
If the `output`` field is truncated or not
false