Note on usage
Function: Modify operating parameters
User group: FT administrator
Functional description
You can use ftmodo to define and modify the following parameters for openFT operation:
the key length of the RSA key
the minimum RSA key length
the minimum AES key length
the maximum values for file transfer
the identification and the name of the local system
the default value for the security level
the mode for sender verification
the global setting for sender verification
the logging scope (file transfer, directory transfer, FTAC, ADM requests)
the traces scope
the traps scope
the automatic deletion of log records
the switch-over of the log file and trace file
the scope of measurement data recording
the variant of the used code table
the addresses for the individual protocols
the settings for the remote administration server
the use of TNS and CMX
the settings used for user data encryption
the global deactivation of the restart for outbound and inbound requests
the configuration of the FarSync X.25 transport system
- the FT administrator
For FTAM operation, you can also activate, deactivate or specify the Application Entity Title (AET).
Format
ftmodo -h |
[ -kl=0 | -kl=768 | -kl=1024 | -kl=2048 | -kl=3072 | -kl=4096 ]
[ -klmin=0 | -klmin=768 | -klmin=1024 | -klmin=2048 | -klmin=3072 | -klmin=4096 ]
[ -aesmin= | -aesmin=128 | -aesmin=256 ]
[ -tu=<transport unit size 512..65535> ]
[ -pl=<process limit> | -pl= ] ( Windows systems)
[ -pl=1 | -pl= ] ( Unix systems )
[ -cl=<connection limit 1..255> ]
[ -admcl=<connection limit 1..255> ]
[ -admcs=n | -admcs=y ]
[ -admpriv=<FT admin name 1..36 ( Windows systems ) or 1..32 ( Unix systems )> | -admpriv=system ( Windows systems ) or -admpriv=root ( Unix systems ) ]
[ -gadmpriv=<FT admin group name 1..32> ]
[ -rql=<maximum number of requests 2..32000> ]
[ -rqt=<request lifetime 1..400> | -rqt= ]
[ -id=<identification 1..64> ]
[ -p=<processor name 1..8> ][ -l=<station name 1..8> ]
[ -sl=<security level 1..100> | -sl=p ]
[ -ptc=i | -ptc=a | -ptc=t | -ptc=b ]
[ -lf=c ][ -lt=a | lt=f | lt=n] [ -lc=a | -lc=m | -lc=r ]
[ -ltd=a | -ltd=f | ltd=n ]
[ -la=a | -la=f | -la=m | -la=n ]
[ -ld=n | -ld=f ][ -lda=<0..999> ][ -ldt=hhmm ]
[ -ldd=@d | Mo | Tu | We | Th | Fr | Sa | Su | <1..31> ]
[ -mon=n | -mon=f ][ -monr=[l|r][a|s] ]
[ -monp=a | -monp=[openft][,][ftam][,][ftp] ]
[ -tr=n | -tr=f | -tr=c ]
[ -trp=a | -trp=[openft][,][ftam][,][ftp][,][adm] ]
[ -trr=[ l |r][a | s] ][ -tro=[b] ][ -troll=[s | d]
[ -atpsv=[<partner 1..200>][,][<transfer admission 8..67> | @d ]
[ -atp=a | -atp=n | -atp=[[-]fts],[[-]rqs],[[-]rqc],
[[-]rqf],[[-]pts],[[-]ptu] ]
[ -tpc=a | -tpc=n | -tpc=[[-]sss],[[-]fts],
[[-]rqs],[[-]rqc],[[-]rqf],[[-]pts],[[-]ptu] ]
[ -ccs=<CCS name 1..8> ]
[ -fnccs=<csn> ] ( Unix systems )
[ -acta=a | -acta=[openft][,][ftam][,][ftp][,][adm] ]
[ -ftp=<port number 1..65535> | -ftp=@s]
[ -openft=[<port number 1..65535>][.<T-Sel 1..8>] |-openft=@s ]
[ -ftam=[<port number 1..65535>][.<T-Sel>[.<S-Sel>[.<P-Sel>]]] |-ftam=@s ]
[ -adm=<port number 1..65535> | -adm=@s ]
[ -ftstd=<port number 1..65535> | -ftstd=@s ]
[ -tns=y | -tns=n ]
[ -cmx=y | -cmx=n ]
[ -rco=n | -rco=f ] [ -rci=n | -rci=f ]
[ -ae=y | -ae=n ]
[ -aet=@n | -aet=@i | -aet=<AET 1..64> ]
[ -dp=n | -dp=f ]
[ -c= | -c=i | -c=o | -c=io | -c=oi ]
[ -x25=[<0..15>[=<DTE 1..15>] .. [,<0..15>[=<DTE 1..15>]]] ] ( Linux systems)
[ -x25=[<0..3>:<0..3>[=<DTE 1..15>] ..[,<0..3>:<0..3>[=<DTE 1..15>]]] ] ( Windows systems )
[ -openftx25=y | -openftx25=n ]
[ -openftx25lif=[0][,1][,2][,3]..[,15] ] ( Linux systems )
[ -openftx25lif=[0][,1][,2][,3] ] ( Windows systems )
[ -openftx25lnb=<1..99> ]
[ -openftx25cl=0/- | -openftx25cl=2/0 | -openftx25cl=2/2 ]
[ -openftx25nsap=<AFI 36 | .. | 59>.[<IDI 0..15>][.<DSP 0..38>] | 2..40 ]
[ -ftamx25=y | -ftamx25=n ]
[ -ftamx25lif=[0][,1][,2][,3]..[,15] ] ( Linux systems )
[ -ftamx25lif=[0][,1][,2][,3] ] ( Windows systems )
[ -ftamx25lnb=<1..99> ]
[ -ftamx25cl=0/- | -ftamx25cl=2/0 | -ftamx25cl=2/2 ]
[ -ftamx25nsap=<AFI 36 | .. | 59>.[<IDI 0..15>][.<DSP 0..38>] | 2..40 ]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
-kl=0 | -kl=768 | -kl=1024 | -kl=2048 | -kl=3072 | -kl=4096
The -kl parameter can be used to change the length of the RSA key used in encryption. The value of the kl parameter specifies the new RSA key length (RSA-PROPOSED) in bits. The RSA key is only used for the encryption of the AES key agreed between the partners. The configured key length for RSA proposal must be greater than or equal to the specified minimum key length, otherwise a warning will be issued and the proposed key length will be adapted to the minimum key length.
openFT uses the AES key for encrypting request description data and any file content present.
The ftmodo -kl=... command can be specified in current openFT operation.
-kl=0 explicitly deactivates encryption. If this is set during operation then any requests with encryption (prior to ftmodo -kl=0) that have been submitted but not yet started are aborted with errors. Any running requests are processed and their encryption is retained. New requests using encryption are rejected.
After reinstallation, the default value -kl=768 is used.
Default setting following initial installation: -kl=2048.
-klmin=0 | -klmin=768 | -klmin=1024 | -klmin=2048 | -klmin=3072 | -klmin=4096
This option specifies the minimum RSA key length.
0
No minimum key length is specified. Any key length and even requests without encryption will be accepted.
768 | 1024 | 2048 | 3072 | 4096
Only keys of the specified length or larger ones will be accepted. If the initiator uses a key of a lower length there will be a counter proposal by the responder of the session. Sessions without encryption will not be accepted. That means: Since an RSA key set is always created on the open platforms during installation, an RSA key is always sent in the protocol during the subsequent data transfer. If this key is deleted and the partner requests encryption, then the partner rejects the connection with s Session Reject (SRJ) "connection not accepted without encryption".
Default setting following initial installation: -klmin=0.
-aesmin= | aesmin=128 | -aesmin=256
This option specifies the minimum AES key length.
aesmin=
If you specify aesmin= (without specifying a key length) no minimum AES key length is set. Any AES key length and even requests with DES key will be accepted.
128 | 256
Only AES keys of the specified length or larger ones will be accepted. If the partner cannot fulfill this requirement the request will be rejected.
Default setting following initial installation: -aesmin= .
-tu=transport unit size
You use the parameter -tu to define the upper limit for message length at transport level (block length). You can choose a value between 512 and 65535.
The block length only applies to requests to openFT partners.
Default setting following initial installation: -tu=65535.
-pl=1 | -pl= (Unix systems)
Maximum number of processes used for the processing of asynchronous requests.
1
All asynchronous requests are processed by the same process.
No value specified
If you specify -pl= without parameters then the number of processes is equal to the number of connections, i.e. each connection is handled by a separate process.
Default setting following initial installation: -pl= (i.e. no number specified).
pl= process limit | -pl= (Windows systems)
process limit is the maximum number of openFT servers used for the processing of asynchronous requests.
process limit not specified
If you specify -pl= without parameters then the number of openFT servers is equal to the number of connections, i.e. each connection is handled by a separate openFT server.
-cl=connection limit
Maximum number of asynchronous requests that are processed simultaneously. Possible values: 1 to 255.
The default value is 16.
Default setting following initial installation: -cl=16.
-admcl=connection limit
Maximum number of connections provided for remote administration requests. Possible values: 1 through 255.
Read the note under -admcs.
Default setting following initial installation: -admcl=8.
-admcs=n | -admcs=y
Specifies whether the local openFT instance is flagged as a remote administration server.
y
Flags the local openFT instance as a remote administration server. This means that this instance can also be an ADM trap server.
n
The local openFT instance is not (no longer) flagged as a remote administration server. This means that it is not (no longer) possible to receive ADM traps. This is the default after a new installation.
64 if -admcs=y.
8 if -admcs=n.
Default setting following initial installation: -admcs=n .
-admpriv=name of new FT administrator | -admpriv=system ( Windows systems ) or root ( Unix systems )
The option is used to alter the FT administrator.
name of new FT administrator
The name of any active windows user with or without specifying domain e.g:
ftmodo -admpriv=hugo or ftmodo -admpriv=g02\hugo
This will result in giving FT administrator rights to user “hugo”. Since that point, only user “hugo” has access to FT administrator rights with or without local administrator rights. Any other user is not permitted to execute any FT administrator commands, even if utilizing local administrator rights.
system ( Windows systems ) or root ( Unix systems )
This will switch back to the previous functionality, that is the FT administrator needs local administrator rights.
Alteration of FT administrator takes effect immediately, however as for GUI, when user has it opened, then it needs to be restarted in order for change to be applied.
So far until openFT 12.1C70 there was only one openFT administrator (as user or group of users) for whole openFT. Starting from version 12.1C80, every instance will have separate openFT administrator.
The administrator of the STD instance will be at the same time global administrator, who can handle global openFT settings.
The only difference is that this user will be administrator of instance, which is currently set in environment and user will be able to use administrative commands only on that instance.
Globaler Administrator
The user who is set to be the administrator of the STD instance, is the global administrator. The global administrator is the only user that is allowed to run commands that affect openFT globally (ftaddlic), and commands that administer instances (ftcrei, ftmodi, ftdeli).
Additionally, those commands will only work if the currently active instance is STD; Therefore, if global administrator switched to a different instance (using ftseti), those commands will not be able to be executed.
When those command are executed unauthorized, an error message is displayed:
<name_of_command>: Command is only available to the STD administrator.
-gadmpriv=name of FT administrator group (Linux group)
name of FT administrator group (Linux group)
The name of any local Linux group, every user in the group will have FT administrator rights.
The FT administrator cannot be assigned along with the FT administrator group, only one option has to be used at a time.
Alteration of FT administrator takes effect immediately, however as for GUI, when user has it opened, then it needs to be restarted in order for change to be applied.
rql=maximum number of requests
You use -rql to specify the maximum number of entries in the request queue. You can choose a value between 2 and 32000.
Default setting following initial installation: -rql=2000.
-rqt=request lifetime | -rqt=
You use -rqt to specify the maximum lifetime of requests in the request queue. The value applies to both inbound and outbound requests and is specified in days. Values between 1 and 400 are permitted. Once the specified period has expired, requests are deleted from the request queue.
request lifetime not specified:
If you specify -rqt= without parameters then the maximum lifetime is unlimited.
Default setting following initial installation: -rqt=30.
-id=identification
Specifying the instance identification of your instance. Partner systems using openFT Version 8.1 and later, address your system via this string. In return, openFT uses the instance ID as the sender address when addressing the partners. The instance ID must be unique and not case-sensitive (see also section “Instance identification” ). If you modify the instance ID, the relevant public key files will be automatically updated.
Default setting following initial installation: -id= local DNS name or host name.
-p=processor name
You specify the processor name assigned to your system here.
No processor name is specified after initial installation.
-l=station name
The station name of the openFT application. The default value is $FJAM.
Default setting following initial installation: -l=$FJAM.
The specifications for processor name and station name depend on how your system is connected to the network. Further details can be found in the manual "openFT (Unix and Windows systems) - Installation and Operation".
-sl=security level | -sl=p
You use this option to define the default security level. This level applies to partners in the partner list to which no explicit security level value was assigned when they were entered with ftaddptn. The effect also depends on the settings for the admission set, see the ftmoda command.
security level
Specifies a fixed default security level. Values between 1 and 100 are permitted. 1 indicates a very low and 100 a very high requirement for protection with regard to the partners.
p
The default security level depends on the partner's attributes:
Security level 10 if the partner has been authenticated.
Security level 90 if the partner is known in the transport system and is identified by the name it is known by in the transport system.
Security level 100 otherwise, i.e. if the partner has only been identified by its address.
Default setting following initial installation: -sl=p.
-ptc=i | -ptc=a | -ptc=t | -ptc=b
This allows you to modify the global settings for sender verification. This setting only applies to named partners which are connected via the openFT or FTAM protocol and to which the following applies:
Partners connected via the openFT protocol do not use authentication
Using the FTAM protocol the partner identifies itself with a Calling Application Entity Title which does not correspond to the nil AP Title
In the case of dynamic partners and FTP partners, this setting has no effect.
i (identification)
openFT partners are checked via the identification. FTAM partners are checked via the transport address; any specified Calling Application Entity Title is ignored.
a (address)
openFT partners are checked via identification and additionally via the transport address. FTAM partners are checked via the transport address; any specified Calling Application Entity Title is ignored.
If the transport address under which the partner logs in does not correspond to the entry in the partner list then the request is rejected.
t (application entity title)
openFT partners are checked via the identification. FTAM partners are checked via the Calling Application Entity Title in case it is specified and does not correspond to the nil AP title; otherwise, the transport address is checked.
b (both)
openFT partners are checked via identification and additionally via the transport address. FTAM partners are checked via the transport address as well as via the Calling Application Entity Title in case it is specified and does not correspond to the nil AP title; otherwise, the transport address is checked.
For FTAM partners there are no partner-specific settings for the sender check.
If -ptc=t or -ptc=b has been set, any identifications specified when entering or modifying FTAM partners are checked for uniqueness. If the Application Entity Title is used for partner identification, we recommend to set the option -ptc at this value from the start as existing ambiguities could persist.
Default setting following initial installation: -ptc=i.
-lf=c
The log file is changed.
The new log file is created under the name syslog.Lyymmdd.Lhhmmss:
yymmdd is the date (year, month, day) on which the file was created,
hhmmss is the time (hour, minute, second for GMT) on which the file was created.
-lt=a | -lt=f | -lt=n
This option is used to selectively deactivate FT log records. Possible values:
a (all)
Log records are written for all FT requests.
f (failure case)
Log records are written for failed FT requests only.
n (none)
No log records are written.
-lt does not affect the logging of directory transfer, i.e. the options -lt and -ltd are independent from each other.
Default setting following initial installation: -lt=a.
-lc=a | -lc=m | -lc=r
This option is used to selectively activate/deactivate FTAC log records. Possible values:
a (all)
Log records are written for all FTAC access checks.
m (modifying FM calls)
Log records are written for all modifying file management requests leaving the remote system as well as for all rejected FTAC access checks.
r (reject case)
Log records are written for rejected FTAC access checks only.
Default setting following initial installation: -lc=a.
-ltd=a | -ltd=f | -ltd=n
This option is used to selectively activate the logging of directory transfer (FT-DIR logging). The following parameters are available:
a (all)
Log records are written for all individual FT requests, i.e.:
one log record for each transferred file
one log record for each transferred directory or subdirectory
f (failure case)
Log records are written for failed individual FT requests only.
n (none)
No log records are written for individual FT requests. I.e. only the log record of the main FT request and FTAC log records are written.
-ltd does not affect the logging of individual file transfer, i.e. the options -lt and -ltd are independent from each other.
Default setting following initial installation: -ltd=n.
-la=a | -la=f | -la=m | -la=n
This option allows you to selectively activate the logging of administrative requests. The following parameters are available:
a (all)
Log records are written for all administration requests.
f (failure)
Log records are only written for failed administration requests.
m (modifying)
Log records are written for all administration requests that make modifications.
n (none)
No log records are written for administration requests.
Default setting following initial installation: -la=a.
-ld=n | -ld=f
This option allows you to control whether log records are deleted automatically.
n (on)
Activates the automatic deletion of log records. This activates the criteria specified in -lda, -ldt and -ldd (minimum age and deletion interval).
f (off)
Deactivates the automatic deletion of log records. When this option is set, the settings made for -lda, -ldt and -ldd have no effect.
Default setting following initial installation: -ld=f.
-lda=0..999
Minimum age of log records for deletion in days. The days are counted back from the deletion time specified in -ldt. The value 0 deletes all the log records that were written before or on the time of the current day specified in -ldt.
Default setting following initial installation: -lda=14.
-ldt=hhmm
Specifies the (local) time at which the log records are to be deleted. Depending on the system, the delete function may be executed up to 5 minutes before the time specified here.
Default setting following initial installation: -ldt=0000 (i.e. time = 00:00).
-ldd=@d | Mo | Tu | We | Th | Fr | Sa | Su | 1..31
Specifies the day on which the log records are to be deleted.
Mo | Tu | We | Th | Fr | Sa | Su
Delete every week on the selected weekday (Mo=Monday, .. Su=Sunday).
1..31
Delete every month on a specific day of the month (1-31). If the value 29, 30 or 31 is specified for a month that has fewer days than this then deletion is performed on the last day of the month.
@d
The log records are deleted every day.
Default setting following initial installation: -ldd=@d (i.e. delete every day).
-mon=n | -mon=f
This allows you to activate and deactivate openFT monitoring.
n (on)
openFT monitoring is activated.
f (off)
openFT monitoring is deactivated.
Default setting following initial installation: -mon=f.
-monr= | -monr=[l|r][a|s]
This allows you to select openFT monitoring depending on the request type. The value l or r can be combined with a or s (Boolean AND, e.g. la, al, ls, rs, ...).
l (local)
Monitoring data is collected for requests issued locally.
r (remote)
Monitoring data is collected for requests issued remotely.
a (asynchronous)
Monitoring data is collected for asynchronous requests. Requests issued remotely are always regarded as asynchronous.
s (synchronous)
Monitoring data is collected for synchronous requests. Synchronous requests are always issued locally.
No request type specified
If you specify -monr=, monitoring data is collected for all requests.
Note that -monr=rs does not completely deactivate monitoring. -monr=rs has the same effect as -monp=. See the ftshwm command, section “Description of the monitoring values” .
Default setting following initial installation: -monr=.
-monp= | -monp=a | -monp=[openft][,][ftam][,][ftp]
This allows you to select openFT monitoring depending on the protocol type used for the partners. Combinations are also permitted if you specify the protocols individually (separated by commas).
a
Monitoring data is collected for all partners.
openft
Monitoring data is collected for openFT partners.
ftam
Monitoring data is collected for FTAM partners.
ftp
Monitoring data is collected for FTP partners.
No protocol type specified
If you specify -monp= with no parameters, the monitoring is deactivated for partners. In this event, only certain monitoring data values are populated. See the ftshwm command, section “Description of the monitoring values” .
Default setting following initial installation: -monp=a
-tr=n | -tr=f | -tr=c
This allows you to activate and deactivate the openFT trace function.
n (on)
The openFT trace function is activated.
f (off)
The openFT trace function is deactivated.
c (change)
The current trace file is closed and a new one is opened.
Default setting following initial installation: -tr=f.
-trp=a | -trp=[openft][,][ftam][,][ftp][,][adm]]
This allows you to select the openFT trace function depending on the type of protocol used for the partners by specifying a comma-separated list of one or more protocol types. All the partners that are addressed via this or these protocol type(s) are then traced.
You can modify the selection made here on a partner-specific basis, see the -tr option in the ftmodptn command.
a (all)
All protocol types, and consequently all partners, are selected for tracing.
openft
All partners addressed via the openFT protocol are selected for tracing.
ftam
All partners addressed via the FTAM protocol are selected for tracing.
ftp
All partners addressed via the FTP protocol are selected for tracing.
adm
All partners addressed via the FTADM protocol are selected for tracing.
No protocol type selected
If you specify -trp= without parameters then no partner is selected for tracing. In this case, only those partners for which tracing has been activated on a partner-specific basis using ftmodptn ... tr=n are traced.
Default setting following initial installation: -trp=a.
-trr=[l | r][a | s]
This option allows you to select the request types that are to be traced. The value l or r can be combined with a or s (Boolean AND, e.g. la, al, ls, rs, ...).
l (local)
All locally submitted requests are selected for tracing.
r (remote)
All remotely submitted requests are selected for tracing.
a (asynchronous)
All asynchronous requests are selected for tracing. Requests issued remotely are always regarded as asynchronous.
s (synchronous)
All synchronous requests are selected for tracing. Synchronous requests are always issued locally.
No request type specified
If you specify -trr= without parameters then all requests are selected for tracing.
Note that -trr=rs does not completely deactivate tracing. Interface trace files, for instance, continue to be created (if activated).
Default setting following initial installation: -trr=.
-tro=[b]
You can use -tro to select options for the trace function. These options are only effective if the trace function is active.
b (no bulk data)
Minimum trace. Only protocol elements with no file contents (bulk data) are written to the trace file. In the case of protocol elements with file contents, the trace file simply notes that records have been suppressed at this point. This note is entered only once for a sequence of similar records.
No option specified
If you specify -tro= without parameters then the trace is written normally.
Default setting following initial installation: -tro=.
-troll=[s | d]
You use -troll to define the scope of the trace for the lower protocol layers. This option is effective only if the trace function is activated.
s (standard)
Additional entries are written in the standard scope for the lower protocol layers. The standard scope comprises comprehensive logging of the calls, their arguments, the content of any options and the user data.
d (detail)
In addition to the standard scope, internal events and transport system information (e.g. system calls) are written for the lower layers.
No option specified
If you specify -troll= with no parameters, no trace is performed for the lower protocol layers.
In the case of operation without CMX, the trace entries for the lower protocol layers are written to the openFT trace.
In the case of operation with CMX, CMX traces are generated and stored in the traces directory of the associated openFT instance. These can then, for example, also be selected and displayed in the openFT Explorer (Adminis-tration menu, Open Trace File command).
Using this option, it is therefore possible to activate and deactivate CMX traces during active CMX operation.
Default setting following initial installation: -troll= .
-atpsv=[partner][,][transfer admission | @d]
-atpsv= allows you to specify the settings for the ADM trap server. When you enter the ADM trap server for the first time, you must specify both the partner and the transfer admission. You can subsequently change each of the two parameters individually.
partner
Name or address of the partner to which the ADM traps are sent. This must either be a name from the partner list or the address must be specified in the form
ftadm://host.... See the section “Specifying partner addresses” .
transfer admission
FTAC transfer admission for accessing the ADM trap server.
@d for transfer admission
If you specify @d (blanked), the transfer admission is queried on screen after the command has been sent. Your input is blanked.
neither partner nor transfer admission specified
If you specify -atpsv= without parameters, you remove the ADM trap server. This means that ADM traps are no longer sent.
Default setting following initial installation: -atpsv=.
-atp=a | -atp=n | -atp=ADM trap list (comma-separated)
-atp allows you to activate and deactivate ADM traps. The ADM trap server to which the ADM traps are to be sent is specified with -atpsv.
The following specifications are possible with the -atp option:
a (all)
All ADM traps are written.
n (none)
No ADM traps are written.
fts
Activates the ADM traps on the status of the asynchronous server.
-fts
Deactivates the ADM traps on the status of the asynchronous server.
rqs
Activates the ADM traps on the status of the request queue.
-rqs
Deactivates the ADM traps on the status of the request queue.
rqc
Activates the ADM traps when a request has been terminated successfully.
-rqc
Deactivates the ADM traps when a request has been terminated successfully.
rqf
Activates the ADM traps when a request has failed.
-rqf
Deactivates the ADM traps when a request has failed.
pts
Activates the ADM traps on the status of the partner system.
-pts
Deactivates the ADM traps on the status of the partner system.
ptu
Activates the ADM traps if a partner system is not available.
-ptu
Deactivates the ADM traps if a partner system is not available.
Default setting following initial installation: -atp=n.
-tpc=a | -tpc=n | -tpc=Console trap list (comma-separated)
You use -tpc to activate and deactivate console traps.
In Unix and Windows systems, console traps are written to the openFT file conslog. In Unix, BS2000 and z/OS systems they are also output at the console and in Windows systems they are also written to the event log.
For -tpc you can enter the following values:
a (all)
All traps are written.
n (none)
No traps are written.
sss
Activates traps relating to the status of the openFT subsystem.
-sss
Deactivates traps relating to the status of the openFT subsystem.
fts
Activates traps relating to the status of the asynchronous server.
-fts
Deactivates traps relating to the status of the asynchronous server.
rqs
Activates traps relating to the status of the request queue.
-rqs
Deactivates traps relating to the status of the request queue.
rqc
Activates traps on the successful termination of a request.
-rqc
Deactivates traps on the successful termination of a request.
rqf
Activates traps on the unsuccessful termination of a request.
-rqf
Deactivates traps on the unsuccessful termination of a request.
pts
Activates traps relating to the status of partner systems.
-pts
Deactivates traps relating to the status of partner systems.
ptu
Activates traps when a partner system is inaccessible.
-ptu
Deactivates traps when a partner system is inaccessible.
Default setting following initial installation: -tpc=n.
-ccs=CCS name
You use CCS name to define a new character set which is represented by a code table. This character set is then used as the new default value for transfer requests (ft, ncopy). The code table specification is only relevant for requests to openFT partners.
Another character set can be explicitly assigned for ft and ncopy (options -lc and -rc).
You can also define your own character set. For details concerning CCS names and the associated code tables, see the manual "openFT (Unix and Windows systems) - Installation and Operation".
Default value following initial installation:
-ccs=iso88591 (Unix systems, corresponds to ISO8859-1)
-ccs=CP1252 (Windows systems)
-fnccs=ccsn (only Unix systems)
Specifies the character set, into which the local path names and scripts to be run are converted for inbound openFT requests in character mode, i.e.:
When listing files and directories in character mode local file names and attributes on the inbound side are interpreted in this character set.
The output of commands called via ftadm in character mode as well as commands called via ftexec with -rc=*SYS are interpreted in this character set.
Default setting following initial installation: No conversion for inbound requests in character mode.
-acta=a | -acta=[openft][,][ftam][,][ftp][,][adm]
This option allows you to activate or deactivate the asynchronous inbound server. You can activate the asynchronous inbound server for specific protocols (openFT, FTP, FTAM, ADM), by specifying a comma-delimited list of one or more protocol types.
a
The asynchronous inbound servers are activated for all installed protocol types.
openft
Activates the asynchronous inbound server for requests via the openFT protocol.
ftam
Activates the asynchronous inbound server for requests via the FTAM protocol. A warning is issued if the FTAM protocol is not installed.
ftp
Activates the asynchronous inbound server for requests via the FTP protocol. A warning is issued if the FTP protocol is not installed.
adm
Activates the asynchronous inbound server for administration requests.
No protocol type specified
Specifying -acta= without parameters deactivates all asynchronous inbound servers.
Default setting following initial installation: -acta=openft,ftam,adm .
-ftp=port number | -ftp=@s
You use port number to specify the port number used by FTP.
Possible values: 1 to 65535.
@s
Sets the port number for FTP server to the default value of 21.
Default setting following initial installation: -ftp=@s.
-openft=[port number][.T-selector] | -openft=@s
port number
You can use port number to specify a port number other than the default for the local openFT server.
Possible values for the port number: 1 to 65535
T-selector
You can also specify a T-selector of between 1 and 8 characters in length. You can specify the selector in printable or hexadecimal format (0xnnnn...). Alphanumeric characters and the special characters # @ $ are permitted for printable selectors.
A printable selector will be converted to uppercase, coded in EBCDIC in the protocol and may be padded with spaces internally to the length of eight characters. In this case, the port number and T-selector must be separated by a period.
@s
-openft=@s sets the port number and the T-selector for the openFT server to the default value, i.e. 1100 and $FJAM.
Default setting following initial installation: -openft=@s (d.h. 1100 und $FJAM ).
Notes on operation with TNS
If you are switching from operation without TNS to operation with TNS (-tns=y) and if only the T-selector with no port number had previously been set under -openft, you must specify the port number explicitly, even if it matches the default value. This is necessary to ensure that the T-selector cannot be confused with the global name in the TNS.
For operating with TNS, you can specify a TNS name other than the default for the local openFT server. A period must be placed before the TNS name, e.g. -openft=.OPNFTSRV. The TNS name must not contain any period.
In the case of operation with TNS, the default value for the TNS name is $FJAM.
-ftam=[port number][.T-selector[.S-selector[.P-selector]]] | -ftam=@s
port number
You can use port number to specify a port number other than the default for the local FTAM server.
Possible values for the port number: 1 to 65535
The default value for the port number is 4800.
T-selector.S-selector.P-selector
You can also specify a T-selector, a session selector and a presentation selector, each of which may have a length of 1 to 16 characters. In this case, the port number, T-selector, S-selector and P-selector must be separated by a period. You can specify the selectors in printable or hexadecimal format (0xnnnn...)
T-selectors that start with $FTAM (default value) are coded in EBCDIC and padded with spaces to the length of 8 characters. In the protocol, all other printable T-selectors as well as all printable session and presentation selectors are converted to uppercase and coded with variable length in ASCII.
The default value for T-selector is $FTAM.
S-selectors and P-selectors do not have default values because, by default, openFT-FTAM does not use these selectors.
@s
-ftam=@s sets the port number and the TNS name for the FTAM server to the default value, i.e. 4800 and $FTAM.
Default setting following initial installation: -ftam=@s.
Notes on operation with TNS
If you switch to operation with TNS again (-tns=y) and if only the T-selector with no port number had previously been set under -ftam, you must specify the port number explicitly, even if it matches the default value. This is necessary to ensure that the T-selector cannot be confused with the global name in the TNS.
For operating with TNS, you can specify a TNS name other than the default for the local FTAM server. A period must be placed before the TNS name, e.g. -ftam=.FTAMSERV. The TNS name must not contain any period.
In the case of operation with TNS, the default value for the TNS name is $FTAM.
-adm=port number | -adm=@s
port number allows you to specify the port number used for remote administration.
Possible values: 1 to 65535.
@s
-adm=@s resets the remote administration port number to the default value of 11000.
Default setting following initial installation: -adm=@s.
-ftstd=port number | -ftstd=@s
You use port number to define the default port number for the addressing of openFT partners via partner addresses.
Possible values: 1 to 65535
Take care when using this option, because when you change the value of the option, openFT partners that use the default openFT port number 1100 can only be accessed if the port number is specified explicitly.
@s
-ftstd=@s resets the default port number for the addressing of openFT partners via partner addresses. The default port number of 1100 then applies again.
Default setting following initial installation: -ftstd=@s.
-tns=y | -tns=n
This option allows you to activate or deactivate the use of TNS names. This does not affect the use of TCP/IP host names, IP addresses or partner management, or the explicit specification of the port number and selectors with the -openft= and -ftam= options.
For operation with TNS to be possible, operation with CMX must be activated (ftmodo -cmx=y).
y
This activates the use of TNS names for openFT and FTAM transfer.
This is necessary, for example, if other transport protocols are to be used alongside TCP/IP.
n
This deactivates the use of TNS names. In this case, it is only possible to use the TCP/IP transport protocol. By default, the port numbers set in the operating parameters are used for communications (options -openft, -ftam and -ftstd).
This option should not be changed as long as requests are stored or active. Activation and deactivation of the TNS database can cause the conversion of a partner name to a partner address to change, which could in turn lead to requests failing (above all with restart requests) or to unwanted delivery of files. After switchover, temporary partner entries can also appear twice in the partner list for a while (see ftshwptn), even if the partner name is converted to the same address in both cases.
Default setting following initial installation: -tns=n .
-cmx=y | -cmx=n
This option allows you to switch between operation with CMX and operation without CMX. You can only perform this switchover if the asynchronous openFT server has not been started. You may therefore first have to shut down the asynchronous openFT server, e.g. with ftstop.
If you want to work with TNS then operation with CMX must be activated.
y
Switches to operation with CMX. This is only possible if CMX is installed in the minimum version required for operation with this openFT version. If CMX is not installed or is not installed in the correct version then the ftmodo command is rejected with an error message.
n
Switches to operation without CMX.
Default setting following initial installation: -cmx=n.
-rco=n | -rco=f
-rci=n | -rci=f
With the options -rco (recovery outbound) and -rci (recovery inbound) you can globally deactivate the restart function for outbound and inbound requests.
-rco=n (on)
The recovery for outbound jobs is activated for all partners for which there is no own partner-specific setting.
-rco=f (off)
The recovery for outbound jobs is deactivated for all partners for which there is no own partner-specific setting.
-rci=n (on)
The recovery for inbound jobs is activated.
-rci=f (off)
The recovery for inbound jobs is deactivated.
Default setting following initial installation: -rco=n, -rci=n.
-ae=y | -ae=n
This option activates/deactivates the AET (Application Entity Title).
y
A "nil Application Entity Title" is included as the calling or called Application Entity Title (AET) for transfer using the FTAM protocol.
n
The AET is deactivated. The option only has to be reset to -ae=n if FTAM partners, as responders, do not expect to receive an AET.
Default setting following initial installation: -ae=y.
-aet=@n | -aet=@i | -aet=AET
With this option you can specify the AET (Application Entity Title). It is sent in the initiator role as "calling AET" and in the responder role as "responding AET".
@n
The setting of -ae= is valid: if -ae=y is set, the nil APTitle is used. If -ae=n is set, no Application Entity Title is sent.
@i
The instance identification is used as Application Entity Title (ftmodo -id=...). In this case you should avoid syntactically incorrect specifications in the instance identification for the Application Entity Title.
In most of these situations, the nil APTitle is currently set instead; this can change in future versions.
AET
The explicit indication of a Calling/Responding Application Entity Title.
The format rules apply as described in the manual "Concepts and Functions".
-dp=n | -dp=f
You use this option to specify whether or not dynamic partners are permitted.
n (on)
Dynamic partners are permitted. Partners can then be accessed via their address irrespective of whether they are entered in the partner list or not.
f (off)
Dynamic partners are not permitted, i.e. partners cannot be accessed via their address. As a result, it is only possible to use partners that are entered by name in the partner list and are addressed via the partner name.
Default setting following initial installation: -dp=n.
-c= | -c=i | -c=o | -c=io | -c=oi
You use this data to control system-wide encryption of user data and file and/or directory list attributes. This setting applies to transfer requests file management requests and administration requests.
i
Activates inbound encryption, i.e.:
Inbound requests must transfer the user data in encrypted form as otherwise they are rejected.
Inbound FTAM requests and inbound FTP requests are rejected.
o
Activates outbound encryption, i.e.:
Outbound requests transfer the user data in encrypted form even if no encryption has been specified in the request (e.g. ft, ncopy, program interface, openFT Explorer). In addition applies:
Outbound FTAM requests are rejected.
Outbound FTP requests are, however, permitted.
File management requests transfer the file and directory list attributes in encrypted form, even if no encryption was called for in the request (ftshw).
However, if the partner system doesn’t support encryption, then the file and/or directory list attributes will be transferred without encryption.
io, oi
Activates inbound and outbound encryption, i.e. both the statements on inbound encryption and on outbound encryption apply.
No encryption option specified
Specify -c= to deactivate system-wide encryption of user data and file and/or directory list attributes. If encryption is required then this must be explicitly specified in the request.
System-wide encryption may only be activated if openFT-CR is installed.
Default setting following initial installation: -c= .
With the following options you configure the FarSync X.25 transport system.
The transport system X.25 can be used with the openFT- and FTAM protocol. It cannot be used with the FTP and FTADM protocol.
-x25= [Adapter : Line[ = DTE address]...] (Windows systems)
-x25=[Adapter[=DTE address]...] (Linux systems)
With the option -x25 a DTE address can be assigned to one or more lines. If DTE addresses are specified for several lines, the individual values must be separated from each other by a comma. A maximum of 16 lines can be simultaneously specified.
Identification of X.25 lines under Windows:
A line is uniquely defined via the combination of adapter number and line number.
You can specify up to four adapter numbers and line numbers at a time, so that a maximum of 16 lines results.
Identification of X.25 lines under Linux :
A line is uniquely defined via the adapter number. All lines for all adapters are numbered starting with 0.
-x25= Adapter : Line = DTE address (Windows systems)
-x25=Adapter=DTE address (Linux systems)
Assigns a DTE address to an X.25 line.
Default setting following initial installation: a DTE address is not assigned to any line.
-x25= Adapter : Line = (Windows systems)
-x25=Adapter= (Linux systems)
Resets the assigned DTE address to an X.25 line, i.e. the DET address is deleted.
-x25=
Resets all DTE addresses for all X.25 lines. All assigned DTE addresses are deleted.
-openftx25=y | -openftx25=n
You can enable and disable the use of the X.25 transport system for the openFT protocol here.
y
This selection enables the use of the X.25 transport system to be activated for the openFT protocol. The openFT protocol attaches to the X.25 transport system.
n
The use of the X.25 transport system is deactivated by the openFT protocol. No attach to the X.25 transport system by the openFT protocol takes place.
Default setting following initial installation: -openftx25=n
-openftx25lif= [ 0 ][ ,1 ][ ,2 ][ ,3 ] (Windows systems)
-openftx25lif=[0][,1][,2][,3]..[,15] (Linux systems)
[0],[1] specifies the adapter numbers of the FarSync X.25 cards, which the openFT protocol in the asynchronous openFT server is attached to in order to accept incoming connections. If no adapter has been selected for the openFT protocol, the incoming X.25 connections for the openFT protocol are then not accepted.
No adapter number specified:
-openftx25lif= resets the openFT protocol's setting for the FarSync X.25 cards, on which the incoming connections are to be accepted, i.e. incoming X.25 connections for the openFT protocol are not accepted.
Default setting following initial installation: -openftx25lif=0
-openftx25lnb=number of list calls
With this option you specify the number of list calls per FarSync X.25 card.
Possible values: 1 to 99
Default setting following initial installation: -openftx25lnb=5
To enable an incoming connection request to be accepted an application must place at least one list call via the FarSync program interface. If a connection request is made, this is then reported by the list call and the connection is established. However, each list call can only be used for one connection and must therefore be replaced by a new list call. This is done immediately after the connection has been accepted.
However, with a high load it is possible for there to be another connection request precisely in this brief period between the acceptance of an incoming connection and the placing of a new list call. This is rejected by the driver of the FarSync card, as the driver does not in principle buffer any incoming connection requests.
This behavior is stipulated by the design of the FarSync program interface. This problem can be remedied by placing several list calls per adapter. As standard, 5 list calls are placed in each case for each adapter that is configured with the option -openftx-25lif.
-openftx25cl=0/- | -openftx25cl=2/0 | -openftx25cl=2/2
Specifies which transport class is accepted for incoming connections for the openFT protocol.
0/-
Transport class 0 is to be used for incoming transport connections. In this case, incoming connections are (if possible) set down to transport class 0. If this is not possible, the connection request is rejected.
2/0
Both transport class 2 and 0 can be used for incoming transport connections.
2/2
Transport class 2 is to be used for incoming transport connections, i.e. only connections with transport class 2 are accepted. Incoming connections with transport class 0 are rejected.
Default setting following initial installation: -openftx25cl=2/0
-openftx25nsap=network address of the local openFT application
You can enter the network address (NSAP) of the local openFT application, i.e. for the openFT protocol. The NSAP is used as follows:
To identify the sender for a connection setup (Calling NSAP) via the openFT protocol. If no NSAP is entered, then "Calling NSAP" is not included in outgoing connections.
To identify the receiver for incoming connections (Called NSAP) via the openFT protocol. Please note that an incoming connection is only setup if the "Called NSAP" supplied by the partner matches the NSAP specified here. If e.g. no NSAP is specified here, the partner may not send a "Called NSAP", either.
Setup and format of the NSAP is identical to the description of the NSAP for the command ftaddptn , option -nsap.
No network address specified:
-openftx25nsap= resets the openFT protocol's setting for the local NSAP.
Default setting following initial installation: -openftx25nsap=
-ftamx25=y | -ftamx25 = n
You can enable and disable the use of the X.25 transport system for the FTAM protocol here.
y
This selection enables the use of the X.25 transport system to be activated for the FTAM protocol. The FTAM protocol attaches to the X.25 transport system.
n
The use of the X.25 transport system is deactivated by the FTAM protocol. No attach to the X.25 transport system by the FTAM protocol takes place.
Default setting following initial installation: -ftamx25=n
-ftamx25lif= [ 0 ][ ,1 ][ ,2 ][ ,3 ] (Windows systems) -ftamx25lif=[0][,1][,2][,3]..[,15] (Linux systems)
[0],[1]...specifies the adapter numbers of the FarSync X.25 cards, which the FTAM protocol in the asynchronous openFT server is attached to in order to accept incoming connections. If no adapter has been selected for the FTAM protocol, the incoming X.25 connections for the FTAM protocol are then not accepted.
No adapter number specified:
-ftamx25lif= resets the setting for the FarSync X.25 cards, on which the incoming connections are to be accepted, i.e. incoming X.25 connections for the FTAM protocol are not accepted.
Default setting following initial installation: -ftamx25lif=0
-ftamx25lnb=number of list calls
The number of list calls per FarSync X.25 card can be specified for the FTAM protocol.
Possible values: 1 to 99
Default setting following initial installation: -ftamx25lnb=5
To enable an incoming connection request to be accepted an application must place at least one list call via the FarSync program interface. If a connection request is made, this is then reported by the list call and the connection is established. However, each list call can only be used for one connection and must therefore be replaced by a new list call. This is done immediately after the connection has been accepted.
However, with a high load it is possible for there to be another connection request precisely in this brief period between the acceptance of an incoming connection and the placing of a new list call. This is rejected by the driver of the FarSync card, as the driver does not in principle buffer any incoming connection requests.
This behavior is stipulated by the design of the FarSync program interface. This problem can be remedied by placing several list calls per adapter. As standard, 5 list calls are placed in each case for each adapter that is configured with the option -ftamx-25lif.
-ftamx25cl=0/- | -ftamx25cl=2/0 | -ftamx25cl=2/2
Specifies for the FTAM protocol which transport class is accepted for incoming connections.
0/-
Transport class 0 is to be used for incoming transport connections. In this case, incoming connections are (if possible) set down to transport class 0. If this is not possible, the connection request is rejected.
2/0
Both transport class 2 and 0 can be used for incoming transport connections.
2/2
Transport class 2 is to be used for incoming transport connections, i.e. only connections with transport class 2 are accepted. Incoming connections with transport class 0 are rejected.
Default setting following initial installation: -ftamx25cl=2/0
-ftamx25nsap=network address of the local FTAM application
You can enter the network address (NSAP) of the local FTAM application here, i.e. for the FTAM protocol. The NSAP is used as follows:
- To identify the sender for a connection setup (Calling NSAP) via the FTAM protocol. If no NSAP is entered, then "Calling NSAP" is not included in outgoing connections.
- To identify the receiver for incoming connections (Called NSAP) via the FTAM protocol.
Please note that an incoming connection is only setup if the "Called NSAP" supplied by the partner matches the NSAP specified NSAP here. If e.g. no NSAP is specified here, the partner may not send a "Called NSAP", either.
Setup and format of the NSAP is identical to the description of the NSAP for the command ftaddptn , option -nsap.
No network address specified
-ftamx25nsap= resets the FTAM protocol's setting for the local NSAP.
Default setting following initial installation: -ftamx25nsap=
Examples
The identification of your own instance is to be set to host.hugo.net:
ftmodo -id=host.hugo.netOnly partners from the partner list are to be permitted:
ftmodo -dp=fFlags the local openFT instance as a remote administration server:
ftmodo -admcs=yOnly the asynchronous inbound servers for the openFT and FTAM protocols are to be activated.
ftmodo -acta=openft,ftamFor directory transfer, the logging of failed transfer requests is to be activated:
ftmodo -ltd=fExamples for the configuration of X.25 lines under Windows:
On the FarSync X.25 adapter number 0 the DTE address 1234 is to be assigned to line number 2.
ftmodo -x25=0:2=1234On the FarSync X.25 adapter number 2 the DTE address 111111 is to be assigned to line 0 and the DTE address 222222 is to be assigned to line 1.
ftmodo -x25=2:0=111111,2:1=222222On the Far Sync X.25 adapter 2 the DTE address stored for line 0 is to be deleted.
ftmodo -x25=2:0=All stored DTE addresses for all lines are to be deleted.
ftmodo -x25=
Examples for the configuration of X.25 lines under Linux:
The DTE address 1234 is to be assigned to FarSync X.25 adapter number 0.
ftmodo -x25=0=1234The DTE address 111111 is to be assigned to FarSync adapter number 2 and the DTE address 222222 is to be assigned to adapter 3.
ftmodo -x25=2=111111,3=222222The DTE address assigned to FarSync X.25 adapter 2 is to be deleted.
ftmodo -x25=2=All stored DTE addresses for all lines are to be deleted.
ftmodo -x25=