Bridge 3.0 Commands
Bridge provides a set of commands to install, configure, manage, and troubleshoot the bridge service across operating systems.
Before You Begin
Command Syntax : <bridge_script> [command]
<bridge_script> refers to the respective script path for your operating system.
Linux / macOS: bridge.sh
Windows: bridge.bat
For example:
On Linux/macOS: sudo sh /Bridge/bin/bridge.sh start
On Windows: cmd.exe /c 'C:\Bridge\bin\bridge.bat start'
Permission Requirements
Different commands require specific user privileges depending on your OS.
User Role | Applicable OS | Description |
admin | Windows | User with administrator privileges (must run from an elevated PowerShell or Command Prompt) |
root | Linux, macOS | System root user (run commands using the sudo command) |
service-user | All OS | The non-root local user account configured to run the Bridge service |
If a command fails due to insufficient permissions, re-run it with administrator or sudo privileges as required.
Uninstall Bridge Agent (Installed using Zip)
Open the terminal and execute the following commands to stop, uninstall and remove the bridge agent.
OS | Command | ||
| Stop | Uninstall | Remove |
Windows | cmd.exe /c 'C:\Bridge\bin\bridge.bat' stop | cmd.exe /c 'C:\Bridge\bin\bridge.bat' uninstall | Remove-Item 'C:\Bridge' -Force -Recurse |
Linux | sudo sh /Bridge/bin/bridge.sh stop | sudo sh /Bridge/bin/bridge.sh uninstall | sudo rm -rf /Bridge |
macOS | sudo sh/Library/Bridge/bin/bridge.sh stop | sudo sh/Library/Bridge/bin/bridge.sh uninstall | sudo rm -rf /Library/Bridge |
Primary Commands
Command | Description | Required Permission |
<bridge_script> install | Configures and installs the Bridge Agent | Windows: admin |
<bridge_script> start | Starts the Bridge service | Windows: admin/service-user |
<bridge_script> restart | Restarts the Bridge service | Windows: admin/service-user |
<bridge_script> stop | Stops the Bridge service | Windows: admin/service-user |
<bridge_script> uninstall | Uninstalls the Bridge service | Windows: admin |
<bridge_script> update | Manually updates the bridge to the latest version | service-user |
<bridge_script> reset_password | Resets the Bridge password. | Windows: admin |
<bridge_script> check_connectivity | Verifies Bridge’s connectivity to Qntrl domains and lists any unreachable domains | admin / root / service-user |
Supplementary Commands
Command | Description | Required Permission |
<bridge_script> check_encryption | Checks whether encryption is supported | admin / root / service-user |
<bridge_script> configure_proxy | Updates proxy configuration details | admin / root / service-user |
<bridge_script> configure_postgres | Updates PostgreSQL configuration | admin / root / service-user |
<bridge_script> reconfigure | Updates Bridge configuration settings | admin / root / service-user |
<bridge_script> status | Displays the status of the bridge | admin / root / service-user |
<bridge_script> send_logs | Sends Bridge logs to Qntrl support for troubleshooting | admin / root / service-user |
<bridge_script> sync_scripts | Syncs scripts from the Qntrl cloud to the local bridge | service-user |
<bridge_script> update force | Re-runs the update for the current version | service-user |
<bridge_script> update <target_version> | Updates Bridge to a specified version | service-user |
<bridge_script> help | Displays all available commands and usage information |
|
Related Articles
Other actions in Bridge
You can perform various additional actions from the Bridge page to manage, monitor, and troubleshoot your Bridge setup. To access the Bridge page: In Qntrl, click the settings gear icon in the left pane bottom. Navigate to Advanced >> Bridge and ...Bridge Agent Configuration
The Bridge Agent serves is the local management console for your Bridge installation. It provides access to service configurations, execution logs, messages, credentials, and communication settings. The Agent UI is accessible only from within the ...Bridge System Requirements
Qntrl Bridge is a secure and efficient agent that facilitates secure data transfer between on-premise systems and the Qntrl cloud. To ensure optimal performance and stability, it’s essential to install Qntrl Bridge on systems that meet the minimum ...PowerShell Task Engine
These states are used to perform any actions in the Windows machines of a private network using PowerShell commands. There are six states available in the PowerShell Task Engine for performing different operations. PowerShell Engine Install ...Configuring Additional Components
Early Access Circuit Templates in Qntrl Studio is not enabled for all users. If you’d like to try it out, please email our support team for early access. Webhooks Webhooks enable automated HTTP notifications that are sent to third-party applications ...