These states are used to perform any actions in the Windows machines of a private network using PowerShell commands.

1. PowerShell Engine
2. Install WindowsApp
3. Uninstall WindowsApp
4. Start Service
5. Stop Service
6. Restart WindowsServer

Almost all the operations can be performed using the PowerShell Engine state, but in order to facilitate reusability, some frequently used operations are provided as separate states.

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.

1. PowerShell Engine

Executes an attached PowerShell script file on the Windows machine in a private network.

Builder View

For associating the state to a Circuit:

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

2. In the Configuration section, update the common state field attributes. 
   

3. In Bridge ID, click and select the Bridge to be configured to the state from the drop-down list.

4. Under the Add Configuration section, fill in the following fields:

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

2. Script ID - Select the name of the Script to be executed. To create a new script file, navigate to Scripts.

3. Host - Enter the hostname of the machine in which the shell command has to be executed.

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

6. Under Add Credentials section, click Add to enter the credentials of any Windows machine that has to be connected through PowerShell script. 

1. Var name - Give a name for the credential.
   

2. 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'. 

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

8. In the Input/Output section, enter the required paths. To learn more about I/O paths, click here. 

      

Code view

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

2. Install WindowsApp  

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.

In Code View, the JSON to install a Windows app using PowerShell task in Circuit is given below:

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

3. Uninstall WindowsApp  

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

To uninstall an app from the Windows machine, in Builder View, under Add Configuration, in App Name, enter the name of the app to be uninstalled from the Windows machine along with the common state field attributes.

In Code View, the JSON to uninstall a Windows app using a PowerShell task in Circuit is given below:

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

4. Start Service  

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

To configure a Start Service in Builder View, fill in the common field attributes, and under Add Configuration, in Service Name, enter the name of the service that has to be initiated in a Windows machine.    

  

In Code View, the following JSON is used to start a service using PowerShell engine task in Circuit:

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

5. Stop Service  

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

For associating the Stop Service state in Builder View, fill in the common state field attributes. Under Add Configuration, in the Service Name field, enter the name of the service that has to be stopped in the Windows machine.

 

In Code View, the following JSON is used to stop a service using PowerShell engine task in Circuit:

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

  

5. Restart Windows Server  

"Restart WindowsW10": {
      "type": "restart_windows_server",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "credential_id": "<credential_name>",
            "host": "host_name>"
      }
}