Secure Shell \(SSH\) connector methods
The Secure Shell (SSH) connector methods establish an SSH connection, execute commands over the established connection, and disconnect the session.
Connect
Establishes an SSH connection. Provide the information required to connect to a remote machine.
Select the settings icon ([Omitted image "component-settings-icon.png"] Alt text: Settings icon) to choose the authentication type.
Supported authentication types are Password, KeyboardInteractive, and KeyFileAuthentication.[Omitted image "ssh-connector-auth-types.png"] Alt text: The authentication type configuration window displaying the Password, KeyboardInteractive, and KeyFileAuthentication as authentication types.
Password is the default authentication type.
|
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. [Omitted image "ssh-connect-pwd-example.png"] Alt text: SecureStringEncode component is connected to the Connect method to pass the encoded password. 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 |
After establishing an SSH connection, execute commands over the established connection using the RunCommand method.
|
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, [Omitted image "ssh-run-command-example.png"] Alt text: Command entered as "echo hello" in the Command parameter RunCommand method |
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. [Omitted image "ssh-run-command-return-example.png"] Alt text: Data previews as hello, after the command is executed |
Data Out |
String |
After executing commands, disconnect the established connection using the Disconnect method.
The following example shows the entire automation after adding the Disconnect method.
[Omitted image "ssh-disconnect-example.png"] Alt text: SSH connector automation workflow example.
Parent Topic:Secure Shell (SSH) connector
--- title: Secure Shell \(SSH\) connector methods description: The Secure Shell \(SSH\) connector methods establish an SSH connection, execute commands over the established connection, and disconnect the session. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/integrate-applications/connector-ssh-methods.html release: australia topic_type: reference last_updated: "2026-09-10" reading_time_minutes: 2 breadcrumb: [Secure Shell \(SSH\) connector, Connectors, Automation components, RPA Desktop Design Studio, Robotic Process Automation \(RPA\) Hub, Workflow Data Fabric] --- # Secure Shell \(SSH\) connector methods The Secure Shell \(SSH\) connector methods establish an SSH connection, execute commands over the established connection, and disconnect the session. ## Connect Establishes an SSH connection. Provide the information required to connect to a remote machine. Select the settings icon \(\[Omitted image "component-settings-icon.png"\] Alt text: Settings icon\) to choose the authentication type. Supported authentication types are Password, KeyboardInteractive, and KeyFileAuthentication.\[Omitted image "ssh-connector-auth-types.png"\] Alt text: The authentication type configuration window displaying the Password, KeyboardInteractive, and KeyFileAuthentication as authentication types. Password is the default authentication type. <table id="table_wwq_k31_g5b"><thead><tr><th> Parameter </th><th> Description </th><th> Data Port Type </th><th> Data type </th></tr></thead><tbody><tr><td> HostName </td><td> Host name of the remote server or IP address. </td><td> Data In </td><td> String </td></tr><tr><td> Username </td><td> User name of the SSH account. </td><td> Data In </td><td> String </td></tr><tr><td> Password </td><td> 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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/use-security-encryption-securestringencode.md). \[Omitted image "ssh-connect-pwd-example.png"\] Alt text: SecureStringEncode component is connected to the Connect method to pass the encoded password. After you perform this task, you can connect to the remote server. </td><td> Data In </td><td> SecureString </td></tr><tr><td> Port </td><td> Optional. The port number for the SSH connection. Default value is 22. </td><td> Data In </td><td> Integer </td></tr><tr><td> CreateShell </td><td> 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. </td><td> Data In </td><td> Boolean </td></tr><tr><td> KeyboardInteractiveAuth </td><td> 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. </td><td> Data In </td><td> Boolean </td></tr><tr><td> KeyFilepath </td><td> Path of the private key.This parameter appears only when **KeyFileAuthentication** is selected from the Authentication Type. </td><td> Data In </td><td> String </td></tr><tr><td> Passphrase </td><td> 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. </td><td> Data In </td><td> String </td></tr></tbody> </table>## RunCommand After establishing an SSH connection, execute commands over the established connection using the RunCommand method. <table id="table_pkx_t12_b2c"><thead><tr><th> Parameter </th><th> Description </th><th> Data Port Type </th><th> Data type </th></tr></thead><tbody><tr><td> Command </td><td> 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, `echo hello`. \[Omitted image "ssh-run-command-example.png"\] Alt text: Command entered as "echo hello" in the Command parameter RunCommand method </td><td> Data In </td><td> String </td></tr><tr><td> Timeout </td><td> 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. </td><td> Data In </td><td> Integer </td></tr><tr><td> Return </td><td> The result of the executed command.For example, after executing the automation, in the Data Preview of Return parameter, "hello" is displayed. \[Omitted image "ssh-run-command-return-example.png"\] Alt text: Data previews as hello, after the command is executed </td><td> Data Out </td><td> String </td></tr></tbody> </table>## Disconnect After executing commands, disconnect the established connection using the Disconnect method. The following example shows the entire automation after adding the Disconnect method. \[Omitted image "ssh-disconnect-example.png"\] Alt text: SSH connector automation workflow example. **Parent Topic:**[Secure Shell \(SSH\) connector](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/ssh-connector.md)
| title | Secure Shell \(SSH\) connector methods |
| description | The Secure Shell \(SSH\) connector methods establish an SSH connection, execute commands over the established connection, and disconnect the session. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/australia/integrate-applications/connector-ssh-methods.html |
| release | australia |
| topic_type | reference |
| last_updated | 2026-09-10 |
| reading_time_minutes | 2 |
| breadcrumb | Secure Shell \(SSH\) connectorConnectorsAutomation componentsRPA Desktop Design StudioRobotic Process Automation \(RPA\) HubWorkflow Data Fabric |