Scripts in Qntrl | Qntrl | Bridge | Online Help | Larger script execution made easy in Qntrl

Scripts

Alert
Early Access  

Scripts module is not enabled for all users. If you’d like to try it out, please email our support team for early access.

​
Scripts module helps to simplify message execution for larger scripts. While simple commands can be executed directly in the Message module, complex larger scripts that involve a series of tasks or multiple commands can be saved as a script file in this module. The saved scripts can be executed in the specified machine by passing the script name in the JSON request of the message.

Create a Script   

To create a new script:

  1. Click the settings gear iconat the left pane.

  2. Navigate to Advanced >> Bridge >> choose Scripts.

  3. Click the New Script button.

  4. Feed in the required New Script details.

    1. Name: Give a name with a file extension to identify the script (Ex: display.sh/display.ps1).

    2. Description: Provide a description that serves for later reference.

    3. Script Type: Choose the type of script. 

      1. Shell Script - For UNIX-based systems

      2. PowerShell Script - For Windows operating systems

      3. LDIF - For Windows Active Directory operations

    4. Script File: If the script is available in a local file you may attach it in this field, and it will be executed in the message.

    5. Content: Alternatively, the commands that need to be executed can be given directly in this field.                  

  1. Click Save. A new script will be created.



Info
Points to ponder
  1. Either commands can be given in the Content field or you can choose and attach a script file in the Script File field.
  2. When a script file is attached, the name of the file is assigned to the Name field by default, which can be renamed, and the commands from the attached file will be automatically displayed in the Content field.   
​
In request data of the message, the scripts are passed using the following keys:
For Shell Script  
"command": "sh <SSH_DIR>/<scriptFileName>" (Ex: "sh <SSH_DIR>/display.sh")
For PowerShell Script
"script-name": "<scriptFileName>.ps1" (Ex: "script-name": "display.ps1") 
For LDIF Script
"script-name": "<LDIF-File name>.ldif" (Ex: "script-name": "display.ldif")

Edit a Script   

To update an existing script:

  1. Navigate to(settings) >> Advanced >> Bridge >> select Scripts.

  2. In the list of scripts loaded, click on the script name you want to edit.

  3. Make the required modifications and click Save.


Delete a script   

To remove a script from Qntrl,

  1. Navigate to(settings) >> Advanced >> Bridge >> select Scripts.

  2. Hover over the name of the script you want to delete, click the mouse over action menu, and select the Delete menu item.

  3. Confirm the delete action.


 


    • Related Articles

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

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

    • Install and Configure 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. Log in to Qntrl. Navigate to (Settings) >> Advanced >> Bridge, and click Downloads. ...

    • Custom Module

      Early Access Custom Module is not enabled for all users. If you’d like to try it out, please email our support team for early access. The Custom Module in Qntrl Bridge lets you extend integration capabilities beyond predefined modules, such as API, ...

    • 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. Learn how to install and ...