Previous Topic: Define an SCP JobNext Topic: Informatica Jobs

Working with Workload Objects › File Transfer Jobs › Define an SFTP Job

Define an SFTP Job

You can define an SFTP job to transfer binary files using the Secure File Transfer Protocol (SFTP). The SFTP protocol supports wildcard transfers, so you can upload multiple files to a remote computer or download multiple files to the agent computer.

Note: To run these jobs, your system requires CA WA Agent for UNIX, Linux, Windows, or i5/OS.

Follow these steps:

  1. Open the Application that you want to add the job to in the Define perspective.

    The Application appears in the workspace.

  2. Select the SFTP job from the File Transfer group in the Palette view, and drag the job to the workspace.

    The SFTP icon appears on the Application workspace view.

  3. Right-click the SFTP icon, and select Edit from the pop-up menu.

    The Basic page of the SFTP dialog opens.

  4. Complete the following required fields:
    Name

    Defines the name of the job that you want to schedule.

    Limits: 128 alphanumeric characters, plus the special characters commercial at (@), pound (#), dollar sign ($), underscore (_), square brackets ([]), brace brackets ({}), and percent sign (%) as a symbolic variable introducer character.

    Agent name

    Specifies the name of the agent where the secure transfer takes place.

    Note: The drop-down list displays all the agents that are defined in the Topology for the specified job type.

    Transfer direction

    Indicates the direction of transfer (Download or Upload).

    Default: Download

    Server address

    Specifies the DNS name or IP address of a remote server.

    Example: 172.24.36.107 (IPv4) or 0:0:0:0:0:FFFF:192.168.00.00 (IPv6)

    Remote directory

    Specifies the file's remote source directory (if downloading) or the file's remote destination directory (if uploading).

    Remote file name

    Specifies the file's source location (if downloading) or the file's destination (if uploading). This field is not required if you are uploading multiple files.

    Notes:

    • For uploads, you must specify the file name without wildcards.
    • For downloads, you can use wildcards for the file name. The asterisk (*) is a wildcard for zero or more characters and the question mark (?) is a wildcard for a single character.
    • If a wildcard is used in a remote file name for download, the local file name (the target) must refer to a directory. A wildcard transfer is equivalent to an mget transfer using an FTP client.
    • You cannot rename files if wildcards are used.
    Local file name

    Specifies the file's destination (if downloading) or the file's source location (if uploading).

    Notes:

    • For downloads, you must specify the full path and file name without wildcards.
    • For uploads, you can use wildcards for the file name. The asterisk (*) is a wildcard for zero or more characters and the question mark (?) is a wildcard for a single character.
    • If a wildcard is used in a local file name for upload, the Remote file name field is not required. A wildcard transfer is equivalent to an mget transfer using an FTP client.
    • You cannot rename files if wildcards are used.
    • You cannot use wildcards in the path.
    User

    Specifies the user ID of the user with the authority to download the file from the remote FTP server or upload the file to the remote FTP server. The user must be defined in the Topology. This field supports the use of a namespace for a user that has more than one password. Contact your administrator for the user name defined in the Topology.

    Examples: Bob, Production:Bob

    Note: The drop-down list displays all the user IDs that are defined in the Topology for the specified agent. You must have at least Read access to the ADMIN.Network Topology permission to view this list.

  5. (Optional) Specify the following additional information:
    Server port

    Specifies the port number of the remote server.

    Default: 22

    Local user

    Specifies a user ID on the UNIX or Linux computer where the agent is installed. This user ID determines the access permissions of a downloaded file on the agent computer and does not apply to uploads. When the file is downloaded, the file is created with this user as the file owner. To set the owner of a downloaded file, the agent must run as root.

    Notes:

    • The local user does not need to be defined in the Topology.
    • Your agent administrator can specify a default local user for all FTP, Secure Copy, and Secure FTP jobs by setting the ftp.download.owner parameter in the agent's agentparm.txt file.
    • The value in this field overrides the default setting specified in the ftp.download.owner parameter in the agent's agentparm.txt.
    The remote os type

    Specifies the remote operating system type in a secure file transfer (UNIX or Windows). The remote operating system type is used to determine the path separator on the remote system.

  6. Click OK.

    The Secure FTP job is defined.

Example: Upload a File Using the Secure File Transfer Protocol

Suppose that you want to upload the logs.tar file to the /u/tmp directory on the hpsupport server. The job uses the Secure File Transfer Protocol (SFTP).

Follow these steps:

  1. Enter the following information in the Basic page:
  2. Select the Upload option button in the Transfer direction section.
  3. Click OK.

Example: Upload Multiple Files Using the Secure File Transfer Protocol

This example uploads the files in the c:\temp\upload directory to the /u1/build/uploaded directory on the aixunix server. The job uses the Secure File Transfer Protocol (SFTP). Since the value in the Local file name field contains a wildcard, no value is specified in the Remote file name field.

Follow these steps:

  1. Enter the following information in the Basic page:
  2. Select the Upload option button in the Transfer direction section.
  3. Click OK.

More information:

Using a Namespace for a User that has Different Passwords