Microsoft Windows PowerShell Connector Reference - Mule 4
Microsoft Windows PowerShell Connector v2.0
For information about compatibility and fixed issues, see Microsoft Powershell Connector Release Notes
Configuration
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
|
The connection types that can be provided to this configuration. |
x |
|
Expiration Policy |
ExpirationPolicy |
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. |
Connection Types
Linux Configuration
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
IPAddress |
String |
Host used to initialize the session. |
x |
|
UserName |
String |
Username used to initialize the session. The value for this field, can be, for example: |
x |
|
Password |
String |
Password used to authenticate the user. |
x |
|
Reconnection |
Reconnection |
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. |
Windows Configuration
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
IPAddress |
String |
Host used to initialize the session. |
x |
|
UserName |
String |
Username used to initialize the session. The value for this field, can be, for example: |
x |
|
Password |
String |
Password used to authenticate the user. |
x |
|
Reconnection |
Reconnection |
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 |
Execute Command
<powershell:execute-command>
This operation executes the command on the machine.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Command |
String |
The command to Execute on the client machine. |
x |
|
Target Variable |
String |
The name of a variable on which the operation’s output is placed. |
||
Target Value |
String |
An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. |
|
|
Reconnection Strategy |
|
A retry strategy in case of connectivity errors |
Execute Script File
<powershell:execute-script-file>
This operation executes the script file.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File Content |
Binary |
The file which contains the script. |
|
|
Parameters |
Object |
The Parameters for the Script. |
||
Target Variable |
String |
The name of a variable on which the operation’s output is placed. |
||
Target Value |
String |
An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. |
` #[payload]` |
|
Reconnection Strategy |
|
A retry strategy in case of connectivity errors. |
Types
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
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. |
||
Reconnection Strategy |
|
The reconnection strategy to use. |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often to reconnect (in milliseconds). |
||
Count |
Number |
The number of reconnection attempts to make. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
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. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute. |