Configure Bridge in Qntrl | Bridge | Qntrl | Online Help

Install Bridge

Follow the below step-by-step procedures to configure and use Bridge in Qntrl.

Step 1: Download the Bridge agent

Only one Bridge agent can be installed per machine. To download a bridge agent in Qntrl:
  1. Navigate to (settings), under Advanced click Bridge, and select Downloads.
  1. Bridge agent is available for both Windows and Linux OS. Download the file based on your OS.
    1. Windows users have separate download links for 32-bit and 64-bit OS. You may choose the one as per your requirement.
    1. Linux users can either directly download the installable zip file using the Directly Download button or can copy the wget command and execute it in a terminal to download the zip.  
 

Step 2: Install the Bridge agent   

Prerequisites:
  • Ensure administrative privileges for installation.
  • Java Runtime Environment (JRE) is required. If not available, the bundled Java with Bridge Agent can be used.

Setting up Bridge agent for Linux   

Once the Bridge agent is downloaded as in the previous step:
  1. Copy the installation link provided on the above Downloads page under the Linux section.
  2. ​Traverse to the directory where you have downloaded the installable zip.
  3. Execute the installation link (copied in the previous step) in your terminal. This action will:
    1. install a daemon and 
    2. start the bridge agent.
  4. If using bundled Java, open the file [Bridge_Home]/conf/wrapper-bridge.conf with the suitable editor and replace the value assigned to the key wrapper.java.command as jre/bin/java.exe.
  1. Once the installation is successful:
    1. a new bridge entry will be added automatically to the Bridge list page of Qntrl and
    2. the new bridge agent will be started.
Info
  1. To stop a running bridge agent execute the command: sh [Bridge_Home]/bin/bridge.sh stop
  2. To restart the bridge agent, execute the command: sh [Bridge_Home]/bin/bridge.sh start 

Setting up Bridge Agent for Windows 

Once the Bridge agent installation file, (Viz., qntrl_bridge_agent.exe) is downloaded:
  1. Execute the qntrl_bridge_agent.exe file. This action will, by default:
    1. install the Bridge agent in %localappdata% /Bridge folder.
    2. add it to the services list.
    3. start the bridge agent.
  2. If using bundled Java, open the file [Bridge_Home]/conf/wrapper-bridge.conf with the suitable editor and replace the value assigned to the key wrapper.java.command as jre/bin/java.exe.
  3. Upon successful installation:
    1. A new bridge entry is automatically added to the Bridge list page on Qntrl.
    2. The new Bridge agent is started.
Info
  1. To stop a running Bridge agent execute the command: [Bridge_Home]/bin/bridge.bat stop
  2. To restart the Bridge agent, execute the command: [Bridge_Home]/bin/bridge.bat start

Once the Bridge agent is up and running, it will automatically open the login page in the default browser. You can view the status( Active/Down) of your bridge in the Bridge list page.


Warning
  1. Do not share bridge files with anyone, and ensure the secure protection of the bridge location. Otherwise, there's a risk of sensitive information being exposed.
  2. Do not modify or remove any properties within the installed bridge configuration files. The inherent files in bridge should not be edited, deleted, or shared.

Step 3: Execute a Bridge Message

Message module is used to test/execute a task in Bridge, to do so:
  1. In Qntrl, navigate to(settings) under Advanced click Bridge, and select Messages. 
  2. In the Message list page that loads, click the New Message button.
  3. In the New Message window, enter the following details.
    1. Name: Enter a unique name for the message, so that it can be reused by different Bridges when required.
    2. Bridge: Select the bridge you would like to test/execute from the dropdown list.
    3. Module: Select one of the modules from the dropdown list. The task related to the selected module alone will be executed through this message. Task Engine and DB Engine modules will be associated by default while creating a bridge.
      1. Task Engine - To execute API tasks in third-party or internally hosted app
      2. DB Engine - To perform SQL queries in a database hosted in a closed network
      3. SSH Engine - To connect a remote Linux/Unix machine and to execute required commands
      4. PowerShell Engine - To connect a remote Windows machine and to execute required commands
      5. File Management - To transfer files from one location to another
      6. AD Engine - Connects and performs secured operations in Active Directory
    4. Type: Select the message type.
      1. Synchronous - Executes tasks in the same request and provides a response
      2. Asynchronous - Executes tasks in the background
    5. Request Data: The instructions to be executed by the bridge have to be given here in JSON format. Based on the module chosen, the key value parameters will  change. To learn more about the request data format and parameters check Bridge Modules.
    6. Response: If the type is Synchronous, the response to the request will be displayed under this tab.
  1. Once all the details are filled, click Execute.



After successfully executing a message, you can review the response (for synchronous message types) and find a server call entry in the Message list of your Bridge agent by following these steps:
  1. Navigate to  (settings) >> Advanced >> Bridge >> select Bridge. 
  2. Hover your cursor over the bridge name, then click on the action menu, and select Open Agent.
  3. This will direct you to the Bridge Agent login page. Log in with your Username and Password.
  4. Navigate to the Messages section in the Header bar. On the Message list page, use the dropdown menu to choose the messages you wish to access from the list.






Next:
            





    • Related Articles

    • Bridge agent settings

      Once the Bridge agent is set up, you can log in to the bridge agent to view and modify the allowed configuration as needed. To do this: In Qntrl, navigate to (settings) >> Advanced >> Bridge, then select your bridge. Hover your cursor over the bridge ...

    • Other actions in Bridge

      View / Edit Bridge properties Follow the given steps to view or edit the properties of a bridge: Click the settings gear icon located in the left pane. Navigate to Advanced >> Bridge >> choose Bridge. In the Bridge list page, choose the specific ...

    • Overview of Bridge

      What is a Bridge? Bridge is an installable, lightweight independent agent that can be deployed on the customer’s local network. It is compatible both on Windows and Linux machines with 32 and 64-bit OS. Its role is to facilitate communication between ...

    • PowerShell Engine

      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 ...

    • Zoho Directory in Qntrl

      What is Active Directory? Active Directory (AD) by Microsoft is a domain management system for centralized networks. Using AD, you can add users, define their privilege, store and manage information, and authorize and authenticate user accounts. What ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.