Telnet Task

Properties   Config Settings  

The Telnet Component enables remote execution of commands over Telnet.

Remarks

The Telnet Task enables remote execution of commands over Telnet.

Telnet Send Adapter

The Telnet Send Adapter provides a light-weight remote command execution client for BizTalk Server. To begin Server must be specified. By default Authenticate is True and User and Password must also be set.

Specify the command to be executed in Command. Upon execution the task will connect to the Telnet server and execute the Command. The response will be provide through the CommandResponse property.

Additional scripting properties BeforeExecute and AfterExecute provide additional flexibility allowing any number of commands and operations to be performed.

Sender Property List

---

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

AfterExecute	A set of commands to be executed after Command execution.
Authenticate	Whether to authenticate when connecting.
BeforeExecute	A set of Telnet commands to be executed before Command execution.
Command	The command to be sent to the server.
CommandResponse	The response to the command.
CommandResponseFile	A file to hold the response to the command.
Firewall	A set of properties related to firewall access.
LogFile	The file to write logging information to at runtime.
LoginPrompt	The format of the prompt for the user's login.
LogMode	What information gets logged during component execution.
Other	Defines a set of configuration settings to be used by the component.
Password	The password to use for authentication.
PasswordPrompt	The format of the prompt for the user's password.
Port	The remote port for the Telnet service (default is 23).
RuntimeLicense	Specifies the component runtime license key.
Server	The address of the Server.
ShellPrompt	The shell prompt of the telnet session.
ShellPromptExpression	A regular expression to match the shell prompt returned by the server.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
User	The username to use for authentication.

Config Settings

---

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

EOL	The EOL used to parse the response.
Logoff	Whether or not to logoff from the server after execution.
ReturnPrompt	Whether to include the prompt in response data.
ReturnScriptResponse	Whether to include script output in response data.
TerminalType	The terminal type.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AfterExecute Property (Telnet Task)

A set of commands to be executed after Command execution.

Data Type

String

Default Value

""

Remarks

AfterExecute is a script that is executed immediately following the execution of Command.

Each line in the script is treated as a single command.

Valid additional scripting commands are listed below:

Commands that include spaces should be surrounded with quotes. For instance: exec "echo hello" Quotes within a command do not need to be escaped. For instance: exec "echo hello "world"" Will send: echo hello "world" Commands that include spaces should be surrounded with quotes. For instance: exec "echo hello" Quotes within a command do not need to be escaped. For instance: exec "echo hello "world"" Will send: echo hello "world"

The "\" character is the escape character. It is used with the special case of Cr and Lf characters. For instance: exec "pwd\r\n" Will send "pwd" followed by a CrLf sequence.

The "\" escape character is also used when specifying non-ASCII characters by passing Hex encoded values. For instance: exec "\7F" Will send the DEL control character.

Authenticate Property (Telnet Task)

Whether to authenticate when connecting.

Data Type

Boolean

Default Value

true

Remarks

This property determines whether to authenticate when connecting. If set to True, the task will authenticate using the User and Password values to authenticate. The LoginPrompt and PasswordPrompt should be set to the appropriate values for the server.

The basic sequence of events when set to True is as follows:

• Connect
• Wait for LoginPrompt
• Respond with User
• Wait for PasswordPrompt
• Respond with Password
• Wait for ShellPrompt
• Proceed with command execution

The basic sequence of events when set to False is as follows:

• Connect
• Wait for ShellPrompt
• Proceed with command execution

The default value is True.

BeforeExecute Property (Telnet Task)

A set of Telnet commands to be executed before Command execution.

Data Type

String

Default Value

""

Remarks

BeforeExecute is a script that is executed immediately before executing Command.

Each line in the script is treated as a single command.

Valid additional scripting commands are listed below:

Commands that include spaces should be surrounded with quotes. For instance: exec "echo hello" Quotes within a command do not need to be escaped. For instance: exec "echo hello "world"" Will send: echo hello "world" Commands that include spaces should be surrounded with quotes. For instance: exec "echo hello" Quotes within a command do not need to be escaped. For instance: exec "echo hello "world"" Will send: echo hello "world"

The "\" character is the escape character. It is used with the special case of Cr and Lf characters. For instance: exec "pwd\r\n" Will send "pwd" followed by a CrLf sequence.

The "\" escape character is also used when specifying non-ASCII characters by passing Hex encoded values. For instance: exec "\7F" Will send the DEL control character.

Command Property (Telnet Task)

The command to be sent to the server.

Data Type

String

Default Value

""

Remarks

This property specifies the command to be sent to the server. For instance: "ls" or "dir". The response to the command will be held in CommandResponse.

CommandResponse Property (Telnet Task)

The response to the command.

Data Type

String

Default Value

""

Remarks

This property holds the response to the Command once execution has completed.

CommandResponseFile Property (Telnet Task)

A file to hold the response to the command.

Data Type

String

Default Value

""

Remarks

This property specifies a file to which the response will be written. If specified, the response to the Command is written once execution has completed. If unspecified, the response is available via the CommandResponse property.

Firewall Property (Telnet Task)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the task will attempt to connect.

LogFile Property (Telnet Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LoginPrompt Property (Telnet Task)

The format of the prompt for the user's login.

Data Type

String

Default Value

"Login:"

Remarks

This property specifies the prompt for the user's login. The task will wait for this prompt before sending the User value. This is not case sensitive. This property is only applicable when Authenticate is set to True.

The default value is "Login:".

LogMode Property (Telnet Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:

Other Property (Telnet Task)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The task accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Password Property (Telnet Task)

The password to use for authentication.

Data Type

Password

Default Value

""

Remarks

This property specifies the password used during authentication.

PasswordPrompt Property (Telnet Task)

The format of the prompt for the user's password.

Data Type

Password

Default Value

"Password:"

Remarks

This property specifies the prompt for the user's password. The task will wait for this prompt before sending the Password value. This is not case sensitive. This property is only applicable when Authenticate is set to True.

The default value is "Login:".

Port Property (Telnet Task)

The remote port for the Telnet service (default is 23).

Data Type

Integer

Default Value

23

Remarks

This property specifies the remote port of the Telnet service to which the connection will be made.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

The default value is 23.

RuntimeLicense Property (Telnet Task)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

Server Property (Telnet Task)

The address of the Server.

Data Type

String

Default Value

""

Remarks

The Server property specifies the IP address (IP number in dotted internet format) or Domain Name of the Telnet server.

ShellPrompt Property (Telnet Task)

The shell prompt of the telnet session.

Data Type

String

Default Value

">"

Remarks

This property specifies the shell prompt to wait for when executing a command. After a command is sent to the server the task will search the response for the prompt defined in this property to signal that the command execution is complete. If the ShellPrompt is not found within Timeout seconds an error occurs.

This value is case sensitive.

The default value is ">".

ShellPromptExpression Property (Telnet Task)

A regular expression to match the shell prompt returned by the server.

Data Type

String

Default Value

""

Remarks

This property specifies a regular expression defining a pattern of shell prompt to wait for when executing a command. After a command is sent to the server the task will search the response for a prompt matching the expression defined in this property to signal that the command execution is complete.

This may be used in place of ShellPrompt and is helpful in situations where the exact prompt is not known but a general format is defined. If a matching prompt is not found within Timeout seconds an error occurs.

Note: The value specified in ShellPromptExpression must be a properly formatted .NET regular expression.

SSLAcceptServerCert Property (Telnet Task)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the task will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the task will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (Telnet Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (Telnet Task)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

SSLStartMode Property (Telnet Task)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

The default value is None.

Timeout Property (Telnet Task)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the task will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the task fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the task may be changed to absolute timeouts, i.e. the task will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

User Property (Telnet Task)

The username to use for authentication.

Data Type

String

Default Value

""

Remarks

This property specifies the username used during authentication.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Config Settings (Telnet Task)

The task accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

Telnet Config Settings

SSL Config Settings

General Config Settings