PowerShell Task Configuration  

Enabling PowerShell Remoting  

To run PowerShell tasks in the Windows environment using the Bridge agent, remoting must be enabled. There are two ways to enable this:

• Remote Session (Default):

• PowerShell remoting must be enabled by default for tasks to run successfully. The PowerShell engine task runs only on the local (Bridge-installed) machine, while other PowerShell task states work on both local and remote machines.

• To enable remoting on the local host, use the command: Enable-PSRemoting. For more details, click here.

• You can verify or manually enable remoting using the command: winrm quickconfig. For more information, click here.

• Without Remote Session:

• When executing PowerShell scripts directly without a remote session, this functionality is not available by default. You need to configure it manually.

• Steps:

1. Go to the Bridge installation folder: Bridge >> config >> powershell.properties.

2. Add the following property: bridge.pwsh.script.execute.session=false.

3. In Windows, open Services, locate Qntrl Bridge, and Restart.

• After this configuration, PowerShell tasks will execute in a non-remote session.
  

{
	"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"
}

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

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

{
	"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"
}

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

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