---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Secure Shell (SSH) connector methods

# Secure Shell (SSH) connector methods {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
The Secure Shell (SSH) connector methods establish an SSH connection, execute commands over the established connection, and disconnect the session.

## Connect {#connector-ssh-methods__section_mwk_g31_g5b}

Establishes an SSH connection. Provide the information required to connect to a remote machine.

Select the settings icon (![Settings icon]()) to choose the authentication type.

Supported authentication types are Password, KeyboardInteractive, and KeyFileAuthentication.

Password is the default authentication type.  
{#connector-ssh-methods__table_wwq_k31_g5b__entry__4}

| Parameter | Description | Data Port Type | Data type |
|-|-|-|-|
| HostName | Host name of the remote server or IP address. | Data In | String |
| Username | User name of the SSH account. | Data In | String |
| Password | Secure string representation of the password. Password of the SSH account. You can use the SecureStringEncode component to encode the secure string password as mentioned in the following example. For more information, see [Use the SecureStringEncode component](https://www.servicenow.com/docs/qVqoDeGtubOBKZelnYh8Xw "Encode a string to secure it by using the Secure String Encode component in RPA Desktop Design Studio.").Figure 1. Connect method with Password parameter After you perform this task, you can connect to the remote server. | Data In | SecureString |
| Port | Optional. The port number for the SSH connection. Default value is 22. | Data In | Integer |
| CreateShell | Optional. If True, a shell stream is created on successful connection. Any command that is executing on this connection uses the shell. If False, any command that is executing on this connection does not the shell. Default value is True. | Data In | Boolean |
| KeyboardInteractiveAuth | Password as a challenge. If True, the server prompts the client for password to verify the user's identity. Value provided in the password parameter is shared as a response from client. This parameter appears only when KeyboardInteractive is selected from the Authentication Type. | Data In | Boolean |
| KeyFilepath | Path of the private key. This parameter appears only when KeyFileAuthentication is selected from the Authentication Type. | Data In | String |
| Passphrase | Optional. If private key is encrypted using Passphrase, same value is provided inside the Passphrase parameter to use the private key. This parameter appears only when KeyFileAuthentication is selected from the Authentication Type. | Data In | String |
[Table 1. Connect method parameters]

{#connector-ssh-methods__table_wwq_k31_g5b}

## RunCommand {#connector-ssh-methods__section_wqp_512_b2c}

After establishing an SSH connection, execute commands over the established connection using the RunCommand method.  
{#connector-ssh-methods__table_pkx_t12_b2c__entry__4}

| Parameter | Description | Data Port Type | Data type |
|-|-|-|-|
| Command | Commands that must be executed on the remote SSH server, such as messages or scripts, can be valid shell commands or executable commands that the remote server can understand. For example, <kbd class="ph userinput">echo hello</kbd>. Figure 2. RunCommand method - Command parameter | Data In | String |
| Timeout | Optional. The parameter that specifies the maximum time (in seconds) to wait for the command's output from the SSH server when using an interactive shell. Default value is 30. | Data In | Integer |
| Return | The result of the executed command. For example, after executing the automation, in the Data Preview of Return parameter, "hello" is displayed. Figure 3. Return parameter of RunCommand method | Data Out | String |
[Table 2. RunCommand method parameters]

{#connector-ssh-methods__table_pkx_t12_b2c}

## Disconnect {#connector-ssh-methods__section_jv5_gb2_b2c}

After executing commands, disconnect the established connection using the Disconnect method.

The following example shows the entire automation after adding the Disconnect method.
Figure 4. Disconnect method