PowerShell Engine module in Bridge | Qntrl | Bridge | Online Help

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 the machine where the powershell script has to be executed. Click here to learn how to create a credential.

The following section explains the tasks associated with the PowerShell Engine module and the request data for performing  tasks using bridge.
To perform tasks using the PowerShell engine module requires stable network connectivity between the Windows machines.
Common keys in the Request data,
Keys
Description
  task_details
  A JSON object that contains the details of the task.
  activity_name
 Name of the activity performed in the PowerShell Engine module.
  exec_path
  (optional)
 Executable path of the installed powershell in the remote Windows machine.
  host_ip
 Address of Windows machine where the activity has to be performed.
  credential
 A JSON object that contains credentials of the machine in which the powershell script has to       be executed.
  name
 Name of the machine credential.
  task_name
 A system-defined name for the respective modules. 'pwsh_task' is the task name for         PowerShell Engine.

PowerShell Engine

This task is used to execute an attached PowerShell script file on the remote Windows machine.

Request data  

{
    "task_details": {
      "activity_name": "start_service",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>",
      "script_name": "<name of the script file>"
    },
    "credential": {
      "name": "<CREDENTIAL_NAME>"
}, "task_name": "pwsh_task" }
where,
script_name - the name of the script file to be executed in a Windows machine.

Install WindowsApp

This task allows users to install apps in Windows machines using PowerShell.


Request data  

{
    "task_details": {
      "activity_name": "install_app",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>",
      "file_path": "<PATH FOR THE APP TO BE INSTALLED> ",       "msi_file_name": "<NAME OF THE MSI FILE>" }, "credential": {       "name": "<CREDENTIAL_NAME>"
}, "task_name": "pwsh_task" }
where,
file_path - msi file path for the app to be installed on the Windows machine.
msi_file_name - msi file name of the app to be installed.

Uninstall WindowsApp

An existing app can be uninstalled from the Windows machine using this task.


Request data  

{
    "task_details": {
      "activity_name": "uninstall_app",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>",
      "app_name": "<APPLICATION_NAME>" }, "credential": {       "name": "<CREDENTIAL_NAME>"
}, "task_name": "pwsh_task" }
where,
app_name - the name of the app to be uninstalled from the Windows machine.

Start Service

The task helps to start a service in the backend Windows server.

Request data  

{
    "task_details": {
      "activity_name": "start_service",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>",
      "service_name": "<NAME OF THE SERVICE>" }, "credential": {       "name": "<CREDENTIAL_NAME>"
}, "task_name": "pwsh_task" }
where,
service_name - the name of the service that has to be initiated in the Windows machine.

Stop Service

A service running in the backend Windows server can be stopped with this task.


Request data  

{
    "task_details": {
      "activity_name": "stop_service",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>",
      "service_name": "<NAME OF THE SERVICE>" }, "credential": {       "name": "<CREDENTIAL_NAME>"
}, "task_name": "pwsh_task" }
where,
service_name - the name of the service that has to be stopped in the Windows machine.

Restart WindowsServer

This task helps to restart a remote Windows machine using PowerShell.


Request data  

{
    "task_details": {
      "activity_name": "restart_server",
      "exec_path": "<PATH OF EXECUTABLE FILE>",
      "host_ip": "<HOST_NAME>"
},   "credential": {       "name": "<CREDENTIAL_NAME>"    }, "task_name": "pwsh_task" }
  1. Restart WindowsServer can only be performed when no users are logged in. If any users are logged in, the restart cannot be performed.
  1. The execution policy should permit the execution of scripts from remote sources.


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        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







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now




                                                        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


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


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

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