About Transfer CFT utilities

This section describes Transfer CFT Unix utilities that you find in the cft/<installdir>/bin/ sub-directory after completing installation.

Note In this section, the term Transfer CFT designates the Transfer CFT software package on UNIX platforms.

The Transfer CFT utilities described here, do not replace the basic commands described elsewhere in this document. Their purpose is to simplify common tasks performed with Transfer CFT.

These are divided into the following utility types, as indicated in the table: Management, Control, and System.

Utility overview

The following utilities are listed according to the type of functionality. Click the utility name to access the syntax and details.

Utility  

Type

Definition  

cftinit  

Management

General Transfer CFT initialization utility.  

cft start  

Management

Controlled start of Transfer CFT.  

cft stop  

Management

Controlled shut down of Transfer CFT.  

cftutil  

Management

Simplified display of the standard CFTUTIL commands.  

cftupdate  

Management

Utility updating the Transfer CFT configuration.  

secinit  

Management Utility initializing the Transfer CFT security environment.

secupdate  

Management Utility updating the Transfer CFT security environment.

cftcata  

Control

Verbose display of the Transfer CFT catalog file.  

cftcatab  

Control

Brief display of the Transfer CFT catalog file.  

cftcatal  

Control

Utility migrating and/or extending the Transfer CFT catalog file.  

cftdelcat  

Control

Utility deleting an entry from the catalog.  

cftlog  

Control

Direct display of the Transfer CFT log file.  

cftparm  

Control

Direct display of the configuration parameters component.  

cftpart  

Control

Direct display of the configuration partners component.  

xfbadmgrp  

Control

Group management utility (all users accessing the Copilot server).  

xfbadmusr  

Control

Utility managing users accessing the Copilot server.  

cft2unix  

System

Utility setting Transfer CFT environment variables.  

cftping  

System

Transfer CFT state assessment utility.  

cftkey  

System

System data display.  

cftversion  

System

Utility retrieving the Transfer CFT release.  

xvi  

System

Utility processing the conversion tables.  

atoe  

-

ISO 8859-1 ASCII to EBCDIC conversion table.  

etoa  

-

EBCDIC to ISO 8859-1 ASCII conversion table.  

Management utilities

For additional multi-node actions, please refer to Commands and management

cftinit

cftinit is a general Transfer CFT initialization utility.

Syntax

cftinit [<filename> [<filename>...]]

Standard use

cftinit is normally used with a single parameter, which is the name of the Transfer CFT configuration file.

cftinit my_config.cft

Advanced use

Several file names can be included in the command line. Normally, all Transfer CFT parameters are declared in a single file. However, for organizational reasons, you may wish to separate the configuration into several files (for example, a file describing the CFTPART cards and another file containing the CFTPARM, CFTLOG cards, and so on).

cftinit partners.cft the_rest.cft

Note  
  • If no file name is passed as a parameter, the program requests one or more file names.
  • If no name is supplied, the program stops.
  • When you run cftinit, it creates the catalog and communication files. You can modify the default sizes of these files to suit your requirements by updating the uconf values for cft.cftcat.default_size and cft.cftcom.default_size (these values are expressed as a number of records).

cft start

The cft start utility performs a controlled start of Transfer CFT and its additional elements.

Syntax

cft start [ -batch]

Standard use

cft start is normally used without parameters. It checks the Transfer CFT environment to ensure that Transfer CFT starts correctly. It then runs Transfer CFT, waits for the processes to start, and displays an information message with the process identifier (PID) of the CFTMAIN process.

$ cft start

Starting Transfer CFT...

Starting Transfer CFT with IDPARM "IDPARM0" and 256 transfers active

Transfer CFT Working Directory : /cft/runtime

[=================================]100% RUNNING

Transfer CFT started correctly.

CFTMAIN process id is 12345.

Note  
  • cft start triggers a timeout each time a process required by Transfer CFT is activated. Normally, this timeout is sufficiently long, but if the system has an excessive load or is an old system that is slow, cft start may generate a spurious error. To remedy this, you can increase the uconf:cft.unix.start_timeout value.
  • When the system is delivered, cft start does not automatically activate the additional Transfer CFT elements such as SCOPE or Copilot by default.

Batch mode

Only use the cft start command with the -batch option when starting up Transfer CFT automatically at system start. The -batch option modifies the way in which the command is displayed.

The logger() system command is used to store any error messages displayed during automatic start. Therefore, for this device to operate correctly, the syslogd() system daemon must be running on your system. The system administrator can identify in the system log files the specific Transfer CFT messages, which are:

  • Error level and local0 facility for error messages.
  • Information level and local0 facility for a correct start.

cft stop

The cft stop utility performs a controlled shutdown of Transfer CFT.

Syntax

cft stop [-kill]

Standard use

The cft stop command, used without parameters, shuts down Transfer CFT by sending the SHUT FAST=YES command. It then waits until the various Transfer CFT processes are stopped.

$ cft stop

Stopping Transfer CFT...

[=================================]100% STOPPED

Transfer CFT stopped correctly.

If cft stop detects abnormal behavior during the shutdown phase, it displays the following message:

$ cft stop
Invalid state of Transfer CFT.

Use cft force-stop to force Transfer CFT to shut down.

Advanced use

In the event of a problem, the program recommends that you shut down Transfer CFT using thecft force-stopcommand.

This command forces a Transfer CFT shutdown. It is normally successful, but depending on the state of the system, more serious malfunctions may be encountered.

If a serious malfunction occurs at Transfer CFT level, an alarm message is displayed before continuing with the housekeeping procedure, to inform you about the possible consequences of the next command.

Note In the event of a serious malfunction, this command removes the message queues, shared memory segments and semaphore vectors assigned to the Transfer CFT user. This could be fatal to any other applications started up by the user and calling on the same types of resources.

% cft stop
Invalid state of CFT.
Use Cft force-stop to force shutdown of Transfer CFT
% cft stop -kill

 

***************
*** WARNING ***
***************

Using this action can seriously damage the IPC status of other applications running on the same login (as X server).

If you are not sure, use the ^C command and contact your technical support.

If you want to continue, enter the word 'yes' : yes

### Process destruction ###
Killing process 'CFTLOG', pid 18210
Killing process 'CFTTCPS', pid 38966
Killing process 'CFTTPRO', pid 38438
Killing process 'CFTTCOM', pid 36388
Killing process 'CFTTFIL', pid 36268

### IPC destruction ###
Removing msg queue 61455
Removing msg queue 57360
Removing msg queue 98321
Removing msg queue 90130
Removing msg queue 233491
Removing shared memory 69638
Removing shared memory 36871
Removing semaphore 49167
Removing semaphore 49168
CFT stopped.
%

Note  
  • cft stop triggers a timeout each time a process required by Transfer CFT is shut down.
    Normally, this timeout is sufficiently long, but if transfers are in progress or the system has an excessive load or is an old system that is slow, cft stop may generate a spurious error. If this happens, increase the uconf:cft.unix.stop_timeout value to a suitable value (in seconds) to correspond to the DISCTD and DISCTS fields in the configuration (CFTPROT).
  • When the system is delivered, cft stop does not automatically shut down the additional Transfer CFT elements such as SCOPE or Copilot by default.

cftupdate

The cftupdate utility is used to update the configuration.

Syntax

cftupdate <filename> [<filename> ...]

Note  
  • You can only update the CFTPART, CFTxxx (for the networks), CFTSEND cards, and so on
  • This command should be considered to be an alias of CFTUTIL @<filename> for each file name passed as a parameter in the command line

cftutil

The cftutil command submits a standard CFTUTIL instruction, but displays the results without a banner. In addition, if the command return code is non-null, a message is displayed.

Syntax

cftutil <command>

Use

% cftutil listcat type=z
CFTU26E LISTCAT _ Error (TYPE Bad value for parameter)
cftutil code 115
%

secinit

The secinit utility is used to initialize the Transfer CFT security environment.

Syntax

secinit [<filename> [<filename>...]]

Standard use

secinit is normally used with a single parameter, which is the name of the file containing the Transfer CFT security configuration.

secinit my_config.cft

Advanced use

Several file names can be included in the command line. Normally, all Transfer CFT security parameters are declared in a single file. However, for organizational reasons, you may wish to separate the parameters into several files.

secinit start_my_config.cft the_rest.cft

Note  
  • If no file name is passed as a parameter, the program will request one or more file names
  • If no name is supplied, the program stops
  • When activated, secinit creates the security database

secupdate

The secupdate utility is used to update the Transfer CFT security environment.

Syntax

secupdate <filename> [<filename> ...]

This command should be considered to be an alias of SECUTIL @<filename> for each file name passed as a parameter in the command line.

Control utilities

cftcata

cftcata is a shortcut for the CFTUTIL LISTCAT command with the TYPE=ALL, CONTENT=DEBUG options.

Syntax

cftcata [IDT]

Standard use

This command is used without parameters. cftcata displays the entire Transfer CFT catalog page by page but without a banner (debug mode).

Advanced use

This command is used with a transfer identifier (IDT) as a parameter. cftcata displays the entire contents of the Transfer CFT catalog page by page and without a banner (debug mode) for the relevant identifier.

cftcatab

cftcatab is an improved shortcut for the CFTUTIL LISTCAT command with the TYPE=ALL, CONTENT=BRIEF options

Syntax

cftcatab [STATE]

Standard use

When used without parameters, cftcatab displays a condensed version of the Transfer CFT catalog page by page but without a banner (brief mode).

Advanced use

When used with a transfer state (STATE) as a parameter. cftcatab displays a simplified version of the Transfer CFT catalog page by page and without a banner (brief mode) for the selected transfer state.

cftcatal

You can use the cftcatal utility to increase the size of the Transfer CFT catalog file without losing information. In a multi-node environment, this action resizes all nodes.

Syntax

cftcatal

cftlog

cftlog is a shortcut to display the Transfer CFT log file page by page. The page by page display is obtained via the more utility.

Syntax

cftlog

cftalog

cftalog is a shortcut to display the secondary (alternate) Transfer CFT log file page by page. The page by page display is obtained via the more utility.

Syntax

cftalog

cftparm

cftparm is a shortcut for the CFTUTIL LISTPARM TYPE=ALL command.

Syntax

cftparm

cftpart

cftpart is an improved shortcut for the CFTUTIL LISTPART TYPE=ALL command.

Syntax

cftpart

cftdelcat

cftdelcat is an improved shortcut for the CFTUTIL DELETE command.

Syntax

cftdelcat [part=PART]

Standard use

This command is used without parameters. cftdelcat deletes all entries in the Transfer CFT catalog.

cftdelcat

Advanced use

This command is used with a partner (BOSTON in the example). It deletes all Transfer CFT catalog entries for the selected partner.

cftdelcat part=BOSTON

xfbadmgrp

The xfbadmgrp utility is used to create, delete, modify and check a group (of users) with access rights to the Copilot server. It can be used in interactive mode associated with a command (add, delete, and so on) or in batch mode, specifying each of the required commands (-G group –p passwd, and so on).

Syntax

Add a user group:

xfbadmgrp add [-G <group>] [-p <passwd>] [-g <GID>] [-u <users>]

Delete a user group:

xfbadmgrp delete [-G <group>]

Modify a user group:

xfbadmgrp modify [-G <group>] [-p <passwd>] [-g <GID>] [-u <users>]

Display information on existing groups:

xfbadmgrp print [-G <group>]

This command displays information on a given group (if the -G option is used) or on all existing groups.

Standard use

xfbadmgrp  add | delete | modify | print | check | help

Advanced use

Various options can be used to make it easier to enter information or allow you to work in batch mode:

  • -G <group>: ASCII name of the user group
  • -p <passwd>: Password required to access this group
  • -g <GID>: Numeric identifier of the group. If it is set to AUTO, the GID is generated automatically
  • -u <usr1,usr2>: List of existing users, separated by a comma

xfbadmusr

The xfbadmusr utility is used to create, delete, check, and modify a user with access rights to the Copilot server. It can be used in interactive mode associated with a command (add, delete, and so on) or in batch mode, specifying each of the required commands (-G group -p passwd, and so on).

Syntax

Add a user. If the group does not exist, it is automatically created with the user login name.

xfbadmusr add [-l <login>] [-p <passwd>] [-u <UID>] [-g <GID>]

Delete a user. Users in the group file are automatically deleted from all the groups with which they are associated.

xfbadmusr delete [-l <login>]

Modify a user. If necessary, modifications are applied automatically to the group file.

xfbadmusr modify [-l <login>] [-p <passwd>] [-u <UID>] [-g <GID>]

Check a user.

xfbadmusr check [-l <login] [-p passwd]

Display information on existing users. Display information on a given user (if the -l option is used) or on all existing users.

xfbadmusr print [-l <login>]:

Standard use

xfbadmusr add | delete | modify | print | check | help

Advanced use

You can use the following options to make it easier to enter information, or to work in batch mode:

  • -l < login >: Login name
  • -p < passwd >: Password
  • -u < UID >: User identifier - When set to AUTO, a UID is generated automatically
  • -g < GID >: Group identifier - When set to AUTO, the GID is generated automatically

System utilities

cft2unix

The cft2unix utility is used in a user shell to obtain the value of an environment variable or the name of a logical file used by Transfer CFT. This command is useful when switching between log and accounting files.

Syntax

cft2unix <string>

Use

% cft2unix _CFTLOG
/home/transfer/cft/<installdir>/runtime/log//cft_log
%

cftkey

cftkey is a small utility used to display all information that may be requested by the Axway Technical Support Team for details about your system.

Syntax

cftkey

Use

% cftkey

Technical System Data

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

build IBM
model A0
procs 02
cpuid 8828D8828D8828D8
syst AIX
level 4
state 1

The example above shows the information supplied by cftkey on an AIX 4.1-based IBM system.

Note that the procs item indicates:

  • The value 1+ if the number of processors cannot be determined dynamically, or
  • The number of processors physically available on the system (and not the number of active processors)

cftversion

cftversion provides the same result as the CFTUTIL ABOUT command but without the associated banners. This is a quick method of providing the sales department with the information required, for example, to calculate the software protection key or determine the Transfer CFT technical level.

Syntax

cftversion

Use

% cftversion
CFT/V3/UAIX
3.6 2020/04/04               <- Generation date
Copyright AXWAY 2020

information:
* product = CFT/
* version = 36
* level = 1a-200-U0C
* Upgrade = 1404

information:               <- Information required to
* model = A0               <- calculate the software
* cpuid = 8828D8828D8828D8     <- protection key

ABOUT _ Correct

cftping

The cftping utility is used to determine whether Transfer CFT is running on the user account.

Syntax

cftping [-h | -v | -i | -p]

Note The results of this command do not guarantee that Transfer CFT is 100% operational. They do indicate that the product normally generated when Transfer CFT is activated, CFTMAIN and main shared memory segment, are present on the system.

Use in a shell script

One of the advantages of cftping is that by testing the command return code, you can determine whether or not Transfer CFT is running in the operator's account. The two commands described earlier, cft start and cft stop, use cftping.

If it is used in a shell script without any options, the program returns the following values:

  • 0: Transfer CFT is not running; the environment (shared memory) is correct
  • 1: Transfer CFT is running; the environment (shared memory) is consistent
  • 2: Transfer CFT is running but the status is inconsistent at shared memory level
  • 3: Transfer CFT is not running (CFTMAIN is not present) but the status is inconsistent (at least
    one of the shared memory segments exists)
  • 9: procedure error

These values can easily be retrieved and processed in a shell script. For example, a script written in Korn Shell may contain the following lines:

cftpid = `cftping -p` # store CFT PID
code = $? # cftping execution code
if [ "$code" != "0" ]
then
echo "CFT is not running"
else

Your error handling code....
fi

Use in interactive mode

Where:

  • -v: verbose mode (displays the current Transfer CFT status as alive, not running or dead)
  • -i: information (provides information on the shared memory and semaphores)
  • -p: PID (provides the PID of the process that created the shared memory)

Normally, the user enters the command in its simple form:

cftping -v

The three possible responses are as follows.

  • If Transfer CFT is not running and the system status is consistent:

% cftping -v
cft: not running

  • If Transfer CFT is running (CFTMAIN present and system status consistent):

% cftping -v
cft is alive

  • If Transfer CFT is in inconsistent status (several types of message are possible):

% cftping -v
cft: pid 26840 is dead

xvi

The xvi utility is used to update a conversion table.

Syntax

xvi [-d | -a | -e | -l <file> ] <table>

Standard use

xvi <table>: updates an existing, valid <table> (256 characters).

Advanced use

The following options can be used with xvi:

  • -d: displays an existing, valid <table> in ASCII
  • -a: creates a <table> to convert ASCII to EBCDIC; this table is identical to the one accessed via the Transfer CFT CFTXLATE command (if <table> exists, it is overwritten)
  • -e: creates a <table> to convert EBCDIC to ASCII; this table is identical to the one accessed via the Transfer CFT CFTXLATE command (if <table> exists, it is overwritten)
  • -l: creates a <table> from an ASCII <file>; the file generally used is the file produced after running option -d (if <table> exists, it is overwritten)

Conversion tables

By default, Transfer CFT uses internal tables to convert ASCII characters to EBCDIC and vice versa. They are based on the ASCII character set as defined on PC/DOS systems.

To perform a conversion using the ISO 8859-1 ASCII character set, run the CFTXLATE command with the following external conversion tables:

  • atoe: ISO 8859-1 ASCII to EBCDIC
  • etoa: EBCDIC to ISO 8859-1 ASCII

You can use the xvi utility, described above, to create specific conversion tables or modify existing tables.

Related Links