Transfer CFT command reference and syntax

This topic provides a useful list of Transfer CFT commands, syntax, and parameters. For a more detailed description of the Transfer CFT commands, refer to the link displayed below each command syntax.

The Transfer CFT commands are presented in alphabetical order in this summary. Each command is presented with possible parameters and default values.

See also, Syntax conventions and symbolic variables.

ABOUT: Displays product/host information

ABOUT details

ACT: Reactivates a partner

ACT details

CFTACCNT: Defines transfer accounting records

CFTACCNT details

Transfer accounting records

CFTAPPL: Defines a transfer owner

CFTAPPL details

Assign a transfer owner

CFTAUTH: Defines an authorized template list

 

CFTCAT: Defines Catalog attributes

CFTCAT details

Catalog attributes

CFTCOM: Defines parameters related to the communication between applications and Transfer CFT

  CFTCOM

Communication media

CFTCRON : Define Transfer CFT cron jobs

Define script execution

CFTDEST: Definition of a list of partners 

CFTDEST details

Broadcast list

CFTEXIT: Activate an exit task 

  CFTEXIT details

Exit tasks

CFTEXT: Extract data from the parameter and partner files 

Export configuration

CFTFILE: Create or delete Transfer CFT files

Manually create internal datafile files

CFTIDF ID = identifier: Correspondence between the network identifier and the local identifier of a transferred model file 

  CFTIDF details

File template/virtual file association

CFTLOG FNAME = filename: Log file management parameters 

CFTLOG details

Transfer Log file

CFTNET: Local network resources

  CFTNET details

Network resources

About proxies and SOCKS

CFTPARM: General Transfer CFT environment parameters

CFTPARM details

Transfer CFT general parameters

CFTPART ID = identifier: Partner definition parameters  

CFTPART details

Partner attribute concepts

CFTPROT: Transfer protocol

CFTPROT details

File Transfer Protocol

CFTRECV ID= identifier: Description of model file receiving parameters

  CFTRECV details

CFTSEND ID= identifier: Description of model file sending parameters

CFTSEND details

Send file template

CFTSSL ID = identifier: Security files

CFTSSL details

SSL/TLSsecurity concepts

CFTTCP: Network parameters of a TCP/IP partner

TCP attributes for a partner

CFTXLATE FNAME = filename: Define conversion tables

Conversion tables

CLEARCMD COMMAND = string: Delete a transfer request

CLEARCMD details

CONFIG: Designate the communication medium and the files accessed by CFTUTIL

Setting default CFTUTIL file names

COPYFILE IFNAME = filename: Copy files with an off-line compression or decompression option

Copying files off-line

DELETE PART = { identifier | mask }: Delete a catalog entry

Deleting catalog entries

DISPLAY [ CONTENT = { listcat | identifier }]: Display a model-formatted catalog

Catalog output display model

END PART = { identifier | mask }: Change transfer to X state

END details

HALT PART = { identifier | mask }: Suspend a transfer

Halting a transfer

HELP

INACT ID = identifier: Inactivate a partner

INACT details

KEEP PART = { identifier | mask }: Abort a transfer

  Suspend transfers

KSTATE IDF = identifier: Change a transfer state

KSTATE details

LISTCAT TYPE = { ALL | FILE | MESSAGE | REPLY }: List catalog entries

  LISTCAT details

LISTCOM: Display contents of a communication media

  LISTCOM details  

LISTLOG: Display and filter log content including merged nodes in cluster mode

LISTNODE: Display all nodes

Multi-node commands

LISTPARM: Display Transfer CFT partner details

LISTPARM details

LISTPART: Display partners

LISTPART details

MQUERY : Determine the time for the next action

  MQUERY details

PURGE: Delete records from the catalog 

PURGE details

RECONFIG: Reload

  Manage configuration updates

RECV IDF = { identifier | mask }: Request to receive transfer

Receiving files

RESUME: Retrieves, in server mode, a blocked send request

RESUME details

SEND: Request to send transfer

Sending files

SHUT: Shut down Transfer CFT 

Manage the Transfer CFT Local Administrator server: stop the server

START: Restart transfer

Restart transfers

SUBMIT: Submit end-of-transfer procedure

SUBMIT details

SWAITCAT: Wait for a transfer state update

SWAITCAT concepts 

SWAITCAT examples

SWITCH: Manually switch LOG or ACCNT files 

SWITCH details

Toggle log or accounting file

TURN: Passes monitor control protocol session

TURN details

DMZ and the TURN command concepts

UCONFSET: configuration utility

UCONF details

UCONFGET

UCONF details

LISTUCONF

UCONF details

WAIT: Suspend CFTUTIL execution for the time indicated 

Suspending CFTUTIL execution

WLOG: Request to write a message in the LOG file

WLOG details

Syntax conventions

The command syntax presented in this summary respects the following general conventions.

  1. Mandatory parameters are placed before optional parameters.
  2. The default value of a parameter is placed before the other possible values in the list for this parameter.

Typographic conventions

  • [   ] Optional parameters or values are displayed between square brackets
  • {   } Parameter choices or values are displayed  between braces
  • | The vertical bar separates an enumerated list of parameter values
  • ___ Default values for a parameter are underlined
  • , A comma separates a list of parameter values

For more information, see TYPOGRAPHICAL CONVENTIONS.

Symbolic variables

The following symbolic variable syntaxes are valid in a Transfer CFT environment:

  • &VAR
  • &+VAR
  • &nVAR:
  • &p.VAR
  • &p.nVAR
  • &(-string_prefix) (+string_suffix) (=string_alternate)p.nVAR

For information on using symbolic variables in Transfer CFT, refer to the topic Symbolic variables .

Filename usage

This name is a complete physical filename. It can be either:

  • Created dynamically from symbolic variables, or
  • Correspond to the name of a version file

Using the FNAME parameter

Filename conventions are as follows:

  • filename

Transfers a file for which the name is specified by a filename.

  • mask

The term mask means that the filename includes at least one wild card character (* or :). This sends a file that lists all files that match the mask.

  • dirname

Sends a file that lists the contents of the directory.

  • #filename

For each file name that is listed in the file, this sends the corresponding file.

  • #mask

For each file name that matches the mask, this sends the corresponding file.

  • #dirname

For each file that exists in the directory, this sends the corresponding file.

Note: Use the @ symbol in a UNIX environment in place of the # symbol.

For more information on filename conventions, refer to Filename conventions.

Using UCONF

In order to merge functioning for all platforms, Transfer CFT features a configuration interface that provides product uniformity regardless of platform differences.

The basic CFTUTIL services provided are:

  • UCONFSET id=****,value=****
  • UCONFGET id=****
  • LISTUCONF id=****

This configuration replaces all prior configuring methods, such as manually editing cft.ini, ENV_CFT, *.ini, trkapi.conf, and so on, which have been replaced by a global profile file.

Additionally, UCONF can create all OS specific files that enable Transfer CFT User Interface operations.

Accepted types include:

  • int lower/higher        
  • bool true/false           
  • enum (id1 id2 id3 id4)  
  • identifier      
  • string                        
  • path (with abstract use of / \) escaped by \ :::: “/dsqfhdj”
  • fname

The ‘$’ sign is a reserved character that is used to reference an environmental variable. You have abstract use of environment variables using the $ sign.

For example: $(CFT_INSTALL) -à getenv(“CFT_INSTALL”)

Variables containing a period “.” refer to sections in the configuration file. Do not modify this file.

For example: cft.working_dir = $(cft.runtime_dir)

The UCONF table lists the new UCONF identifiers, the default values, and the former file values.

Related Links