Configuring the Kerberized SSH adapter for a Java client - Documentation for TrueSight Orchestration Content 20.18.01

None

<targets>

Contains the <target> elements

Conditional; required if a target is referenced or defined in the request

Target

<target>

Specifies the host name or the IP address of the remote host

Yes

Port

<port>

Specifies the port on which the remote host listens

Default value: 22

No

User Name

<user-name>

Specifies the name of the user registered as the Kerberos user principal

Conditional

Password

<password>

Specifies the password that corresponds to the <user-name> specified

The <password> element can contain an encryption-type attribute.

Conditional

Encryption Type

<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the <password> element, not an element itself

Valid values: Base64, Plain (default)

No

Krb Realm

<krb-realm>

Specifies the name of the Kerberos realm

Conditional

Kdc Name

<kdc-name>

Specifies the name of the host acting as the Key Distribution Center (KDC)

Conditional

If the host name provided is not a Fully Qualified Domain Name (FQDN), this shortened host name, and not the FQDN, must exist in the Kerberos database.

Use Subject Credentials

<use-subject-credentials>

Uses credentials available inside the Java Authentication and Authorization Service (JAAS) authenticated Subject instance

Valid values: true (default), false

With a value of false, Kinit (used to obtain and cache Kerberos ticket-granting ticket) is used to acquire initial credentials. This value is typically set to true in production environments.

No

Krb Login Config File

<krb5-login-config-file>

Specifies the path and file name of the login properties file
Default value: blank

No

Krb5 Debug

<krb5-debug>

Enables debug level logging for Kerberos related supporting logic in SUN Java language for this feature

Valid values: true, false (default)

No

Prompt

<prompt>

Specifies the console prompt displayed when the system is waiting for a command

The <prompt> If not provided, each command executes in a separate session, as if each command is executing in a new command shell. This prompt indicates the completion of the command execution. It must be unique, not matching potential command output to prevent parsing issues.

Conditional; required when using the proxy command feature

None

<verify-os>

Determines whether the adapter must determine the target OS type soon after authentication is complete or a connection is established

Valid values: true (default), false

If the value of the <verify-os> element is true, the type of OS is verified and the exit codes are returned by the executed commands. Else, the type of OS is not verified and none of the commands executed return an exit code.

No

Timeout Secs

<timeout-secs>

Specifies the time, in seconds, to wait for the expected prompt to be returned

If the expected prompt is not returned within the specified time, an error message returns.

Default value: 60 seconds

No

Establish Connection Timeout Secs

<establish-connection-timeout-secs>

Specifies the time, in seconds, to wait for user authentication on the target server

If authentication is not successful within this time, an error message is returned.

Default value: 60 seconds

No

Network Environment

<network-environment>

Creates an extra session for use in Sun Solaris 9 environments

Valid values: true, false (default)

This value must be set to false when establishing a connection to a network appliance.

No

Line Termination

<line-termination>

Specifies the line termination character that is used when invoking the SSH command

Typically, the value is a hexadecimal value
for \r (&#D;) or \n (&#A;).

Default value: No line termination character is assigned

No