# mulesoft Microsoft Windows PowerShell Connector - Full Documentation

<!-- document id=87b123d33e494346611d72981285265233c9cf7b7372f0ffa5f8394b7c7d77c5 url=/mulesoft/current/en-us/windows-powershell-connector/latest/index.md -->

---
product: Microsoft Windows PowerShell Connector
version: 2.1
is-latest-version: true
---

# Microsoft Windows PowerShell Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Microsoft Windows PowerShell Connector Version 2.1

Anypoint Connector for Microsoft Windows PowerShell (PowerShell Connector) enables you to integrate
Windows administration tasks into Mule applications. PowerShell Connector enables you to connect to
any machine, local or remote, to execute script files and commands on those machines. You can use
SSH to execute PowerShell scripts on a remote Windows or Linux (Ubuntu) machine and have the result
processed within Mule runtime engine (Mule).

> [!NOTE] The connector does not support executing a PowerShell script on a MacOS computer.

For information about compatibility and fixed issues, see
[Microsoft Powershell Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/microsoft-powershell-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

To work with PowerShell Connector, you must first install an SSH server on a Windows or Linux
(Ubuntu) remote machine:

- Windows

  1.  Download [OpenSSH for Win32 or Win64](https://github.com/PowerShell/Win32-OpenSSH/releases).

  2.  Follow the
      [OpenSSH installation steps](https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH).

- Linux (Ubuntu)

  1.  Follow the [SSH installation steps](https://ubuntu.com/server/docs/).

  2.  Follow
      [install PowerShell on Linux](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-6)
      from Microsoft.

## Add a POM File Dependency

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-powershell-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Verify that the connector `version` corresponds to the one you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `hdfs`.

4.  Click **Dependency Snippets**.

## Add the Connector in Studio

Add PowerShell Connector to a Mule project to automatically populate the XML code with the
connector’s namespace and schema location, as well as add the required dependencies to the project’s
`pom.xml` file.

1.  In Anypoint Studio, from the main menu, select **File > New > Mule Project**.

2.  Enter a name for your Mule project, and click **Finish**.

3.  In the **Mule Palette** view, click **(X) Search in Exchange**.

4.  In **Add Modules to Project**, type `powershell` in the search field.

5.  Click the name of the connector in **Available modules**.

6.  Click **Add**.

7.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that same connector available to other
projects in your Studio workspace.

### Configure a Global Element in Studio

1.  In Studio, click the **Global Elements** tab at the bottom of the canvas.

2.  In the **Global Configuration Elements** screen, click **Create**:

    ![Choose Global Type window with list of configurations](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-config-global-wizard.png)

3.  In the **Choose Global Type** wizard, expand **Connector Configuration**, select either
    **Windows Configuration** or **Linux Configuration**, and click **OK**.

    This selection enables you to connect remotely to the type of operating system that you choose.

4.  Configure the parameters as follows:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Connection type: Windows or Linux</p></div></div></td></tr><tr><td><p><strong>IP Address</strong></p></td><td><div><div><p>IP address of the machine on which you want to execute the script file or command</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>User associated with the Windows or Linux machine</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Password associated with the user name</p></div></div></td></tr></tbody></table>

    In the previous image, the placeholder values refer to a configuration file
    `mule-artifact.properties` placed in the `src/main/resources` folder of your project.  
    You can enter your credentials in the global configuration properties, or you can reference a
    configuration file that contains those values.

    To simplify maintenance and improve project reusability, of your project, use a configuration
    file. Keeping these values in a separate file is useful if you need to deploy to different
    environments, such as production, development, and QA, where your access credentials differ.

    See
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)
    for more information.

5.  Keep the **Advanced** tab default values.

6.  Click **Test Connection**.

7.  Click **OK**.

8.  Your configuration should look like this:

    ![Global element properties window with Windows configuration](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-config.png)

## Next Step

After you configure the PowerShell Connector, see the
[Examples](https://docs.mulesoft.com/windows-powershell-connector/latest/microsoft-powershell-connector-examples) topic for more configuration information.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Microsoft Windows PowerShell Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-powershell-connector/)

- [OpenSSH for Windows](https://github.com/PowerShell/Win32-OpenSSH/releases#)

- [OpenSSH installation steps](https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH)

- [Linux install SSH](https://documentation.ubuntu.com/server/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=d0d3494c5a0711ea16cf96f44a9b7908be795b5e646230d6306296005fb5281c url=/mulesoft/current/en-us/windows-powershell-connector/latest/microsoft-powershell-connector-examples.md -->

---
product: Microsoft Windows PowerShell Connector
version: 2.1
is-latest-version: true
---

# Microsoft Windows PowerShell Connector Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Execute a Command on a Remote Windows Machine

In this example, the Mule flow executes a command on a remote Windows machine:

![Flow with Listener, Execute command, and Logger](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-execute-command.png)

1.  Create a new Mule project in Anypoint Studio.

2.  Add the following properties to the `mule-artifact.properties` file to store your PowerShell
    credentials:

    ```text
    config.host=<IpAddress>
    config.username=<UserName>
    config.password=<Password>
    ```

3.  Place the properties file in the project’s `src/main/resources` directory.

4.  Drag an **HTTP > Listener** component onto the canvas and configure the following parameters:

    ![Listener configuration values in properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-http-props.png)

5.  Create a configuration for the HTTP Listener if you do not already have one:

    1.  Click the plus sign (+) on the right side of **Connector Configuration** to add a new HTTP
        Listener configuration.

    2.  Enter the following values:

        - **Host**: `localhost`

        - **Port**: `8081`

    3.  Click **OK**.

6.  In the **General** section, for **Path**, enter `/executecommand`.

7.  Drag the **Execute command** operation of the PowerShell Connector next to the HTTP Listener
    component.

8.  Add a new PowerShell global element to configure the PowerShell Connector:

    1.  Click the plus sign (+) on the right side of the **Connector Configuration** field.

    2.  Configure the global element:

        - Name  
          The name for the configuration

        - IP Address  
          The IP address of the machine on which to execute your script file or command

        - Username  
          The name of the user associated with the machine on which to execute your script file or
          command

        - Password  
          The password for the user

          Your configuration should look like this:

          ![Global element properties window for Windows configuration](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-config.png)

          The corresponding XML configuration is:

          ```xml
          <powershell:config name="Powershell_Configuration"
            doc:name="PowerShell Configuration">
          <powershell:windows-connection
          	host="${config.host}"
          	username="${config.username}"
          	password="${config.password}" />
          </powershell:config>
          ```

9.  Click **Test Connection**.

10. If the test is successful, click **OK**; if not, review and correct any incorrect parameters and
    test the connection again.

11. In the **General** properties editor of the PowerShell **Execute command** operation, configure
    the remaining parameters:

    - Display Name  
      The name to display for the Execute command operation

    - Command  
      The command to execute on the remote or local machine:

      ![Execute command operation properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-execute-command-props.png)

12. Verify that your XML looks like this:

    ```xml
    <powershell:execute-command
    	doc:name="Execute command"
    	config-ref="Powershell_Configuration"
    	command="ipconfig"/>
    ```

13. In **Mule Palette > Core**, select **Logger** and then drag it to the canvas after the **Execute
    command** operation.

14. Configure **Logger**:

    1.  Enter a display name for the Logger component.

    2.  For **Message**, enter `#[payload]` so the Mule log message comes from the payload.

    3.  Set **Level** to `INFO`:

        ![Logger properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-logger-props.png)

15. Click **File > Save**.

16. Right-click the project in Package Explorer and click **Run As > Mule Application**.

17. Open a browser and validate the response after entering the URL
    `http://localhost:8081/executecommand`.

    You should see the output of the **Execute command** operation in the browser and the Studio
    console.

## Execute a Script File

In this example, you create a Mule flow that executes a script file:

![Flow with Listener, Parse Template, Execute script file, and Logger](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-execute-script-file-flow.png)

To create the Mule flow:

1.  Drag an **HTTP Listener** component onto the canvas and enter `Listener` for **Display Name**:

    ![Listener configuration values in properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-http-execute-script-file.png)

2.  Create a configuration for the **HTTP Listener**:  
    This is required if you have not already done so.

    1.  Click the plus sign (+) to add a new HTTP Listener configuration.

    2.  Enter the following values:

        - **Host**: `localhost`

        - **Port**: `8081`

    3.  Click **OK**.

3.  In the **General** section, for **Path**, enter `/executescriptfile`.

4.  In the `<mule-project>/src/main/resources` folder, create a new file named `get-en-param.ps1`,
    with the following content:

    $logFile = "C:\\Windows\\Temp\\log.txt"
    Add-Content $logFile -Value "Parameter a is
    $a"
    Add-Content $logFile -Value "Parameter b is $b"
    Add-Content $logFile -Value "Parameter
    c is $c"
    Write-Host "Parameters received are $a $b $c"

5.  Drag a **Parse template** component next to the HTTP Listener.

6.  Configure the following parameters:

    ![Parse Template configuration values in properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-parse-template-props.png)

    1.  Enter a display name for the **Parse template** component.

    2.  Enter the location of the `get-en-param.ps1` file.  
        The XML reference should look similar to this:

        ```xml
        <parse-template doc:name="Parse Template" doc:id="abc1114d-4b12-42fd-8be6-e88c4dab1887" location="get-en-param.ps1" />
        ```

7.  Drag the **Execute script file** operation of the PowerShell Connector next to the **Parse
    template** component.

8.  In the **General** properties editor of the PowerShell **Execute script file** operation,
    configure the remaining parameters:

    1.  Enter the display name for the **Execute script file** operation.

    2.  In **General > File content**, enter `#[payload]` so that the file that contains the script
        comes from the payload file.

    3.  If your script requires parameters, add the parameters for each key and value pair:

        ![\["Execute script file operation configuration values in properties window"](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-execute-script-file.png)

9.  Add a **Logger** component after the **Execute script file** operation to display output in the
    Studio console, and configure the logger:

    1.  In the **General** tab, enter a display name for the Logger component.

    2.  For **Message**, enter `#[payload]` so the Mule log message comes from the payload.

    3.  Set **Level** to `INFO`.

        ![Logger properties window](/mulesoft/current/en-us/windows-powershell-connector/latest/_images/microsoft-powershell-logger-props.png)

10. Click **File > Save**.

11. In **Package Explorer**, right-click the project and then click **Run As > Mule Application**.

12. Open a browser and validate the response after entering the URL
    `http://localhost:8081/executescriptfile`.  
    You should see the operation’s output in the browser and the console.

## Mule XML Flow

The XML for your Mule flow should look similar to this:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:powershell="http://www.mulesoft.org/schema/mule/powershell"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/powershell
http://www.mulesoft.org/schema/mule/powershell/current/mule-powershell.xsd">

    <configuration-properties file="mule-artifact.properties"/>

	<powershell:config name="PowerShell_Configuration" doc:name="PowerShell Configuration">
		<powershell:windows-connection
			host="${config.host}"
			username="${config.username}"
			password="${config.password}" />
	</powershell:config>
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config"\>
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>
	<flow name="Execute-Command-Flow" />
		<http:listener doc:name="Listener"
			config-ref="HTTP_Listener_config"
			path="/executecommand"/>
		<powershell:execute-command doc:name="Execute command"
		  config-ref="PowerShell_Configuration" command="ipconfig"/>
		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
	</flow>
	<flow name="Execute-Script-File-Flow">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config"
		path="/executescriptfile"/>
		<parse-template doc:name="Parse Template"
		location="/home/me/get-en-param.ps1"/>
		<powershell:execute-script-file doc:name="Execute script file"
		 config-ref="Powershell_Configuration">
			<powershell:parameters >
				<powershell:parameter key="a" value="5" />
				<powershell:parameter key="b" value="10" />
				<powershell:parameter key="c" value="15" />
			</powershell:parameters>
		</powershell:execute-script-file>
		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Microsoft Windows PowerShell Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-powershell-connector/)

- [OpenSSH for Windows](https://github.com/PowerShell/Win32-OpenSSH/releases#)

- [OpenSSH Installation Steps](https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH)

- [Linux Install SSH](https://ubuntu.com/server/docs/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=bd7dd2f3606f07a337e2e42422ab43d6defb6d740db2bad2b3420b6813f0ff46 url=/mulesoft/current/en-us/windows-powershell-connector/latest/microsoft-powershell-connector-reference.md -->

---
product: Microsoft Windows PowerShell Connector
version: 2.1
is-latest-version: true
---

# Microsoft Windows PowerShell Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Microsoft Windows PowerShell Connector v2.1

For information about compatibility and fixed issues, see
[Microsoft Powershell Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/microsoft-powershell-connector-release-notes-mule-4)

## Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Linux Configuration</p></li><li><p>Windows Configuration</p></li></ul></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p>ExpirationPolicy</p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges instances as it sees fit.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Linux Configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>IPAddress</p></td><td><div><div><p>String</p></div></div></td><td><p>Host used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>UserName</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session. The value for this field, can be, for example: <code>username</code> or <code>username@domain</code></p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

### Windows Configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>IPAddress</p></td><td><div><div><p>String</p></div></div></td><td><p>Host used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>UserName</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session. The value for this field, can be, for example: <code>username</code> or <code>username@domain</code></p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy</p></td><td></td><td></td></tr></tbody></table>

## Operations

- [Execute Command](#executeCommand)

- [Execute Script File](#executeScriptFile)

- [Execute Command (exception handling enabled)](#executeCommandExceptionHandlingEnabled)

- [Execute Script File (exception handling enabled)](#executeScriptFileExceptionHandlingEnabled)

## Execute Command

`<powershell:execute-command>`

This operation executes the command on the machine.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Command</p></td><td><div><div><p>String</p></div></div></td><td><p>The command to execute on the client machine.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>String</th></tr></thead></table>

### For Configurations

- config

### Throws

- POWERSHELL:RETRY\_EXHAUSTED

- POWERSHELL:CONNECTIVITY

## Execute Script File

`<powershell:execute-script-file>`

This operation executes the script file.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The file which contains the script.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>The Parameters for the Script.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation’s output is placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p>` #[payload]`</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>String</th></tr></thead></table>

### For Configurations

- config

### Throws

- POWERSHELL:RETRY\_EXHAUSTED

- POWERSHELL:CONNECTIVITY

## Execute Command (exception handling enabled)

`<powershell:execute-command-exception-handling-enabled>`

This operation executes the command on the machine and throws execution related exceptions, if any.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Command</p></td><td><div><div><p>String</p></div></div></td><td><p>The command to execute on the client machine.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>String</th></tr></thead></table>

### For Configurations

- config

### Throws

- POWERSHELL:RETRY\_EXHAUSTED

- POWERSHELL:CONNECTIVITY

- POWERSHELL:EXECUTION\_EXCEPTION

## Execute Script File (exception handling enabled)

`<powershell:execute-script-file-exception-handling-enabled>`

This operation executes the script file on the target machine and throws execution related
exceptions, if any.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The file which contains the script.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>The parameters for the script.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation’s output is placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p>` #[payload]`</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><thead><tr><th>Type</th><th>String</th></tr></thead></table>

### For Configurations

- config

### Throws

- POWERSHELL:RETRY\_EXHAUSTED

- POWERSHELL:CONNECTIVITY

- POWERSHELL:EXECUTION\_EXCEPTION

## Types

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>The reconnection strategy to use.</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)