Node Definition Parameters

Valid values are YES andNO. The default value is to let the GLOBAL ACCEPT_VERIFIED_USER parameter determine if verified users are allowed.

The following logic is performed:

If this is a TCP request, issues a socket call to get the IP name associated with the IP address. Scans through the node definition looking for a match on the IP address, IP name or LU name.

• If a match is found, then the node associated with the incoming request is found.
• If no match is found, scans through the node definition looking for a match on the backup IP address, backup IP name or backup LU name.
  • If there is a match, then the node associated with the incoming request has been found.
  • If there is no match on these fields, then a node is not associated with the incoming request. If the GLOBAL configuration is set to require a node on incoming requests, the request fails.

This parameter applies to these Platform Server interfaces: batch, script, API, REXX and ISPF.

Valid values are:

• YES: TCP and SNA transfer requests are accepted. This is the default value.
• NO: TCP and SNA transfer requests are not accepted. Only requests initiated on the same server and scheduled through cross memory are accepted.
• LOGON: Requests are only accepted when local credentials are included with the transfer schedule request.

This parameter applies to these Platform Server interfaces: batch, script, API, REXX and ISPF. Management requests are typically ISPF or REXX transfer inquiry.

• YES: TCP and SNA management requests are accepted. This is the default value.
• NO: TCP and SNA management requests are not accepted. Only requests initiated on the same server and scheduled through cross memory are accepted.

This parameter is ignored when the GLOBAL AUTOENABLE parameter is set to NO.

Valid values are:

• YES: The member is enabled at startup. This is the default value.
• NO: The member is not enabled at startup.

Up to 5 backup LU name, backup IP address or backup IP name definitions can be defined for a single node definition. You can switch between SNA and IP backup definitions.

For an example of BACKUPLUNAME, see the SNANODE and TCPNODE members in the SAMPLIB dataset.

Defines the SNA mode name used as a backup in case the transfer request to the primary node definition or previously defined backup definitions fails with a network error.

This parameter overrides the SNA mode name for the previous BACKUPLUNAME definition. This mode name becomes the default mode name for all future BACKUPLUNAME definitions within this node definition.

For an example of BACKUPMODENAME, see the SNANODE and TCPNODE members in the SAMPLIB dataset.

Up to 5 backup LU name, backup IP address or backup IP name definitions can be defined for a single node definition. You can switch between SNA and IP backup definitions.

For an example of BACKUPIPADDR, see the SNANODE and TCPNODE members in the SAMPLIB dataset.

Up to 5 backup LU name, backup IP address or backup IP name definitions can be made for a single node definition. You can switch between SNA and IP backup definitions.

For an example of BACKUPIPNAME, see the SNANODE and TCPNODE members in the SAMPLIB dataset.

Defines the IP port that is used as a backup in case the transfer request to the primary node definition or previously defined backup definitions fails with a network error.

For an example of BACKUPIPPORT, see the SNANODE and TCPNODE members in the SAMPLIB dataset.

The parameter must be specified in kilobytes or megabytes. Therefore, the letter K or M must be the last character in this argument. Valid values can be up to 999999999.

For example, to specify the value of 2 million bytes, you can specify 2M or 2000K.

This parameter must be specified in kilobytes or megabytes. Therefore, the letter K or M must be the last character in this argument. Valid values can be up to 999999999.

For example, to specify the value of 2 million, you can specify 2M or 2000K.

This parameter must be specified in kilobytes or megabytes. Therefore, the letter K or M must be the last character in this argument. Valid values can be up to 999999999.

For example, to specify the value of 2 million bytes, you can specify 2M or 2000K.

The parameter must be specified in kilobytes or megabytes. Therefore, the letter K or M must be the last character in this argument. Valid values can be up to 999999999.

For example, to specify the value of 2 million, you can specify 2M or 2000K.

The parameter must be specified in kilobytes or megabytes. Therefore, the letter K or M must be the last character in this argument. Valid values can be up to 999999999.

For example, to specify the value of 2 million, you can specify 2M or 2000K.

The Command Center user must still be validated before they can use the Command Center functions.

• ALL: NODE, PROFILE, AUDIT, PING, and TRANSFER functions are supported on this node.
• NONE: No Command Center function is supported on this node. This is the default value.
• NODE: Node list and update functions are supported on this node.
• PROFILE: Profile list and update functions are supported on this node.
• AUDIT: Requests that inquire on the Platform Server audit file are supported on this node.
• ALTER: Requests that alter transfers in the Platform Server inactive queue are supported on this node.
• PING: Platform Server PING requests are supported on this node.
• TRANSFER: The Command Center transfer function that initiates file transfers is supported on this node.

In SNA communication, this parameter limits the number of incoming sessions that can be created by the remote system.

For TCP Communication, this parameter defines the maximum number of Responder requests that will be accepted from the source system. If the number of concurrent requests exceeds this number, the request will be rejected. The source system will treat this as a retry-able error and will attempt a retry if the number of tries has not been reached.

Valid values are from 0 to 256. The default value 0 means unlimited.

Likewise, this parameter can limit the number of simultaneous scripts that can be executed. Separate counters are maintained for transfers and scripts. Therefore, you can have a number of scripts and transfers executing at the same time for a defined node.

Valid values are from 0 to 256. The default value is 5.

• YES: Performs CRC checking by default
• NO: Does not perform CRC checking by default. The default value is NO.

The CRCCHECK parameter on the Node and batch parameters overrides the Global CRCCHECK settings.

By specifying this parameter, all requests can take a checkpoint restart. Valid values are NO or a number from 1 to 999. The default value NO means not to take checkpoints. Transfers that do not use checkpoint restart start from the beginning of the file.

Valid values are:

• YES: Uses RLE compression for SAPI requests.
• NO: Does not use compression for SAPI requests. This is the default value.
• RLE: Uses RLE compression for SAPI requests.
• LZ: Uses LZ compression for SAPI requests.
• ZLIB1 to ZLIB9: Uses ZLIB Compression for SAPI requests.
• NEVER: Never uses compression.

This parameter can be overridden by entering the COSNAME parameter on the Platform Server batch interface. This name must match a COS entry that is enabled at startup or by the ENABLE operator command. The default value for this parameter is the COS entry called COSDFLT.

This parameter is only used for initiator requests when you do not enter the CRLF parameter.

Valid values are:

• YES | CRLF: Records are delimited by Carriage Return/Line Feed (typically PC based systems).
• LF: Records are delimited by Line Feeds (typically UNIX based systems).
• NO: No record delimiters are used in the file. This is the default value.

If specified, this parameter overrides the ENCRYPT parameter specified in the GLOBAL member.

Valid values are:

• NONE: No encryption
• AES: AES 256-bit encryption
• AES128: AES 128-bit encryption
• DES: DES encryption
• 3DES: Triple DES encryption
• BF | BLOWFISH: Blowfish 56-bit encryption
• BFL | BLOWFISH_LONG: Blowfish 448-bit encryption
• RJ | RIJNDAEL: Rijndael 256-bit encryption
• NEVER: No encryption. Even if you override the ENCRYPT option in the batch interface, encryption is turned off for this node.

If the PASSONLY operand is used, then only the password is encrypted using the encryption algorithm specified. The data is not to be encrypted.

For more information, see the Authentication, Encryption, Compression and Email sections of TIBCO® Managed File Transfer Platform Server for z/OS User's Guide.

Translation tables are defined in the CONFIG DD. They can be enabled at startup or through the ENABLE operator command.

Valid values are:

• local_ translation_table_name: Translation table name must be from 1 to 16 characters.
• NONE|NULL: No conversion takes place. This is the default value.

The LOCALCTFILE parameter on the file transfer request overrides the DEFAULT_LOCALCTFILE parameter.

To use z/OS Unicode Conversion Services, the following format of this parameter is required.

LOCALCTFILE=CC:xxxxx:yyyyy

Where:

xxxxx defines the CCSID of the Local data - usually the EBCDIC CCSID.

yyyyy defines the CCSID of the Remote data - usually the ASCII CCSID

For information on the CCSID values to use, see the IBM manual: z/OS Unicode Services User's Guide and Reference.

Example: LOCALCTFILE=CC:01140:01208

• For a Send Request, this parameter converts data from EBCDIC CCSID 1140 to ASCII UTF-8 CCSID 01208.
• For a Receive Request, this parameter converts data from ASCII UTF-8 CCSID 01208 to EBCDIC CCSID 1140.

When using this parameter, set the following parameter so that the partner does NOT perform any conversion:

REMOTECTFILE=NULL

This parameter is required when communicating with a Windows system, and defines the domain where the user ID validated by Windows is located. It has no default value.

Valid values are from 0 to 255. The default value 0 means that node class processing is not turned on for this node. By setting this parameter to a non-zero value, node class processing is turned on for this node.

If the transfer request has a node class of 0, the DEFAULT_NODECLASS value replaces the NODECLASS defined for the request. DEFAULT_NODECLASS can never be set to a value higher than the CONTENTION_WINNERS parameter.

When the Platform Server NODECLASS facility is turned on, the Platform Server assigns a NODECLASS value to every possible connection. Each of the node classes represents one session.

If you define 6 winners, then the Platform Server creates 6 node classes: 1, 2, 3, 4, 5, and 6. A transfer can run at the assigned node class or a node class with a higher number. For example, a transfer defined with NODECLASS=3 can run in class 3, 4, 5 or 6.

Remote translation tables must be defined on the remote Platform Server node. Valid values are NONE or a translation table name of 1 to 16 characters. The default value NONE indicates that no conversion takes place.

This parameter is used when TYPE=TEXT is defined and is ignored when TYPE=BINARY is specified. The

The REMOTECTFILE parameter on the file transfer request overrides the DEFAULT_REMOTECTFILE parameter.

To use z/OS Unicode Conversion Services, the following format of this parameter is required.

REMOTECTFILE=CC:xxxxx:yyyyy

Where:

xxxxx defines the CCSID of the Local data - that is, z/OS data read or written to disk.

yyyyy defines the CCSID of the Remote data - that is, data sent to or received from a partner

For information on the CCSID values to use, see the IBM manual: z/OS Unicode Services User's Guide and Reference.

• For a Send Request (that is, Read), xxxxx is the Source CCSID and yyyyy is the target CCSID.
• For a Receive Request, (that is, Write), yyyyy is the Source CCSID and xxxxx is the target CCSID.

When using this parameter, set the following parameter so that the local system does NOT perform any conversion:

LOCALCTFILE=NULL

If this parameter is not defined, then a user profile must be defined for this node and the user associated with the started task. This parameter is typically used together with the DEFAULT_USERID parameter. It has no default value.

This parameter is only used for initiator requests when the file transfer type is not entered.

Valid values are:

• TEXT: ASCII/EBCDIC conversion takes place.
• BINARY: No conversion takes place.
• DATA: The file to be created must be a data file, as opposed to a source file. This option must be used only to communicate with AS/400 systems.

If this parameter is not defined, then a user profile must be defined for this node and the user associated with the started task. This parameter is typically used together with the DEFAULT_PASSWORD parameter. It has no default value.

This parameter is meant for documentation purposes only, and does not change how file transfers run. This description is displayed on the ISPF node detailed display menu.

Valid values are YES andNO. The default value is NO.

This parameter is used in conjunction with the WAIT_FOR_SESSION parameter, so the users on mainframe can queue up transactions for remote systems that are not connected and have the Platform Server wait for that system to connect before dispatching the transfers.

You have to separate multiple email addresses by a semicolon (;). The maximum field length is 64 characters including any semicolons.

As an alternative, an email distribution list defined in the organization's email system might be used to specify multiple email addresses to receive this notification. This parameter has no default value, which means that no email notification takes place when a request fails.

You have to separate multiple email addresses by a semicolon (;). The maximum field length is 64 characters including any semicolons.

As an alternative, an email distribution list defined in the organization's email system might be used to specify multiple email addresses to receive this notification. This parameter has no default value, which means that no email notification takes place when a request succeeds.

Valid values are:

• NONE: No email notification is sent. This is the default value.
• INITIATOR: An email notification is sent for initiator requests.
• RESPONDER: An email notification is sent for responder requests.
• BOTH: An email notification is sent for initiator and responder requests.

Valid values are:

• FIPS140: FIPS 140 security policy.
• HIPAA: HIAA standards. The standards require all file transfers to use encryption key length that is 128 bits or greater. This checking takes place for both initiator and responder requests.
• NO: No security policy. This is the default value.

Defines the maximum number of times that a file transfer is tried when temporary file errors occur. This parameter overrides the Global FILE_ERROR_TRY_COUNT parameter for transfers initiated to this node. Valid values are from 1 to 9999.

The default value is 0. Using the default value means that the Global value is used.

Defines the amount of time in seconds that a request waits after a retry-able file error and before the request is retried. This parameter overrides the Global FILE_ERROR_TRY_INTERVAL parameter for transfers initiated to this node.

The default value is 0. Valid values are from 10 to 9999. Using the default value means that the Global value is used.

The actual interval can be up to 60 seconds or more than the value specified, depending on when the error occurs and when the dispatcher runs.

Valid values are:

• YES: Initiator requests for this node are not executed. This parameter can be reset through the ISPF NODE panel, the FUSNODE INITREL REXX exec or the INITREL operator command.
• NO: Initiator requests for this node are executed. Nodes can be placed in an INITHOLD state through the ISPF NODE panel, the FUSNODE INITHOLD REXX exec or the INITHOLD operator command. This is the default value.

Each time an initiator request fails with a remote nonrecoverable error, the count is increased by one. When the count exceeds the value defined for this parameter, the node is placed in an INITHOLD state.

Each time a successful initiator request is performed with this node, the counter is reset. The default value of 0 indicates that the node is not placed into an INITHOLD state due to remote errors.

This parameter is mutually exclusive with IPNAME. In TCP/IP transfers, either IPNAME or IPADDR must be defined. In VTAM transfers, LU_NAME must be defined.

This name can contain up to 64 characters. For example, JohnD.XYZ.COM.

This parameter is mutually exclusive with IPADDR. In TCP/IP transfers, either IPNAME or IPADDR must be defined. In VTAM transfers, LU_NAME must be defined.

Valid values are from 0 to 65535. The default value is 46464. A value of 0 indicates that the Platform Server for z/OS must use the value defined in the GLOBAL TCPIPPORT parameter.

The logical unit handles and enforces the protocols required for user-to-user communications. This parameter is mutually exclusive with the IPNAME and IPADDR parameters.

You must define a VTAM mode entry. For an example, see the Platform Server sample library.

Valid values are $MQ:MQ_Message_Queue_Name:Message_Queue_Name. $MQ is a literal and must be the first three characters. The message queue name must be from 1 to 55 characters.

This parameter has no default value, which means that no MQ notification takes place when a request fails.

Valid values are $MQ:MQ_Message_Queue_Name:Message_Queue_Name. $MQ is a literal and must be the first three characters. The message queue name must be from 1 to 55 characters.

This parameter has no default value, which means that no MQ notification takes place when a request is successful.

Valid values are:

• NONE: No MQ notification is sent. This is the default value.
• INITIATOR: MQ notification is sent for initiator tasks.
• RESPONDER: MQ notification is sent for responder tasks.
• BOTH: MQ notification is sent for both initiator and responder tasks.

Valid values can be from 1 to 32 characters and cannot have any embedded spaces.

If this parameter is defined, then transfers must use this node name in transfers defined to use the NODE parameter.

If this parameter is not defined, the 1 to 8 character member name is used as the node name.

Valid values are NO andYES.

• If this LU is used with an independent local LU, and parallel sessions are used, you can keep the default value YES.
• If this LU is used with a dependent local APPC LU, you can specify NO.

This parameter can also be specified along with CONTENTION_WINNERS for TCP nodes to limit the amount of requests that can be initiated by a TCP node.

This parameter is for information purposes only. It has no default value. Valid values are WINDOWS, AIX, HPUX, SUN, ZOS, AS400, LINUX, or MFT Platform ServerCC.

Valid values are:

• YES: Responder requests for this node are rejected with a recoverable error. The RESPHOLD can be reset through the ISPF NODE panel, the FUSNODE RESPREL REXX exec or the RESPREL operator command.
• NO: Responder requests for this node are accepted. Nodes can be placed in RESPHOLD state through the ISPF NODE panel, the FUSNODE RESPHOLD REXX exec or the RESPHOLD operator command. This is the default value.

Valid values are:

• YES: Requires responder profiles.
• NO: Does not require responder profiles. This is the default value.
• DUAL: Responder profiles are checked. If no matches are found within the responder profile, the request can continue to be processed, and the user ID and password are checked against the RACF or ACF2 or Top Secret security system.

Valid values can be up to 8 JES SYSOUT classes.

If this parameter is not defined, SYSOUT class is not included as a selection filter on SAPI requests. If this parameter is defined, only jobs written to one of the specified SYSOUT classes are selected by the Platform Server.

It is very important that CLASS be the only selection criteria defined, because all output for that class are selected for transmission to a remote node. This parameter can be combined with the other SAPI selection filters to limit the output that is selected.

If this parameter is not defined, destination is not used as a filter for SAPI requests. If this parameter is defined, only jobs written to the specified JES destination are selected by the Platform Server.

This parameter can be combined with the other SAPI selection filters to limit the output that is selected.

Three subparameters are supported. The three subparameters are used to define the actions that can be taken when a transfer request is completed and is about to be removed from the request queue. The three subparameters define respectively the following scenarios:

• Successful file transfers
• Permanent network errors
• Transfer errors

For each subparameter, you can specify the following values:

• HOLD: Output is kept and put on the JES HOLD queue.
• KEEP: Output is kept and can be selected by the Platform Server later.
• DELETE: Output is deleted from the JES queue.

The default value for this parameter is DELETE,KEEP,HOLD indicating that SYSOUT data is deleted after a successful transfer, is kept if a transfer ends due to a permanent network error, or is put on hold when a permanent error occurs.

If this field is not defined, form is not used as a filter for SAPI requests. If SAPI_FORM is defined, only jobs specifying the JES form are selected by the Platform Server.

This parameter can be combined with the other SAPI selection filters to limit the output that is selected.

The same substitutable parameters are supported as are supported by the SAPI_REMOTE_FILE parameter. However, typically the printer name is hard coded and does not use substitutable parameters.

For more information on usage of the substitutable parameters, see SAPI_REMOTE_FILE.

This means that the SAPI transfer request is sent to a file on the remote system, instead of to a printer.

To make the remote file name unique, the Platform Server supports a variety of substitutable parameters that can be specified within the remote file name. The substitutable parameters all begin with a percent sign (%) and ends with one of these characters: period (.), forward slash (/), back slash (\), brackets(( )), or apostrophe (').

When a substitutable parameter is followed by a period (.), the period is removed. If you want a period to follow the parameter, you must specify two periods.

Substitutable parameters are also terminated at the end of the remote file name. You can specify the start and length of a substitutable parameter by following the parameter with (SS.LL). SS defines the start byte relative to 1, and LL defines the length of the parameter.

The following are the supported substitutable parameters:

• %JOBN: Name of the SAPI job
• %JOBID: Job ID of the SAPI job
• %JDATE: Current Julian date in the format YYDDD
• %JDATEC: Current Julian date in the format CCYYDDD
• %GDATE: Current Gregorian date in the format YYMMDD
• %GDATEC: Current Gregorian date in the format CCYYMMDD
• %TIME: Current time in the format HHMMSST
• %DEST: JES destination of a SAPI request. If a destination is not defined for a request, then default value LOCAL or DEST is used.

See the following two examples for your reference:

• SAPI_REMOTE_FILE=C:\PRINT\%JOBN..%JOBID..%GDATEC..T%TIME

  can be translated to

  SAPI_REMOTE_FILE=C:\PRINT\ACCTJOB.JOB01000.20011231.T1205001.
• SAPI_REMOTE_FILE=C:\PRINT\report%TRN(9.2).txt

  can be translated to

  SAPI_REMOTE_FILE=C:\PRINT\report01.txt.

This parameter has no default value. If this parameter is not defined, then the GLOBAL DEFAULT_TRY_COUNT is used to define the number of times the request can be tried.

If this parameter is not defined, writer is not used as a filter for SAPI requests. If this parameter is defined, only jobs specifying the JES writer are selected.

This parameter can be combined with the other SAPI selection filters to limit the output that is selected.

• YES: TLS is used. A TLS Connection will be established to verify the client and server. After creating a secure TLS connection, a symmetric encryption key will be transmitted from the client to the server and the SS/TLS connection will be broken.
• NO: No SSL/TLS connection is created.
• TUNNEL: All data transmitted is sent over an encrypted TLS Tunnel.

This parameter is used for initiator (outgoing) requests only. TLS/SSL usage on responder (incoming) requests depends on the IP port on which the request is received. This parameter overrides any default values set by the GLOBAL definitions.

When initiating a connection request, the Platform Server can bind the connection to a particular IP address. This parameter overrides the adapter IP address.

This parameter applies only when the connection is for an IPv4 address or an IP name.

• If this parameter is defined, TCP binds to the IP address defined by this parameter.
• If this parameter is not defined, TCP binds to the adapter IP address specified in the GLOBAL TCPCONNECT_IPADDR_IPV4 parameter.
• If this parameter is not defined and the GLOBAL TCPCONNECT_IPADDR_IPV4 parameter is not defined, TCP binds to all adapters.

When initiating a connection request, the Platform Server can bind the connection to a particular IPv6 address. This parameter can be used to override the adapter IPv6 address.

• If this parameter is defined, TCP binds to the IPv6 address defined by this parameter.
• If this parameter is not defined, TCP binds to the adapter IP address specified in the GLOBAL TCPCONNECT_IPADDR_IPV6 parameter.
• If this parameter is not defined and the GLOBAL TCPCONNECT_IPADDR_IPV6 parameter is not defined, TCP binds to all adapters.

Valid values are:

• YES: Traps are sent for all transfers which are completed either successfully or unsuccessfully.
• NO: Traps are not sent. This is the default value.
• ERRORS: Traps are sent when a request is unsuccessful and cannot be retried.