Contact Us 1-800-596-4880
  1. Homepage
  2. Microsoft Windows PowerShell Connector (2.1)

  3. Microsoft Windows PowerShell Connector Reference

All Connectors

Microsoft Windows PowerShell Connector Reference - Mule 4

Microsoft Windows PowerShell Connector v2.1

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

  • Linux Configuration

  • Windows Configuration

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: username or username@domain

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: username or username@domain

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

Operations

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

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type String

For Configurations

  • config

Throws

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

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.

#[payload]

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type String

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

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

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type String

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

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.

#[payload]

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type String

For Configurations

  • config

Throws

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

  • POWERSHELL:EXECUTION_EXCEPTION

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

  • reconnect

  • reconnect-forever

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

See Also

MuleSoft Help Center

Back to top
View on GitHub