Previous Topic: CatalystNext Topic: Databases


Command Execution

The Command Execution operator category configuration sets default property values for Command Execution operators.

Note: See the Content Designer Reference for operator-level information.

Default Telnet Properties

Sets default values for the Telnet properties.

Pseudo Terminal Type

Defines the default pseudo terminal type for a Telnet connection.

Values: This property can have one of the following values:

  • VT100 - Used for hosts with a Linux operating system.
  • VT400 - Used for hosts with a Windows operating system.

Default: VT100

Port

Defines the default port with which to connect to the remote host.

Note: Port 23 is the system TCP/UDP port for Telnet.

Default: 23

Connection Timeout (sec)

Defines the interval (in seconds) that the connection waits to time out.

Values: You can set this value to any positive integer.

Login Scheme

Specifies the default login scheme.

Values: This property can have one of the following values:

  • User name and password
  • Password only
  • Log in without user name and password
User Login Text Prompt

Defines the default value for the text prompt that accepts a user name.

User name

Defines the user name with which to log in to the remote host.

Password Text Prompt

Defines the default value for the text prompt that indicates that the remote host requires a password for the specified user name.

Password

Defines the default password the product associates with the specified user name.

User Command Prompt

Defines the command prompt that indicates that the remote host is ready for commands.

The following command prompts are typical:

  • >
  • ?
  • #

The following entry matches any input (including new lines) followed by a $ (dollar sign), > (greater than), ? (question mark), : (colon), or # (hash).

.*[$>?:#]

Note: Enclose $ in square brackets (that is, [$]) within a regular expression. A dollar sign without brackets has a specific meaning in regular expressions.

Time to Wait for Prompts (sec)

Defines the interval (in seconds) that the product waits for a command prompt before timing out.

Run Commands as Another User?

Specifies whether to run the script or the specified commands as a different user.

Values: This property can have one of the following values:

  • Selected - Switch the user after login.
  • Cleared - Do not switch the user after login.

Default: Cleared

Switch User Command

Defines the operating system-specific command that switches the user on the remote host. The command "su -root" switches users to the root user.

Examples:
su - username
sudo su - username
Switch User Password Text Prompt

(Optional) If the remote host requires a password to switch users, this property defines a regular expression for the default text prompt.

The text prompt is typically "Password: " or "password: ". Replace "P" or "p" with ".*" in the regular expression to match any input (including new lines) and the uppercase or lowercase "p" in “password: “.

Switch User Password

(Optional) If the remote host requires a password to switch users, this property defines the default password to enter at the password text prompt.

Switch User Command Prompt

Defines the command prompt that indicates that the remote host is ready for commands from the switched user.

The following command prompts are typical:

  • $
  • >
  • #

The following entry matches any input (including new lines) followed by a $ (dollar sign), > (greater than), ? (question mark), : (colon), or # (hash).

.*[$>?:#]

Note: Enclose $ square brackets (that is, [$]) when you use a regular expression. A dollar sign without brackets has a specific meaning in regular expressions.

Default SSH Properties

Sets default values for Secure Shell (SSH) properties.

Pseudo Terminal Type

Defines the default pseudo terminal type for requests for an SSH connection.

Values: This property can have one of the following values:

  • VT100 - Used for hosts with a Linux operating system.
  • VT400 - Used for hosts with a Windows operating system.

Default: VT100

Port

Defines the default port with which to connect to the remote host.

Note: Port 22 is the system port for the SSH protocol.

Default: 22

User name

Defines the user name with which to log in to the remote host.

Use Default Private Key for Login?

Specifies whether to log in with a private key. The alternative is to use the password information.

Values: This property can have one of the following values:

  • Selected - Use the Private Key Inline Content or the Default Private Key Path value to log in.
  • Cleared - Use a password to log in.

Default: Cleared

Password

Defines the default password the product associates with the specified user name.

Private Key Inline Content

Defines the content of a default private key with which to log in to the remote host.

Default Private Key Path

Defines the path to a default private key with which to log in to the remote host.

Passphrase for Key

Defines the passphrase with which to unlock the content of the default private key.

Note: The passphrase is required only if the default private key was created with a passphrase.

Run Commands as Another User?

Specifies whether to run the script or the specified commands as a different user.

Values: This property can have one of the following values:

  • Selected - Switch the user after login.
  • Cleared - Do not switch the user after login.

Default: Cleared

Switch User Command

Defines the operating system-specific command that switches the user on the remote host. The command "su -root" switches to the root user.

Examples:

su - username
sudo su - username
Switch User Password Text Prompt

(Optional) If the remote host requires a password to switch users, this property defines a regular expression for the default text prompt.

The text prompt is typically "Password: " or "password: ". Replace "P" or "p" with ".*" in the regular expression to match any input (including new lines) and the uppercase or lowercase "p" in “password: “.

Switch User Password

(Optional) If the remote host requires a password to switch users, this property defines the default password to enter at the password text prompt.

Switch User Command Prompt

Defines the command prompt that indicates that the remote host is ready for commands from the switched user.

The following command prompts are typical:

  • #
  • >
  • $

The following entry matches any input (including new lines) followed by a $ (dollar sign), > (greater than), ? (question mark), : (colon), or # (hash).

.*[$>?:#]

Note: Enclose $ in square brackets (that is, [$]) when you use a regular expression. A dollar sign without brackets has a specific meaning in regular expressions.

Default Windows Command Execution Properties

Sets default values for the Windows command execution properties.

Shell

Defines the command interpreter for the profile and for shell commands.

Example: cmd.exe

Profile

Defines a shell script that the command execution operator interprets before it starts a user process for which no profile is specified. The command execution operator uses the command interpreter that the Shell program specifies to interpret the profile. The profile can contain any noninteractive command that the shell interpreter understands.

Require user credentials

Specifies the default command execution operator behavior when user credentials are required but not specified.

Values: This property can have one of the following values:

  • Defaults To User Under Which Touchpoint is Run - The process operators use the user credentials under which the agent or Orchestrator process is running.
  • Defaults To User Specified Below - Command execution operators use the user credentials that are configured in the User and Password fields.
  • No Default - Command execution operators use the credentials that are supplied at run time for the account under which to run.

Default: Defaults To User Under Which Touchpoint is Run

User

Defines the shell account that starts any user process that lacks a user name and a password.

  • Enter a user ID with only necessary permissions so users cannot define and start processes to which they otherwise have no access.
  • Leave the user ID and password blank to force users to provide credentials when they start processes through the product.
Password

Defines the password the product associates with the specified user.

Note: Passwords in the Command Execution configurations are protected and cannot be modified through a program, passed to external methods, or referenced.

Confirm Password

Verifies the value that you specified in the Password property.

Load OS User Profile

Specifies whether to load the user profile that the product associates with the specified User and Password values.

Values: This property can have one of the following values:

  • Selected - Load the user profile.
  • Cleared - Do not load the user profile.

Default: Cleared

Default UNIX Command Execution Properties

Sets default values for the UNIX command execution properties.

Shell

Defines the command interpreter for the profile and for shell commands.

Examples:
  • /bin/bash
  • /bin/csh
  • /bin/ksh
Profile

Defines a shell script that the command execution operator interprets before it starts a user process for which no profile is specified. The command execution operator uses the command interpreter that the Shell program specifies to interpret the profile. The profile can contain any noninteractive command that the shell interpreter understands.

Require user credentials

Specifies the default command execution operator behavior when user credentials are required but not specified.

Values: This property can have one of the following values:

  • Defaults To User Under Which Touchpoint is Run - The process operators use the user credentials under which the agent or Orchestrator process is running.
  • Defaults To User Specified Below - Command execution operators use the user credentials that are configured in the User and Password fields.
  • No Default - Command execution operators use the credentials that are supplied at run time for the account under which to run.

Default: Defaults To User Under Which Touchpoint is Run

User

Defines the shell account that starts any user process that lacks a user name and a password.

  • Enter a user ID with only necessary permissions so users cannot define and start processes to which they otherwise have no access.
  • Leave the user ID and password blank to force users to provide credentials when they start processes through the product.
Password

Defines the password the product associates with the specified shell user.

Note: Passwords in the Command Execution configurations are protected and cannot be modified through a program, passed to external methods, or referenced.

Confirm Password

Verifies the value that you specified in the Password property.

Load OS User Profile

Specifies whether to load the user profile that the product associates with the specified User and Password values.

Values: This property can have one of the following values:

  • Selected - Load the user profile.
  • Cleared - Do not load the user profile.

Default: Cleared

Disable Password Check

Specifies whether to disable the password verification.

Values: This property can have one of the following values:

  • Selected - The product does not verify the specified password. In this case, user credentials are not required.
  • Cleared - The product verifies the specified password.

Default: Cleared