PowerShell Adapter

Executes PowerShell scripts and returns the results.

Remarks

The adapter can execute PowerShell scripts on a local PowerShell Runspace or on remote machines using the PowerShell V2 Remoting or PowerShell SSH protocols.

Sender Property List

The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.


Firewall	A set of properties related to firewall access.
Host	The host where the command should be executed.
MaxThreads	The maximum number of threads that the adapter may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
Other	Defines a set of configuration settings to be used by the adapter.
Password	The password to use when executing commands remotely.
Port	The TCP port number to use for remote connections.
PortName	A unique name assigned to this send port.
Protocol	The protocol to use for executing remote commands.
RuntimeLicense	Specifies the adapter runtime license key.
Script	The PowerShell script to execute.
SSHAcceptServerHostKey	Instructs the adapter to accept the server host key that matches the supplied key.
SSHAuthMode	The type of authentication used by the adapter.
SSHCert	The certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithms	A comma-separated list of compression algorithms allowed for this connection.
Timeout	A timeout for the adapter.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	The username to use when executing commands remotely.
Variables	Variables to add to the PowerShell Runspace before executing the command.

Configuration Settings

The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.


ReportScriptError	Whether script errors cause a failure.
LogSSHPackets	If True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrint	Instructs the adapter to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseManagedSecurityAPI	Tells the adapter whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.