File transfer table

The file transfer table (filetransferTable) defines the configuration and control settings necessary in transferring files to an agent.

Table 1 describes the objects provided in the filetransferTable.

Table 1. File transfer table (filetransferTable) 

Row object

Description

Base

Selects a base directory that, in combination with the ftFilePathAndName object, defines the directory on the agent's host where the transferred file will be stored:

cfg(1) - Selects the agent's config directory

bin(2) - Selects the agent's bin directory

data(3) - Selects the directory defined by the FileTransferDataDir variable in the init.cfg file

When you set this object, the subagent checks whether the file specified by the combination of the ftFileBase and ftFilePathAndName objects already exists. If the file exists, the subagent reports its CRC and size.

Control

Controls the activation of the file transfer operation:

none(1) - No action is taken

get(2) - Starts the file transfer process using the information defined in the other objects of this row

delete(3) - Deletes the file specified by the combination of the ftFileBase and ftFilePathAndName objects from the host machine

The default value of this object is none(1). The ftFileBase, ftFilePathAndName, ftFileMode, ftFileServerAddr, ftFileRemotePort and RemotePath objects must be set before you select the value get(2).

CRC

Displays the CRC of the file referenced by the ftFileBase and ftFilePathAndName objects. The agent updates this value when a file transfer has completed successfully, or when the ftFileBase or ftFilePathAndName objects are set to point to an existing file.

Mode

Sets the file transfer mode:

http(1) - Selects HTTP transfer protocol without SSL, provided that the selected HTTP service supports HTTP without SSL.

https(2) - Specifies transfer using HTTP over SSL, provided that the HTTP service supports HTTP over SSL.

The default value of this object is https(2).

Owner

Indicates the owner/creator of the filetransferTable row.

PathAndName

Defines the path and filename that, in combination with the Base object, defines the full path and filename under which the file will be stored on the agent's host. The maximum length of this object is 127 characters.

When you set this object, the agent checks whether the file specified by the combination of the ftFileBase and ftFilePathAndName objects already exists. If the file exists, the agent reports its CRC and size.

RemotePass

Defines the password supplied for authentication on the remote server during file transfer. Only Basic Authentication is supported. The maximum length of this object is 127 characters.

RemotePath

Specifies the path of the file to be transferred. The maximum length of this object is 127 characters.

RemotePort

Defines the remote port to connect to for file transfer. The valid range of this object is 0 to 65535 and its default value is 80.

RemoteUser

Defines the username supplied for authentication on the remote server during file transfer. Only Basic Authentication is supported. The maximum length of this object is 127 characters.

RespTime

Indicates the date and time when the file transfer was completed.

ServerAddr

Sets the IP address or server name of the HTTP server from which the file will be transferred. Before you start the file transfer by setting the ftFileControl object to get(2), this object must contain either a valid IP address or domain name of the server.

Size

Indicates the size of the file referenced by the ftFileBase and ftFilePathAndName objects. The agent updates this value when a file transfer has completed successfully, or when the ftFileBase or ftFilePathAndName objects are set to point to an existing file.

Status

Indicates the status of the current file transfer process:

idle(1) - No activity related to the file transfer.

transferring(2)- The file is currently being transferred to the agent's host.

transferred(3) - The file has been successfully stored on the agent's host.

failed(4)- The file transfer request was unsuccessful.

The default value of this object is idle(1).