SSH Engine state in Circuit | Qntrl | Circuit | Online Help | Execute commands in a remote Linux or Unix machine

SSH Engine

SSH Engine state is configured to connect to a client's machine or network and remotely execute commands or scripts on the client's Linux/UNIX operating system.

 

Prerequisite

  • Bridge must be installed and should be active. To learn how to install and configure Bridge, click here.

  • Credential must be created for the SSH module by selecting the credential type SSH.

For more details about the SSH module in Bridge, the keys, and its description click here.

Example Use Case: In the employee onboarding scenario, when it comes to the employee asset allocation process, the system administrator is responsible for installing the operating system on the assigned employee systems. To facilitate this, the SSH Engine state can be utilized specifically for LINUX machines. It enables the connection to the employee's machine and the execution of remote commands for OS installation.

Builder View

For associating an SSH Engine state to a circuit:

  1. In Builder View, drag and drop the SSH Engine state from the left pane into your circuit or click the required SSH Engine state of the circuit.

  2. In the Configuration, update the common state field attributes.

  3. In Bridge ID, click and select the bridge to be configured to the state from the drop-down list.

  4. Under Add Configuration section, fill in the following fields:

    • Credential ID - Click and select the credential from the dropdown list. The Credential ID of all the credentials created for the SSH module type will be displayed in the list.

    • Host - Enter the hostname of the machine in which the shell command has to be executed. Enter the hostname as localhost, if the shell command is executed on the same Bridge-installed machine.

    • CommandEither input the shell command directly for execution or input a command that includes the name of the Script file to be executed. To create a new script file, go to Scripts.

  5. Under Error Handling, you can optionally select and configure error handling options. Refer to Error Handling in Circuit states for further information.
  6. In the Input/Output section, enter the required paths. To learn more about I/O paths, click here. 

      

Code view

In Code View, the JSON to execute a shell command and perform a SSH task in circuit is given below:
"Linux OS Installation": {
      "type": "ssh_engine",
      "next": "Licence Key Activation-Linux",
      "bridge_id": "bridge-employee onboarding",
      "payload": {
            "credential_id": "ssh_cred_4",
            "host": "localhost",
            "command": "display.sh"
      }
}




    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • SSH Engine

                                                                                                                SSH Engine module in Bridge is used to perform actions in clients network/client's machine by executing a command/script in Linux/UNIX OS. Prerequisite While creating Credentials for SSH Engine, choose the credential type as SSH. Click here to learn ...
                                                                                                              • PowerShell Engine

                                                                                                                In Bridge, the PowerShell Engine module is used to perform actions in any Windows machines in the client's network using PowerShell script. Prerequisite While creating Credentials, select the type Powershell and provide the User Name and Password of ...
                                                                                                              • Task Engine

                                                                                                                In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in bridge ...
                                                                                                              • DB Engine

                                                                                                                DB Engine is used to connect with the database in the client's machine or client's network and perform READ/INSERT/UPDATE operations in the database. The DB Engine configured in bridge can be utilized in the following two distinct modules within ...
                                                                                                              • DB Engine

                                                                                                                DB Engine state enables a connection with the database hosted on a private or local network and executes the defined SQL query in the database. Prerequisite An active Bridge agent. Refer here to install and configure Bridge. Create the necessary ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources