Create Remote Access plugin procedures

Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.

Depending on your plugin configuration and how you run procedures, the Input parameters Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Run Custom Command

Use this procedure to execute a command on a remote host.

Input parameters

Table 1. Run Custom Command input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Script	Required. Enter either a single command, such as `hostname`, or the contents of a script that needs to be executed. For example: `#!/bin/bash echo "Hello World" >> /tmp/test` ▼ In both cases, the plugin transfers the contents as a script to be executed on the remote host.
Remote path	The path on the remote host where the plugin executes the script. This is the default directory when connecting to a remote machine by a specific user. This directory must have the correct permissions to enable both the connection user and the target user to access it.
Result property path	Specify a command output to store the error output and exit value in the `remoteCommandOutput`, `remoteCommandErrorOutput`, and `remoteCommandExitValue` properties, respectively.