Note on usage
Function: Modify operating parameters
User group: FT administrator
Alias name: FTMODOPT
Functional description
The MODIFY-FT-OPTIONS command is used to modify one or more operating parameters of the local system. The relationships between the different operating parameters are explained in manual "openFT (BS2000) - Installation and Operation".
After setting up an instance that is not working via the standard host, a host must be configured for this instance using the MODIFY-FT-OPTIONS command. Only then can openFT be started for the first time in this instance. Using MODIFY-FT-OPTIONS, an instance ID which is unique throughout the network must, if necessary, be set before the initial startup.
The MODIFY-FT-OPTIONS command also enables you to do the following:
Activate and deactivate the FT trace function, SNMP traps and console and ADM traps
Control FT logging, monitoring and user data encryption
Format
MODIFY-FT-OPTIONS / FTMODOPT |
PROCESS-LIMIT = *UNCHA NGED / <integer 1..32> / *NONE ,CONNECTION-LIMIT = *UNCHA NGED / <integer 1..255> ,REQUEST-WAIT-LEVEL = *UNCHA NGED ,PACING = *UNCHA NGED ,TRANSPORT-UNIT-SIZE = *UNCHA NGED / <integer 512..65535> ,SECURITY-LEVEL = *UNCHA NGED / *BY-PARTNER-ATTRIBUTES / <integer 1..100> ,PARTNER-CHECK = *UNCHA NGED / *STD / *TRANSPORT-ADDRESS ,TRACE = *UNCHA NGED / *ON / *OFF / *CHANGE-FILES / *PARAMETERS(...) *PARAMETERS(...) SWITCH = *UNCHA NGED / *ON / *OFF / *CHANGE-FILES ,PARTNER-SELECTION = *UNCHA NGED / *ALL / *NONE / list-poss(4): *OPENFT / *FTAM / *FTP / *ADM ,REQUEST-SELECTION = *UNCHA NGED / *ALL / list-poss(2): *ONLY-SYNC / *ONLY-ASYNC / *ONLY-LOCAL / *ONLY-REMOTE ,OPTIONS = *UNCHA NGED / *NONE / list-poss(1): *NO-BULK-DATA ,LOGGING = *UNCHA NGED / *CHANGE-FILES / *SELECT(...) *SELECT(...) TRANSFER-FILE = *UNCHA NGED / *OFF / *ON / *FAILURE ,FTAC = *UNCHA NGED / *ON / *REJECTED / *MODIFICATIONS ,ADM = *UNCHA NGED / *OFF / *ON / *FAILURE/ *MODIFICATIONS ,MAX-INBOUND-REQUEST = *UNCHA NGED ,REQUEST-LIMIT = *UNCHA NGED / <integer 2..32000> ,MAX-REQUEST-LIFETIME = *UNCHA NGED / *UNLIMITED / <integer 1..400> ,SNMP-TRAPS = *UNCHA NGED / *ALL / *NONE / *PARAMETERS(...) *PARAMETERS(...) SUBSYSTEM-STATE = *UNCHA NGED / *OFF / *ON ,FT-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-UNREACHABLE = *UNCHA NGED / *OFF / *ON ,REQUEST-QUEUE-STATE = *UNCHA NGED / *OFF / *ON ,TRANSFER-SUCCESS = *UNCHA NGED / *OFF / *ON ,TRANSFER-FAILURE = *UNCHA NGED / *OFF / *ON ,CONSOLE-TRAPS = *UNCHA NGED / *ALL / *NONE / *PARAMETERS(...) *PARAMETERS(...) SUBSYSTEM-STATE = *UNCHA NGED / *OFF / *ON ,FT-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-UNREACHABLE = *UNCHA NGED / *OFF / *ON ,REQUEST-QUEUE-STATE = *UNCHA NGED / *OFF / *ON ,TRANSFER-SUCCESS = *UNCHA NGED / *OFF / *ON ,TRANSFER-FAILURE = *UNCHA NGED / *OFF / *ON ,HOST-NAME = *UNCHA NGED / <alphanum-name 1..8> ,IDENTIFICATION = *UNCHA NGED / <c-string 1..64 with-low> / <composed-name 1..64> ,KEY-LENGTH = *PARAMETERS (...) *PARAMETERS(...) RSA-PROPOSED = *UNCHA NGED / 0 / 768 / 1024 / 2048 / 3072 / 4096 ,RSA-MINIMUM = *UNCHA NGED / 0 / 768 / 1024 / 2048 / 3072 / 4096 ,AES-MINIMUM = *UNCHA NGED / *NONE / 128 / 256 ,OPENFT-APPLICATION = *UNCHA NGED / *STD / <text 1..24> ,OPENFT-STD = *UNCHA NGED / *STD / <integer 1..65535> ,FTAM-APPLICATION = *UNCHA NGED / *STD / <text 1..40> ,FTP-PORT = *UNCHA NGED / *NONE / *STD / <integer 1..65535> ,DYNAMIC-PARTNERS = *UNCHA NGED / *OFF / *ON ,ADM-PORT = *UNCHA NGED / *STD / <integer 1..65535> ,ACTIVE-APPLICATIONS = *UNCHA NGED / *ALL / *NONE / list-poss(3): *OPENFT / *ADM / *FTP ,ADM-CONNECTION-LIMIT = *UNCHA NGED / <integer 1..255> ,MONITORING = *UNCHA NGED / *ON / *OFF / *PARAMETERS(...) *PARAMETERS(...) SWITCH = *UNCHA NGED / *ON / *OFF ,PARTNER-SELECTION = *UNCHA NGED / *ALL / *NONE / list-poss(3): *OPENFT / *FTAM / *FTP ,REQUEST-SELECTION = *UNCHA NGED / *ALL / list-poss(2): *ONLY-SYNC / *ONLY-ASYNC / *ONLY-LOCAL / *ONLY-REMOTE ,ADM-TRAPS = * UNCHA NGED / *NONE / *PARAMETERS(...) *PARAMETERS(...) DESTINATION = *UNCHA NGED / *NONE / *PARAMETERS(...) *PARAMETERS(...) PARTNER = *UNCHA NGED / <text 1..200 with-low> ,TRANSFER-ADMISSION = *UNCHA NGED / <alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string15..64> / *SECRET ,SELECTION = *UNCHA NGED / *ALL/ *NONE / *PARAMETERS(...) *PARAMETERS(...) ,FT-STATE = *UNCHA NGED / *OFF / *ON ,FT-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-STATE = *UNCHA NGED / *OFF / *ON ,PARTNER-UNREACHABLE = *UNCHA NGED / *OFF / *ON ,REQUEST-QUEUE-STATE = *UNCHA NGED / *OFF / *ON ,TRANSFER-SUCCESS = *UNCHA NGED / *OFF / *ON ,TRANSFER-FAILURE = *UNCHA NGED / *OFF / *ON ,ENCRYPTION-MANDATORY = * UNCHA NGED / *NO / list-poss(2): *INBOUND / *OUTBOUND ,DELETE-LOGGING = * UNCHA NGED / *PARAMETERS(...) *PARAMETERS(...) SWITCH = *UNCHA NGED / *ON / *OFF ,RETENTION-PERIOD = *UNCHA NGED / <integer 0..999 days> ,REPEAT = *UNCHA NGED / *DAILY / *WEEKLY(...) / *MONTHLY(...) *WEEKLY(...) ON = *SU NDAY / *MONDAY / *TUESDAY / *WEDNESDAY / THURSDAY / *FRIDAY / *SATURDAY *MONTHLY(...) ON = 1 / <integer 1..31> ,DELETE-TIME = *UNCHA NGED / <time 1..8> ,RECOVERY-OUTBOUND = * UNCHA NGED / *ON / *OFF ,RECOVERY-INBOUND = * UNCHA NGED / *ON / *OFF |
Operands
PROCESS-LIMIT =
Maximum number of tasks that can be reserved simultaneously for the execution of file transfer requests.
Default setting following installation: 2
PROCESS-LIMIT = *UNCHANGED PROCESS-LIMIT is not changed, default value.
PROCESS-LIMIT = <integer 1..32>
PROCESS-LIMIT can have any value between 1 and 32.
PROCESS-LIMIT = *NONE
A server task is created for each new connection. PROCESS-LIMIT is therefore restricted by CONNECTION-LIMIT.
CONNECTION-LIMIT =
Maximum number of transport connections that can be reserved for the execution of FT requests. This limit does not include file management requests and synchronous requests.The maximum number of transport connections cannot be exceeded, not even if there are many high-priority file transfer requests to be executed. Since only one request can be processed at a time per transport connection, CONNECTION-LIMIT is also the maximum number of requests which a system can process simultaneously. One third of the transport connections defined by CONNECTION-LIMIT are reserved for requests from the remote system, and another third for requests submitted in the local system. The remaining third are available for both local and remote requests. This prevents locally submitted requests from blocking the system against requests from remote systems. If CONNECTION-LIMIT is less than 3, no transport connections are reserved.
Default setting following installation: 16
CONNECTION-LIMIT = *UNCHANGED
The CONNECTION-LIMIT value is not changed, default value.
CONNECTION-LIMIT = <integer 1..255>
CONNECTION-LIMIT can have any value between 1 and 255.
REQUEST-WAIT-LEVEL = *UNCHANGED
The value for REQUEST-WAIT-LEVEL is unchanged.
PACING = *UNCHANGED
This parameter is only supported for reasons of compatibility an cannot be modified.
TRANSPORT-UNIT-SIZE =
Maximum size of a transport unit in bytes.
Default setting following installation: 65535 bytes
TRANSPORT-UNIT-SIZE = *UNCHANGED
The current value size of a transport unit in bytes is unchanged.
TRANSPORT-UNIT-SIZE = <integer 512..65535>
TRANSPORT-UNIT-SIZE can assume any value between 512 and 65535. It is recommended that you use value 65535.
TRANSPORT-UNIT-SIZE does not affect links with FTAM partners.
SECURITY-LEVEL =
This parameter need only be specified when FTAC functionality is used. An important part of the access protection functions provided by this product is based on the allocation of a security level to each partner. These security levels are designated using integers. The FT administrator can define a global value. This security level applies to all partner systems in the partner list that are not explicitly assigned their own security levels when entered.
Default setting following installation: *BY-PARTNER-ATTRIBUTES
SECURITY-LEVEL = *UNCHANGED The security level is unchanged.
SECURITY-LEVEL = *BY-PARTNER-ATTRIBUTES
If you set the operand to *BY-PARTNER-ATTRIBUTES then the security level is defined automatically. This setting assigns partners that are authenticated by openFT the security level 10. Partners that are known in BCAM (i.e. they are addressed via their BCAM names) are assigned the security level 90. All other partners are assigned security level 100.
SECURITY-LEVEL = <integer 1..100>
SECURITY-LEVEL can assume any value between 1 and 100. If FTAC functionality is to be used, remember that 1 is the lowest level of security, offering the least protection. This is sufficient if you do not wish to further differentiate your remote systems; otherwise, a higher value should be defined. The allocation of different security levels is particularly meaningful if the authentication check is activated.
PARTNER-CHECK =
Activates the extended authentication check. When using expanded sender checking, not only the partner identification is checked, but also the transport address. PARTNER-
CHECK only affects named openFT partners that are not authenticated in the local system (see openFT manual "Concepts and Functions").
This option has no meaning for FTAM and FTP partners. For them only the transport address (not the identification) is checked.
The globally set expanded sender checking can be modified for specific partners, see the operand PARTNER-CHECK for the ADD-FT-PARTNER and MODIFY-FT-PARTNER commands.
Default setting following installation: *STD
PARTNER-CHECK = *UNCHANGED The existing value is retained.
PARTNER-CHECK = *STD
If dynamic partners are prohibited (DYNAMIC-PARTNERS=*OFF), a check is performed to determine whether the partner is entered in the partner list as a partner system with his/her instance identification, and only then will the file transfer be allowed.
If dynamic partners are permitted (DYNAMIC-PARTNERS=*ON), transfers are also permitted from partners that are accessed only using their address or are not entered in the partner list at all.
PARTNER-CHECK = *TRANSPORT-ADDRESS
Extended authentication check. In addition to checking whether the partner is entered in its own partner list as a partner system, it is checked whether the transport address under which the partner logs on matches the transport address entered in the partner list for the partner system. In the SHOW-FT-OPTIONS command then PARTNER-CHECK = ADDR is output.
This setting has no significance for dynamic partners and FTAM or FTP partners.
TRACE =
Defines the settings for the FT trace functions.
Default setting following installation: *OFF
TRACE = *UNCHANGED
The existing FT trace functions remain unchanged.
TRACE = *ON
Switches the FT trace functions on.
TRACE = *OFF
Switches the FT trace functions off.
TRACE = *CHANGE-FILES
Switches to a new trace file. This allows a continuous trace to be created across several files to prevent a single trace file from becoming too large.
TRACE = *PARAMETERS(...)
Option that is to be applied when writing the trace.
SWITCH =
Deactivates the FT trace functions for the selected partners.Default setting following installation: *OFF
SWITCH = *UNCHANGED
The previous value is unchanged.
SWITCH = *ON
Activates the FT trace functions.
SWITCH = *OFF
Deactivates the FT trace functions.
SWITCH = *CHANGE-FILES
Switches to a new trace file. This allows a continuous trace to be created across several files to prevent a single trace file from becoming too large.
PARTNER-SELECTION =
Selects the partners that are to be traced. The selection made here can be modified with the TRACE operand of the MODIFY-FT-PARTNER command.
Default setting following installation: *ALL
PARTNER-SELECTION = *UNCHANGED The previous value is unchanged.
PARTNER-SELECTION = *ALL
All the partners are selected for tracing.
PARTNER-SELECTION = *NONE
No partner is selected for tracing. Only those partners are traced which have been selected for tracing with the TRACE operand of the MODIFY-FT-PARTNER command.
PARTNER-SELECTION = *OPENFT
All partners which are addressed via the openFT protocol are selected for tracing.
PARTNER-SELECTION = *FTAM
All partners which are addressed via the FTAM protocol are selected for tracing.
PARTNER-SELECTION = *FTP
All partners which are addressed via the FTP protocol are selected for tracing.
PARTNER-SELECTION = *ADM
All administration partners are selected for tracing.
REQUEST-SELECTION =
Selects the request types that are to be traced.Default setting following installation: *ALL
REQUEST-SELECTION = *UNCHANGED The previous value is unchanged.
REQUEST-SELECTION = *ALL
All the requests are selected for tracing.
REQUEST-SELECTION = *ONLY-SYNC
All synchronous requests are selected for tracing. Synchronous requests are always issued locally.
REQUEST-SELECTION = *ONLY-ASYNC
All asynchronous requests are selected for tracing. Requests issued remotely are always regarded as asynchronous.
REQUEST-SELECTION = *ONLY-LOCAL
All locally submitted requests are selected for tracing.
REQUEST-SELECTION = *ONLY-REMOTE
All remotely submitted requests are selected for tracing.
OPTIONS =
Controls the options for the trace functions.Default setting following installation: *NONE
OPTIONS = *UNCHANGED
The previous value is unchanged.
OPTIONS = *NONE
No options are selected for the trace functions.
OPTIONS = *NO-BULK-DATA
If file contents (bulk data) are transferred with a protocol element and multiple trace records with the same protocol element occur in succession then only the first of these records is written to the trace file. This reduces the volume of the trace file.
LOGGING =
Switches the logging functions.
LOGGING = *UNCHANGED
The existing logging functions remain unchanged.
LOGGING = *CHANGE-FILES
The log file is changed.
The new log file is created under the name SYSLOG.Lyymmdd.Lhhmmss. yymmdd is the date (year, month, day) and hhmmss is the time (hour, minute, second in GMT) on/at which the file was created.
The old log file is closed and remains stored as an offline log file.
LOGGING = *SELECT(...)
Controls logging for FT, FTAC and administration functions.
Default setting following installation: *ON for all types of log records
TRANSFER-FILE = *UNCHANGED
The previous settings for FT logging remain unchanged.
TRANSFER-FILE = *OFF
Switches the FT logging functions off.
TRANSFER-FILE = *ON
Switches the FT logging functions on.
TRANSFER-FILE = *FAILURE
Only failed requests are written to the logging file.
FTAC = *UNCHANGED
The previous settings for FTAC logging remain unchanged.
FTAC = *ON
Switches the FTAC logging functions on.
FTAC = *REJECTED
All requests rejected by FTAC are logged.
FTAC = *MODIFICATIONS
All modifying requests are logged.
ADM = *UNCHANGED
The previous settings for administration logging remain unchanged.
ADM = *OFF
Deactivates administration logging.
ADM = *ON
Activates administration logging.
ADM = *FAILURE
Only failed administration requests are written to the log file.
ADM = *MODIFICATIONS
Only administration requests that modify data are written to the log file.
MAX-INBOUND-REQUEST = *UNCHANGED
MAX-INBOUND-REQUEST is now only supported for reasons of compatibility.
REQUEST-LIMIT =
Changes the number of requests which can be saved in the request queue.
Although it is logically possible to reduce the size of the request queue, this does not result in any memory being freed but only reduces the size of the internal queue. To free memory, it is necessary to end the FT subsystem, delete the request queue (SYSRQF) and then restart openFT.
Default setting following installation: 2000
REQUEST-LIMIT = *UNCHANGED
The previous value remains unchanged.
REQUEST-LIMIT = <integer 2..32000>
The maximum number of requests which can be saved in the request queue is changed to the value specified.
MAX-REQUEST-LIFETIME =
Limits the lifetime of FT requests in the request file. The maximum lifetime applies to inbound and outbound requests and is specified in days. The default value when a new request file is generated is 30 days.
The maximum lifetime does not apply to requests that have been transferred from an earlier request file as part of a version change. Such requests still have to be terminated using the CANCEL-FILE-TRANSFER command.
Default setting following installation: 30 days
MAX-REQUEST-LIFETIME = *UNCHANGED
The previous value remains unchanged.
MAX-REQUEST-LIFETIME = *UNLIMITEDThe lifetime of FT requests is unlimited.
MAX-REQUEST-LIFETIME = <integer 1..400>
The maximum lifetime for FT requests may have a value of between 1 and 400 days.
SNMP-TRAPS =
Activates or deactivates specific SNMP traps. SNMP traps are generated to indicate specific events which are routed by the FT subagent to an SNMP Management Station if one is in use.
Default setting following installation: *NONE
SNMP-TRAPS = *UNCHANGED The previous value is unchanged.
SNMP-TRAPS = *NONEDeactivates all SNMP traps.
SNMP-TRAPS = *ALLActivates all SNMP traps.
SNMP-TRAPS = *PARAMETERS(...)
Activates or deactivates selected SNMP traps. For further information, please refer to manual "openFT (BS2000) - Installation and Operation".
SUBSYSTEM-STATE =
Controls the output of SNMP traps concerning the status of the openFT subsystem.Default setting following installation: *OFF
SUBSYSTEM-STATE = *UNCHANGED The previous value is unchanged.
SUBSYSTEM-STATE = *OFF
No SNMP traps concerning the status of the openFT subsystem are output.
SUBSYSTEM-STATE = *ON
SNMP traps concerning the status of the openFT subsystem are output.
FT-STATE =
Controls trap transmission on START-FT / STOP-FT or abnormal FT termination.Default setting following installation: *OFF
FT-STATE = *UNCHANGED
The previous value is unchanged.
FT-STATE = *OFF
Deactivates the FT-STATE traps.
FT-STATE = *ON
Activates the FT-STATE traps.
PARTNER-STATE =
Controls trap transmission when the status of FT partners changes.Default setting following installation: *OFF
PARTNER-STATE = *UNCHANGED The previous value is unchanged.
PARTNER-STATE = *OFF
Deactivates the PARTNER-STATE traps.
PARTNER-STATE = *ON
Activates the PARTNER-STATE traps.
PARTNER-UNREACHABLE =
Controls transmission of the trap that indicates if a partner cannot be accessed.Default setting following installation: *OFF
PARTNER-UNREACHABLE = *UNCHANGED The previous value is unchanged.
PARTNER-UNREACHABLE = *OFFDeactivates the “partner unreachable” trap.
PARTNER-UNREACHABLE = *ONActivates the “partner unreachable” trap.
REQUEST-QUEUE-STATE =
Controls the transmission of traps when the request queue is more than 85% or less than 80% full.
Default setting following installation: *OFF
REQUEST-QUEUE-STATE = *UNCHANGED The previous value is unchanged.
REQUEST-QUEUE-STATE = *OFFDeactivates the request queue fill level traps.
REQUEST-QUEUE-STATE = *ONActivates the request queue fill level traps.
TRANSFER-SUCCESS =
Controls the transmission of the trap that indicates that an FT request has been successfully concluded.
Default setting following installation: *OFF
TRANSFER-SUCCESS = *UNCHANGED The previous value is unchanged.
TRANSFER-SUCCESS = *OFF
Deactivates the TRANSFER-SUCCESS trap.
TRANSFER-SUCCESS = *ON
Activates the TRANSFER-SUCCESS trap.
TRANSFER-FAILURE =
Controls the transmission of the trap that indicates that an FT request has been aborted.
Default setting following installation: *OFF
TRANSFER-FAILURE = *UNCHANGED The previous value is unchanged.
TRANSFER-FAILURE = *OFF
Deactivates the TRANSFER-FAILURE trap.
TRANSFER-FAILURE = *ON
Activates the TRANSFER-FAILURE trap.
CONSOLE-TRAPS =
Activates or deactivates console traps.
By default, these trap messages are not displayed at the console. However, they are logged in the CONSLOG file.
They can therefore cause storage problems on systems with high request volumes.
By default, the output of console traps is activated.
Default setting following installation: *OFF
CONSOLE-TRAPS = *UNCHANGED The previous value is unchanged.
CONSOLE-TRAPS = *ALL
The FTR03XX console messages are output by openFT. They always appear in the CONSLOG file. However, they are only output to the console if they are explicitly requested using the following command, e.g.:
/MOD-MSG-SUBSCRIPTION ADD-MSG-ID=(FTR0301,FTR0307,FTR0340,FTR0341)
CONSOLE-TRAPS = *NONE
The FTR03XX console messages are not output.
CONSOLE-TRAPS = *PARAMETERS(...)
Explicit specification of the events for which FTR03XX console messages are output.
SUBSYSTEM-STATE =
Controls the output of console messages concerning the status of the openFT subsystems.
Default setting following installation: *OFF
SUBSYSTEM-STATE = *UNCHANGED
The previous value is unchanged.
SUBSYSTEM-STATE = *OFF
No console messages concerning the status of the openFT subsystem are output.
SUBSYSTEM-STATE = *ON
Console messages concerning the status of the openFT subsystem are output.
FT-STATE =
Controls the output of console messages concerning the status of the openFT control process.
Default setting following installation: *OFF
FT-STATE = *UNCHANGED
The previous value is unchanged.
FT-STATE = *OFF
No console messages concerning the status of the openFT control process are output.
FT-STATE = *ON
Console messages concerning the status of the openFT control process are output.
PARTNER-STATE =
Controls the output of console messages concerning the status of the partner systems.Default setting following installation: *OFF
PARTNER-STATE = *UNCHANGED The previous value is unchanged.
PARTNER-STATE = *OFF
No console messages concerning the status of partner systems are output.
PARTNER-STATE = *ON
Console messages concerning the status of partner systems are output.
PARTNER-UNREACHABLE =
Controls the output of console messages if partner systems cannot be accessed.Default setting following installation: *OFF
PARTNER-UNREACHABLE = *UNCHANGED The previous value is unchanged.
PARTNER-UNREACHABLE = *OFF
No console messages are output if partner systems cannot be accessed.
PARTNER-UNREACHABLE = *ON
Console messages are output if partner systems cannot be accessed.
REQUEST-QUEUE-STATE =
Controls the output of console messages concerning the status of the request queue.
Default setting following installation: *OFF
REQUEST-QUEUE-STATE = *UNCHANGED The previous value is unchanged.
REQUEST-QUEUE-STATE = *OFF
No console messages concerning the status of the request queue are output.
REQUEST-QUEUE-STATE = *ON
Console messages concerning the status of the request queue are output.
TRANSFER-SUCCESS =
Controls the output of console messages when a request is terminated successfully.Default setting following installation: *OFF
TRANSFER-SUCCESS = *UNCHANGED The previous value is unchanged.
TRANSFER-SUCCESS = *OFF
No console messages are output if a request is terminated successfully.
TRANSFER-SUCCESS = *ON
Console messages are output if a request is terminated successfully.
TRANSFER-FAILURE =
Controls the output of console messages when a request fails.Default setting following installation: *OFF
TRANSFER-FAILURE = *UNCHANGED The previous value is unchanged.
TRANSFER-FAILURE = *OFF
No console messages are output if a request fails.
TRANSFER-FAILURE = *ON
Console messages are output if a request fails.
HOST-NAME =
For using the openFT instance concept: Here you can set the BCAM host to which the transport system calls are made.
Default setting following installation: *NONE
HOST-NAME = *UNCHANGED
The setting for the BCAM host remains unchanged.
HOST-NAME = <alphanum-name 1..8>
The name of the BCAM host via which the requests are processed. The result of this is that requests of an openFT instance are always processed via the same network address, irrespective of the real host. If an instance is to run on a virtual host, then the host name must be entered here before the first START-FT. Later, the host name should not be changed. It may not be changed if requests are present in the request file of this instance.
IDENTIFICATION =
Local instance ID of your openFT instance. With the aid of this instance ID, openFT partners as of V8.1 manage the resources for your openFT instance.
The instance ID must be unique, network-wide and must not be case-sensitive. An instance ID may consist of alphanumeric characters or special characters and may have a maximum length of 64 characters. It is advisable only to use the special characters “.”, “-”, “:” or “%”. The initial character must be alphanumeric or the special character “%”. The character “%” may only be used as an initial character. The character “.” must be followed by an alphanumeric character. For further details on assigning instance identifications, see section “Instance identifications”.
Default setting following installation: When an instance is installed for the first time, the BCAM name of the real host under which their instance operates is entered as the default setting. If another identification is to be used for operation then this must be configured with MODIFY-FT-OPTIONS.
IDENTIFICATION = *UNCHANGED The instance ID remains unchanged.
IDENTIFICATION = <c-string 1..64 with-low> / <composed-name 1..64>The instance ID is set to this value.
KEY-LENGTH = *PARAMETERS(...)
Configuration of the length of the RSA key and the length of the AES key.
RSA-PROPOSED
Length of the RSA key used for encryption. This key is used only to encrypt the AES key which is agreed on between the partners. openFT uses the AES key to encrypt the request description data and possibly also the file contents.
Default setting following installation: 2048
RSA-PROPOSED = 0Encryption is switched off.
RSA-PROPOSED = 768 / 1024 / 2048 / 3072 / 4096
Length of the RSA key (in bits) that is used for the transfer of the AES key of the session.
RSA-MINIMUM
Minimum length of the RSA key (in bits) accepted by the partner system for the transfer of the AES key for the request initiated by the partner.
Default setting following installation: 0
RSA-MINIMUM = 0
There is no configuration for the minimum length of the RSA key. Every key length is accepted and even requests without encryption can be processed.
RSA-MINIMUM = 768 / 1024 / 2048 / 3072 / 4096
Keys with this minimum length are accepted only. If the initiator uses a shorter key he gets a counter proposal of the responder of the session. A session without encryption will be denied.
AES-MINIMUM
Minimum length of the AES key (in bits) that will be required from the partner system. Default setting following installation: *NONE
AES-MINIMUM = *NONE
There is no configuration for the minimum length of the AES key. Every AES key length and even requests with DES keys are accepted.
AES-MINIMUM = 128 / 256
AES keys with this minimum length are accepted only. If the partner cannot fulfill this requirement the request will be rejected.
OPENFT-APPLICATION =
Specifies a port number and/or a transport selector for the local openFT server. Use this function carefully as it will be more difficult for the openFT partners to address the local system if the port number or transport selector differ from the default values!
Default setting following installation: *STD
OPENFT-APPLICATION = *UNCHANGED The previous value is unchanged.
OPENFT-APPLICATION = *STD
The port number and transport selector are set to the default value, i.e.: Port number: 1100
Transport selector: $FJAM in EBCDIC code, followed by three spaces.
OPENFT-APPLICATION = <text 1..24>
Valid port number and/or a transport selector in the form [<port number>].[tsel].
OPENFT-STD =
Port number other than the default when addressing openFT partners via their host names.Use this function carefully, as changing the port number from the default value means that it will no longer be possible to reach openFT partners which use the default port number and are addressed via the host name!
Default setting following installation: *STD
OPENFT-STD = *UNCHANGED The previous value is unchanged.
OPENFT-STD = *STD
The port number is set to the default value 1100.
OPENFT-STD = <integer 1..65535> Valid port number.
FTAM-APPLICATION =
Specifies a port number other than the default for the local FTAM server. You can also specify a transport selector which differs from the default $FTAM plus a session and presentation selectors.
Use this function carefully, as changing the port number and/or selectors from the default value will make it more difficult for the FTAM partners to address the local system!
Default setting following installation: *STD
FTAM-APPLICATION = *UNCHANGED The previous value is unchanged.
FTAM-APPLICATION = *STD
The port number is set to the default value 4800. The transport selector is reset to the default value $FTAM (in EBCDIC, followed by three blanks). Session and presentation selectors are reset to the empty format.
FTAM-APPLICATION = <text 1..40>
Specifies a valid port number, optionally together with selectors in the format <port number>.[transport selector].[session selector].[presentation selector].
FTP-PORT =
This option allows you to specify the port number used by FTP.Default setting following installation: 21
FTP-PORT = *UNCHANGED
The previous value is unchanged.
FTP-PORT = *NONE
This setting is only supported for reasons of compatibility.
You should use the operand ACTIVE-APPLICATIONS to activate and deactivate the inbound FTP server.
FTP-PORT = *STD
The port number is set to the default value 21.
FTP-PORT = <integer 1..65535> Valid port number.
DYNAMIC-PARTNERS =
Specifies whether dynamic partners are permitted.Default setting following installation: *ON
DYNAMIC-PARTNERS = *UNCHANGED The previous value is unchanged.
DYNAMIC-PARTNERS = *OFF
Dynamic partners are not permitted. This means that it is only possible to access partner systems which are entered in the partner list and are addressed via the partner name. Transfer requests with partners which are not entered in the partner list or are entered in the partner list without a name are not permitted.
DYNAMIC-PARTNERS = *ON
Dynamic partners are permitted. This means that transfer requests are also permitted with partner systems which are not entered in the partner list or only have their address entered there.
ADM-PORT =
This option allows you to specify the port number used for remote administration.Default setting following installation: 11000
ADM-PORT = *UNCHANGED
The previous value is unchanged.
ADM-PORT = *STD
The port number is set to the default value 11000.
ADM-PORT = <integer 1..65535>Specifies a valid port number.
ACTIVE-APPLICATIONS=
This option allows you to activate or deactivate the asynchronous inbound server. Default setting following installation: *OPENFT,*ADM
ACTIVE-APPLICATIONS = *UNCHANGED The previous value is unchanged.
ACTIVE-APPLICATIONS = *ALL
The asynchronous inbound servers for the openFT, ADM and FTP protocols are activated.
ACTIVE-APPLICATIONS = *NONE
The asynchronous inbound servers for the openFT, ADM and FTP protocols are deactivated.
ACTIVE-APPLICATIONS = list-poss(3): *OPENFT / *ADM / *FTP
You can activate the asynchronous inbound servers for specific protocols (openFT, ADM, and/or FTP), by specifying a comma-delimited list of one or more asynchronous inbound servers listed.
The asynchronous inbound servers for the protocol types that are not in the list are then automatically deactivated.
ACTIVE-APPLICATIONS = *OPENFT
Activates the asynchronous inbound server for requests via the openFT protocol.
ACTIVE-APPLICATIONS = *ADM
Activates the asynchronous inbound server for administration requests.
ACTIVE-APPLICATIONS = *FTP
Activates the asynchronous inbound server for requests via the FTP protocol.
ADM-CONNECTION-LIMIT =
This allows you to specify the maximum number of connections for remote administration.Default setting following installation: 8
ADM-CONNECTION-LIMIT = *UNCHANGED The previous value is unchanged.
ADM-CONNECTION-LIMIT = <integer 1..255> You can enter a value between 1 and 255 here.The default value after installation is 8.
MONITORING =
Activates or deactivates the monitoring functions.Default setting following installation: *OFF
MONITORING = *UNCHANGED
The monitoring settings remain unchanged.
MONITORING = *ON
Activates monitoring without changing the filter.
MONITORING = *OFFDeactivates monitoring.
MONITORING = *PARAMETERS(...)
Selects the options that are to be applied to monitoring.
SWITCH =
Activates or deactivates monitoring for the selected partners.Default setting following installation: *OFF
SWITCH = *UNCHANGED
The previous value is unchanged.
SWITCH = *ONActivates monitoring.
SWITCH = *OFFDeactivates monitoring.
PARTNER-SELECTION =
Selects the partners that are to be monitored.Default setting following installation: *ALL
PARTNER-SELECTION = *UNCHANGED The previous value is unchanged.
PARTNER-SELECTION = *ALL
All the partners are selected for monitoring.
PARTNER-SELECTION = *NONE
No partner is selected for monitoring. In this event, only certain monitoring data values are populated, see the section “Description of the monitoring values”.
PARTNER-SELECTION = *OPENFT
All partners which are addressed via the openFT protocol are selected for monitoring.
PARTNER-SELECTION = *FTAM
All partners which are addressed via the FTAM protocol are selected for monitoring.
PARTNER-SELECTION = *FTP
All partners which are addressed via the FTP protocol are selected for monitoring.
REQUEST-SELECTION =
Selects the request types for which monitoring data is to be collected.Default setting following installation: *ALL
REQUEST-SELECTION = *UNCHANGED The previous value is unchanged.
REQUEST-SELECTION = *ALL
All requests are selected for monitoring.
REQUEST-SELECTION = *ONLY-SYNC
All synchronous requests are selected for monitoring. Synchronous requests are always issued locally.
REQUEST-SELECTION = *ONLY-ASYNC
All asynchronous requests are selected for monitoring. Requests issued remotely are always regarded as asynchronous.
REQUEST-SELECTION = *ONLY-LOCAL
All locally submitted requests are selected for monitoring.
REQUEST-SELECTION = *ONLY-REMOTE
All remotely submitted requests are selected for monitoring.
ADM-TRAPS =
Specifies the settings for the ADM trap server and the ADM traps.Default setting following installation: *NONE
ADM-TRAPS = *UNCHANGED
The previous settings remain unchanged.
ADM-TRAPS = *NONE
The ADM trap server is removed from the list, the FTAC transfer admission is deleted and all ADM traps are deactivated.
ADM-TRAPS = *PARAMETERS(...)
Changes the name of the destination, i.e. the ADM trap server and the associated FTAC transfer admission and activates or deactivates selected ADM traps.
DESTINATION =
Here you specify the name of the destination or the ADM trap server together with the corresponding FTAC transfer admission.
Default setting following installation: *NONE
DESTINATION = *UNCHANGED
The name of the ADM trap server and the FTAC transfer admission remain unchanged.
DESTINATION = *NONE
The name of the ADM trap server and the FTAC transfer admission are deleted and thus reset to *NONE.
DESTINATION = *PARAMETERS(...)
Destination to which the ADM traps are to be sent.
PARTNER = *UNCHANGED
The name of the ADM trap server remains unchanged.
PARTNER = <text 1..200 with-low>
Name of the partner system from the partner list or the address of the partner system to which the ADM traps are to be sent. If the partner is not entered in the partner list, it must be specified with the prefix ftadm://, see section “Specifyingpartner addresses”.
TRANSFER-ADMISSION =
FTAC transfer admission for accessing the ADM trap server.
TRANSFER-ADMISSION = *UNCHANGED
The FTAC transfer admission of the ADM trap server remains unchanged.
TRANSFER-ADMISSION = <alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string15..64>
The FTAC functionality is used on the remote system. Only the transfer admission defined in the admission profile may be used.
TRANSFER-ADMISSION = *SECRET
The system prompts you to input the transfer admission. However, this is not visible on the screen.
SELECTION =
Activates or deactivates specific ADM traps. Default setting following installation: *NONE
SELECTION = *UNCHANGED The previous value is unchanged.
SELECTION = *NONE
Deactivates all ADM traps.
SELECTION = *ALLActivates all ADM traps.
SELECTION = *PARAMETERS(...)
Activates or deactivates selected ADM traps.
FT-STATE =
Activates or deactivates the sending of traps on START-FT / STOP-FT and if openFT is terminated abnormally.
Default setting following installation: *OFF
FT-STATE = *UNCHANGED
The previous value is unchanged.
FT-STATE = *OFF
Deactivates the traps for FT-STATE.
FT-STATE = *ON
Activates the traps for FT-STATE.
PARTNER-STATE =
Activates or deactivates the sending of traps when the status of partners changes.Default setting following installation: *OFF
PARTNER-STATE = *UNCHANGED The previous value is unchanged.
PARTNER-STATE = *OFF
Deactivates the traps for PARTNER-STATE.
PARTNER-STATE = *ON
Activates the traps for PARTNER-STATE.
PARTNER-UNREACHABLE =
Activates or deactivates the sending of the trap indicating that a partner is unreachable.
Default setting following installation: *OFF
PARTNER-UNREACHABLE = *UNCHANGED The previous value is unchanged.
PARTNER-UNREACHABLE = *OFFDeactivates the "partner unreachable" trap.
PARTNER-UNREACHABLE = *ONActivates the "partner unreachable" trap.
REQUEST-QUEUE-STATE =
Activates the sending of traps referring to the filling level of the request queue, i.e. whether traps are sent if the filling level has exceeded the 85% threshold or fallen below the 80% threshold.
Default setting following installation: *OFF
REQUEST-QUEUE-STATE = *UNCHANGED The previous value is unchanged.
REQUEST-QUEUE-STATE = *OFF
Deactivates the traps if the filling level falls outside the thresholds.
REQUEST-QUEUE-STATE = *ON
Activates the traps if the filling level falls outside the thresholds.
TRANSFER-SUCCESS =
Activates or deactivates the sending of the trap indicating that an FT request was completed successfully.
Default setting following installation: *OFF
TRANSFER-SUCCESS = *UNCHANGED The previous value is unchanged.
TRANSFER-SUCCESS = *OFF
Deactivates the trap for TRANSFER-SUCCESS.
TRANSFER-SUCCESS = *ON
Activates the trap for TRANSFER-SUCCESS.
TRANSFER-FAILURE =
Activates or deactivates the sending of the trap indicating that an FT request was aborted.
Default setting following installation: *OFF
TRANSFER-FAILURE = *UNCHANGED The previous value is unchanged.
TRANSFER-FAILURE = *OFF
Deactivates the trap for TRANSFER-FAILURE.
TRANSFER-FAILURE = *ON
Activates the trap for TRANSFER-FAILURE.
ENCRYPTION-MANDATORY =
Controls the system-wide obligation for encryption of user data and file and/or directory list attributes. This setting applies for transfer, data management and administration requests.Default setting following installation: *NO
ENCRYPTION-MANDATORY = *UNCHANGED The setting remains unchanged.
ENCRYPTION-MANDATORY = *NO
Deactivates the system-wide obligation for encryption of user data and file and/or directory list attributes. If encryption is required, this must be specified explicitly in the request.
ENCRYPTION-MANDATORY = *INBOUNDActivates the obligation for inbound encryption, i.e.:
Inbound requests must transfer the user data in encrypted form, otherwise they are rejected.
Inbound FTP requests and inbound FTAM requests and are rejected.
ENCRYPTION-MANDATORY = *OUTBOUNDActivates the obligation for outbound encryption, i.e.:
Outbound requests transfer the user data in encrypted form, even if no encryption was called for in the request (e.g. TRANSFER-FILE, program interface, etc.). 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 (SHOW-REMOTE-FILE-ATTRIBUTESFTSHW). However, if the partner system doesn’t support encryption, then the file and/or directory list attributes will be transferred without encryption.
ENCRYPTION-MANDATORY = (*INBOUND,*OUTBOUND)
Activates the obligation for inbound and outbound encryption, i.e. both the statements on inbound encryption and on outbound encryption apply.
DELETE-LOGGING =
Controls the settings for deleting log records.
DELETE-LOGGING = *UNCHANGED
The settings for deleting log records remain unchanged.
DELETE-LOGGING = *PARAMETERS(...)Defines the options for deleting log records.
SWITCH =
Activates or deactivates the automatic deletion of log records.Default setting following installation: *OFF
SWITCH = *UNCHANGED
The automatic deletion of log records remains activated or deactivated.
SWITCH = *ON
Activates the automatic deletion of log records.
SWITCH = *OFF
Deactivates the automatic deletion of log records.
RETENTION-PERIOD =
Specifies the minimum age of the log records for deletion.Default setting following installation: 14 days.
RETENTION-PERIOD = *UNCHANGED The settings remain unchanged.
RETENTION-PERIOD = <integer 0..999 days>
Minimum age of log records for deletion in days. The days are counted back from the deletion time specified in DELETE-TIME. The value 0 deletes all the log records that were written before or at the time of the current day specified in DELETE-TIME.
REPEAT =
Specifies when deletion is to be repeated.Default setting following installation: *DAILY
REPEAT = *UNCHANGED
The settings remain unchanged.
REPEAT = *DAILY
The log records are deleted every day.
REPEAT = *WEEKLY(..)
The log records are deleted once a week.
ON = *SUNDAY / *MONDAY / *TUESDAY / *WEDNESDAY / *THURSDAY /
*FRIDAY / *SATURDAY
Weekday on which the log records are deleted.
REPEAT = *MONTHLY(..)
The log records are deleted once a month.
ON = 1 / <integer 1..31>
Specific day of the month (1-31). If 29, 30 or 31 is specified as the day of the month but the month has fewer days, deletion will take place on the last day of the month.
DELETE-TIME =
Specifies the time at which the log records are to be deleted.Default setting following installation: 00:00
DELETE-TIME = *UNCHANGED The setting remains unchanged.
DELETE-TIME = <time 1..8>
Time (local time at which the log records are to be deleted. Due to the nature of the system, the delete function can be performed up to 5 minutes after this time. You enter the time in the format hh:mm:ss, e.g. 14:30:10.
RECOVERY-OUTBOUND=
Specifies the global restart function for outbound requests.Default setting following installation: *ON
RECOVERY-OUTBOUND= *UNCHANGED
The present restart function setting for outbound requests remains unchanged.
RECOVERY-OUTBOUND=*ON
The restart function for outbound requests is activated for all partner systems for which there is no partner-specific setting.
RECOVERY-OUTBOUND=*OFF
The restart function for outbound requests is deactivated for all partner systems for which there is no partner-specific setting.
RECOVERY-INBOUND=
This operand specifies the global restart function for inbound requests of partner systems which have activated the recovery for outbound requests.
Default setting following installation: *ON
RECOVERY- INBOUND = *UNCHANGED
The present restart function setting for inbound requests remains unchanged.
RECOVERY- INBOUND =*ON
The restart function for inbound requests is globally activated.
RECOVERY- INBOUND =*OFF
The restart function for inbound requests is globally deactivated.
Command return codes
(SC2) | SC1 | Maincode | Meaning |
83 | 32 | CMD0221 | Internal error. |
87 | 32 | CMD0221 | No space left on device for internal files. |
33 | 64 | FTR1033 | The public key files could not be updated. |
35 | 64 | FTR1035 | Command only permissible for FT administrator. |
SC1/2 = Subcode 1/2 in decimal notation For additional information, see section “Command return codes”. | |||
Example
The maximum number of tasks to be executed in parallel is to be 3 and the maximum number of transport connections to be set up is to be 10:
/MODIFY-FT-OPTIONS PROCESS-LIMIT=3,CONNECTION-LIMIT=10