SSH Process Node

An SSH node is a Production process node that transfers files to or from an SSH (Secure Shell) server for use in Production scripts.

The SSH node has three panes where you set attributes.

Production SSH Node All Panes

Node Attributes

You set attributes for the SSH node in the node attributes pane.

Production SSH Node Attributes

Attribute	Description
Name	Specify a descriptive name for the node. Lower case names maximize usage of the available space.
Server (Required)	Specify the appropriate host name or IP address for the SSH server.
Port	Specify the port number. If left blank, the default SSH port is used.
User (Required)	Specify the user name for the SSH connection.
Password (Required if no PasswordFile or Identity file attribute is set)	Specify the password for the SSH connection. This attribute and the PasswordFile and Identify file attributes are mutually exclusive. As of Workbench 7.2(12) the Password attribute may be used with the Identity file attribute as a passphrase for the identity file when the identity file has a passphrase. TIP: The SSH Process node is limited to password authentication. If you use Public/Private encryption keys for security, you could use a tool such as psftp.exe from an Execute node.
PasswordFile (Required if no Password or Identity file attribute is set)	Specify a text file that contains the password that is required to log on to the SSH connection. To select the file, use the browse button (...) that appears when you click in the empty PasswordFile box. This attribute and the Password and Identify file attributes are mutually exclusive. As of Workbench 7.2(12) the PasswordFile attribute may be used with the Identity file attribute as a passphrase for the identity file when the identity file has a passphrase.
Identity file (Required if no Password or PasswordFile attribute is set)	Specify the file that contains the SSH key to log on to the server. To select the file, use the browse button (...) that appears when you click in the empty Identify file box. This attribute and the Password and PasswordFile attributes are mutually exclusive. As of Workbench 7.2(12) either the Password or PasswordFile attribute may be used with the Identity file attribute as a passphrase for the identity file when the identity file has a passphrase. NOTE: DI only supports identity files using the PEM format. You can convert existing identity files to the PEM format by running the following command: `ssh-keygen -p -f file -m pem -P passphrase -N passphrase`
Protocol	Specify the network protocol to use for transferring files. Choices are: SCP (Secure Channel Protocol) or Sftp (Secure File Transfer Protocol). The default is Sftp.
Local Directory	Specify the local directory that files are pushed to or pulled from. If blank, the Default Working Directory attribute for this branch is used. To select the file, use the browse button (...) that appears when you click in the empty Local Directory box. Parameters and wildcard characters are supported.
Remote Directory (Required)	Specify the remote directory that files are pushed to or pulled from. To select the file, use the browse button (...) that appears when you click in the empty Remote Directory box. Parameters and wildcard characters are supported.
TransferType	Select the appropriate transfer type: Pull, Push, List, or Delete. The default is Pull. The List type requires a Directory List File attribute that lists the files in the remote directory, including: path, size, type (file/folder), date and time modified, permissions, and owner.
When no files are matched	Specify how to handle if no files match: Warn, Fail, or Succeed. The default is Warn.
Directory List File	Specify a file in which to write the file names and properties of the matched files on the remote server. This file is used most often in conjunction with the List Transfer Type to set where to place the file listings. When used with other Transfer Types, the Directory List File is a log for file transfers.
Input List File (Required if no Files attribute is set)	Specify a text file that contains a list of files. List the name of each file on a separate line. To select the file, use the browse button (...) that appears when you click in the empty Input List File box. This attribute and the Files attribute are mutually exclusive.
Email Object for failure	Select a predefined mailing list to send an email to if the node fails. The pull-down list is populated with items that can be found in Project Settings > Mailing Lists > Email Templates. See Mailing Lists Tab for information about setting up Mailing Lists and Email Objects.
Email Object for success	Select a predefined mailing list to send an email to if the node succeeds. The pull-down list is populated with items that can be found in Project Settings > Mailing Lists > Email Templates. See Mailing Lists Tab for information about setting up Mailing Lists and Email Objects.
Email Object for warning	Select a predefined mailing list to send an email to if the node generates a warning. The pull-down list is populated with items that can be found in Project Settings > Mailing Lists > Email Templates. See Mailing Lists Tab for information about setting up Mailing Lists and Email Objects.
Failure node	Select the next node upon failure. The pull-down list contains all nodes that are on the Task Flow.
Success node	Select the next node upon successful completion. The next node automatically populates if a connecting line is set on the Task Flow. The pull-down list contains all nodes that are on the Task Flow.
Working Directory	Specifies the directory in which this node runs. If left blank, the Default Working Directory attribute that is set in the Start Control Node is used. When running a script, Production sets the working directory for the child process to the directory that contains the script, unless the node specifies a different directory. See Start Control Node.
Default Working Directory	Displays the Default Working Directory that is set the the Start Control Node. If a Default Working Directory is not specified, this attribute is blank. Applies to all nodes. See Start Control Node.
External File Encoding	Select the format for the node input files. If this attribute is blank, Workbench attempts to detect the type of encoding. This attribute is also used when saving log files. The encoding might need to be adjusted when using data with high bit Latin-1 characters or Unicode characters.