Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction

Create Remote Access plugin configurations

3 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

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.

Remote Access plugin configuration parameters

Table 1. EC-RemoteAccess plugin configuration parameters
Parameter Description

Name

Required. The unique name for the configuration.

Description

Description for the plugin configuration.

Host address

Required. Remote host address.

Port

Port for the SSH connection.

OS

Required. OS of the remote host. The only supported value is Linux.

Script destination directory

The directory on the remote machine where a temporary script file created by the plugin is transferred to. The script file is removed after its execution. This directory must have the correct permissions to enable both the connection user and the target user.

Remote action

Required. The type of remote action. The only supported value is Execute Command.

Protocol

Required. Type of connection protocol. The only supported value is SSH.

File transfer type

The file transfer type used to transfer the temporary script file created by the plugin. Supported values are SFTP and SCP.

Connect with

Required. Type of user authentication. Supported values are password, private key, and private key file.

Connect credentials (username and password)

Username and password connection credentials.

Connect credentials (username and private key)

Username and private key connection credentials.

Connect credentials (username and private key file)

Username and private key file connection credentials.

Private key passphrase

Passphrase used along with the private key. This parameter only applies when the connection uses a private key or a private key file.

Is target user the same as connection user?

If selected, the plugin executes commands as the Connection user. The plugin does not prefix SUDO or SU before executing the command. This option is selected by default.

Target user run as identity

If the Target user is not the same as the Connection user, the plugin adds a prefix before executing the command, based on the value of this parameter.

  • SUDO: The plugin issues sudo [command].

  • SU: The plugin issues su -c [command].

  • SUDO WITH USERNAME: The plugin issues sudo -u [TargetUserName] [command].

  • SU WITH USERNAME: The plugin issues su - [TargetUserName] -c [command].

Target username

Applies only if Is target user the same as connection user? is not selected and Target user run as identity is configured to use SUDO WITH USERNAME or SU WITH USERNAME.

Is interactive mode enabled?

If selected, the plugin looks for prompts returned in the standard output by the script that the plugin executes. For example, the executing script could expect an argument supplied to it interactively during its execution. By default, this option is not selected.

Prompt pattern type

Applies only when interactive mode is enabled. Indicates if the prompt returned by the script is a Credential or Plain Text. If the prompt is a Credential, values supplied to it are considered a secret and are not surfaced in the CloudBees CD/RO UI or logs. The default is Credential.

Prompt pattern

Applies only when interactive mode is enabled. Can be either an exact string or a pattern the plugin looks for. For example, password: or .*[Pp]assword.*:.

Prompt pattern value (credential)

Applies only when interactive mode is enabled. The value that the plugin supplies to the prompt any time the prompt matches the Prompt pattern parameter and the Prompt pattern type is Credential.

Prompt pattern value (plain text):

Applies only when interactive mode is enabled. The value that the plugin supplies to the prompt any time the prompt matches the Prompt pattern parameter and the Prompt pattern type is Plain Text.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.
Introduction
Create Remote Access plugin procedures