/n software Workflow Activities V4 - Online Help
Available for:
/n software Workflow Activities V4
Questions / Feedback?

SExec Activities

Properties   Configuration Settings  

The SExec Activity enables your WorkFlow to execute remote commands over SSH.

Remarks

The SExec Activity uses the SSH "exec" subsystem to remotely execute commands from your WorkFlow.

SExec Send Activity

The SExec Send Activity provides an ultra light-weight remote command execution client for your WorkFlow. You must first set an SSHHost. If the SSH server requires authentication, you should set the necessary SSHUser, and either SSHPassword or SSHCert depending on the SSHAuthMode you wish to use. Once the SSH server information is set, you must enter the Command you wish to execute.

Whenever called from the WorkFlow, the activity will execute the given command. If the Stdin property has any data, that data will supplied to the executing command's standard input.

Once the command has finished executing, the activity will write the output from the command's standard out pipe to the variable pointed to by the CommandStdOut property. It will also write the command's exit code to the variable pointed to by the CommandExitStatus property, and any data from the standard err pipe to the variable pointed to by the CommandErrorMessage property.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Sender Property List


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

CommandThe command to be sent to the remote host.
CommandErrorMessageThe error message, if any, returned by the server after command execution.
CommandExitStatusThe exit code for the executed command for the current message.
CommandStdErrThe standard error output of the executed Command .
CommandStdOutThe standard output of the executed Command .
FailOnErrorControls how the activity treats error codes returned by command execution.
FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during activity execution.
OtherDefines a set of configuration settings to be used by the activity.
PersistentConnectionInstructs the activity whether to keep the connection to the server open.
RuntimeLicenseSpecifies the activity runtime license key.
SSHAcceptServerHostKeyInstructs the activity to accept the server host key that matches the supplied key.
SSHAcceptServerHostKeyAcceptAnyTells the activity to accept any server certificate.
SSHAuthModeThe type of authentication used by the activity.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
StdinA string of data that will be supplied to the executing command's standard input.
TimeoutA timeout for the activity.

Configuration Settings


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

LogSSHPacketsIf True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrintInstructs the activity to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseManagedSecurityAPITells the activity whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.5.6240.0