Overview

You can use this app to execute SSH commands on an on-premise Linux server/host. This app communicates with the on-premise network using the orchestration server.

Description

Orchestration apps let you automate repeatable tasks and actions spanning various systems and applications using workflows.


Some of the critical actions supported by this app are listed below.

1. Execute Command

2. Execute Command Using Inline Connection


Working Principle

The app communicates with an on-premise Windows server with the help of the Orchestration server, which resides in the same private network as the Windows server and acts as an agent.

The Orchestration server establishes a secure outbound connection over port 443 from inside the private network and looks for any incoming app requests.

 

Once it receives the app request over the outbound connection, the Orchestration server will then communicate with the Linux server in the same private network using SSH.


Prerequisites

  1. Orchestration Server Installation

Orchestration server should be installed using the installer on a Linux server. You can find this installer in your Freshservice tenant in the Admin module, Service Desk Productivity > Orchestration Centre > Orchestration Server > Download Windows Installer”.

To know more about the orchestration server installation, please refer to the Orchestration Server solution article.


It is recommended to install the Orchestration server on a separate windows server with access to the target Linux server over the SSH port.


  1. Networking Requirements

Please ensure that the following network communication is established before executing the app actions -


Communication on the default SSH port (or a custom port based on your configurations), from the Orchestration server to the target Linux server should be enabled. You can use the telnet utility to verify the open SSH port.





Installation Parameters


To install and authenticate this app, you will need to provide the following inputs.

  • Server IP

The IP address of the Linux server. It can be a private IP or a public IP depending upon the server configurations. 

The private IP address can be retrieved using a PowerShell terminal with the following command: 


ifconfig



    

    


  • Server Username

The username is used for logging in to the Linux server. The username can be retrieved using a Linux terminal with the following command: 

whoami


  • Authentication Method

The authentication method to be used for executing commands. The different options are:

  1. Server Password - The password is used for authenticating the user on the target Linux server.

  2. Pem Key - The Pem key generated is used for authenticating the user on the target Linux server.


  • SSH Port

The default SSH port is 22 unless the SSH port is explicitly configured. If it is explicitly configured, the same port should be used in the app configuration.


  • Is Sudo

Specify whether the command to be executed on the Linux server requires sudo or root privilege. If set to true then the user must specify sudo password otherwise if set to false no need for sudo password.

 

  • Sudo Password (If Is sudo is set to true)

    The sudo password for executing commands with sudo or root privilege.



Verify Connection Using “Test App Action”

You can also use the “Test App Action” functionality inside the Workflow Automator’s App Node to verify the connection between the Orchestration server and Linux server on which you want to execute SSH commands remotely.


Disclaimer:

Using the “Test App Action” will execute the action on the target Linux machine.