These states are used to perform any actions in the Windows machines of a private network using PowerShell commands.
Prerequisite
An active Bridge agent. Refer here to install and configure Bridge.
Create necessary Credentials for the applications to be connected by PowerShell Task Engine.
Executes an attached PowerShell script file on the Windows machine in a private network.
For associating the state to a circuit:
In Builder View, drag and drop the PowerShell Engine state from the left pane into your circuit or click the required state in your circuit.
In the Configuration section, update the common state field attributes.
In Bridge ID, click and select the bridge to be configured to the state from the drop-down list.
Under the Add Configuration section, fill in the following fields:
Credential ID - Click and select the credential from the dropdown list. The Credential ID of all the credentials created for the SSH module type will be displayed in the list.
Script ID - Select the name of the script to be executed. To create a new script file, navigate to Scripts.
Host - Enter the hostname of the machine in which the shell command has to be executed.
Under the Variable section, click Add, the field will expand and allow you to add variables that have to be executed in the PowerShell script. Enter a variable name and its param value.
Under Add Credentials section, click Add to enter the credentials of any Windows machine that has to be connected through PowerShell script.
Var name - Give a name for the credential.
Name- Select the credential name from the dropdown list, that has to be connected through the PowerShell script. To remove an added variable or credential, hover over the line below the fields and click 'Remove'.
In the Error Handling section, you can select and configure error handling settings. For additional details, refer to the Error Handling in the circuit states.
"Windows OS Installation": {"type": "powershell_engine","next": "Licence Key Activation-Windows","start": true,"bridge_id": "bridge-employee onboarding","payload": {"credential_id": "PWSH Credential for OS installation","script_id": "Script-OSinstall","host": "localhost","variables": {"os_filename": "windows.iso"},"credentials": [{"variable": "Windows_SK01","credential_id": "psh_cred_5"}]}}
This state allows users to install apps in the Windows machines using PowerShell.
This state can be configured in Builder View by entering the MSI file location of the app to be installed in the MSI Filepath field under the Add Configuration section in addition to the common field attributes.
"Install an Application": {"type": "install_windows_app","next": "End","start": true","bridge_id": "bridge-employee onboarding","payload": {"credential_id": "PWSH Credential for OS installation","host": "localhost","msi_file_path":"C:\\Users\\Administrator\\Downloads\\tortoisehg-5.8.0-x64.msi"}}
An existing app can be uninstalled from the Windows machine using this state.
"Uninstall Windows App": {"type": "uninstall_windows_app","next": "End","start": true,"bridge_id": "<bridge_name>","payload": {"credential_id": "<credential_name>","host": "<host_name>","app_name": "<application_name>"}}
"Start App Management Service": {"type": "start_service","next": "End","start": true,"bridge_id": "bridge-employee onboarding","payload": {"credential_id": "pwsh_cred_5","host": "localhost","service_name": "AppMgmt"}}
"Stop a Service": {"type": "stop_service","next": "End","start": true,"bridge_id": "<bridge_name>","payload": {"credential_id": "<credential_name>","host": "<host_name>","service_name": "<service_name>"}}
This state is used to restart the Windows server operating system which stops all running processes and services on the server, followed by a complete system reboot. It is often done to apply system updates, resolve issues, or perform routine maintenance tasks.
To configure the state in Builder View, under Add Configuration, select the Credential ID and enter the Host name of the Windows machine that has to be restarted.
"Restart WindowsW10": {"type": "restart_windows_server","next": "End","start": true,"bridge_id": "<bridge_name>","payload": {"credential_id": "<credential_name>","host": "host_name>"}}
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
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.
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.