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" }
- Restart WindowsServer can only be performed when no users are logged in. If any users are logged in, the restart cannot be performed.
- The execution policy should permit the execution of scripts from remote sources.
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
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 ...
New to Zoho LandingPage?
Zoho LandingPage Resources