Keyword Parameters for Adjacent Node Entries

The network map adjacent node entry contains keyword parameters. The following are the positional parameters for the network map adjacent node entry:

Parameter Description
PARSESS=(max,default) This is an optional parameter that uses two CLASS values for each session between the PNODE and SNODE to define the total number of concurrent sessions or classes defined by the NETMAP entry. Each session is assigned a range of session class values that are obtained from the ADJACENT.NODE entry of the SNODE, which is specified by the PROCESS statement keyword, SNODE. The PARSESS parameter also defines the default Process CLASS value used by the Process when the PROCESS statement does not specify the CLASS keyword.

max specifies the maximum number of simultaneous DTF-to-DTF sessions that the local IBM® Connect:Direct® node can initiate with this adjacent node. The range of this subparameter is 2–255. Each session is represented by a corresponding class value. This class value determines the execution eligibility of a Process. Leave this field blank if parallel sessions are not available.

default specifies the class assigned to a Process if one is not specified on the Process statement or when the Process is submitted. The range of this subparameter is 1-the value coded for parallel sessions. If you do not code this parameter, the node is not parallel session-capable, and the max and default values are set to 1. This parameter is required if you do PNODE=SNODE processing.

PARSESS is evaluated differently on CD/Plex. See below for more detail.

Note: If you do not specifically code the PARSESS parameter on an adjacent node definition, a default of PARSESS=(1,0) is set by the system, which allows only a single session. The default class 0 means no CLASS which shows up as a CLASS of NONE in an executing Process. You cannot code the default PARSESS=(1,0) on an ADJACENT.NODE definition—the minimum value that can be coded is PARSESS=(2,1).

The following formula is a quick way to determine the number of parallel sessions available when class is not defined for a Process (the default class is used): Default Parsess value = (max – default) +1

For CTCA connections, this value is automatically set to 1/2 of the addr-count. Do not try to reset this parameter for CTCA connections.

For best results when using Independent LU6.2, code PARSESS the same for both the local and remote nodes.

Selecting a Class

IBM Connect:Direct selects a class in which a Process is to run by starting with the default class, or the coded class, and proceeds upward in class values until an available class slot is found, or until all possible class values are tested.

For more information on Process class, see the Connect:Direct Process Language help.

For more information about parallel sessions, refer to Building,Modifying, and Submitting Processes Queueing in the IBM Connect:Direct for z/OS User Guide.

CD/Plex Considerations
Since PARSESS is handled as part of Session Establishment, it must be evaluated at the CD/Plex Server rather than the CD/Plex Manager. Therefore, it becomes a Server rather than a Node parameter, even though it is defined at the Node level. For PARSESS to limit sessions with an Adjacent Node, all processes to/from that node should be directed to the same CD/Plex Server using the PLEXCLASS parameter in the Process. Alternately, divide the maximum PARSESS value by the number of CD/Plex Servers to prevent too many processes with that Adjacent Node. Otherwise, each CD/Plex Server will allow the maximum PARSESS number of processes to/from the Adjacent Node. If the Adjacent Node uses a smaller session count, this may result is session rejects by that Adjacent Node. When converting from a Stand Alone environment to a CD/Plex environment, please take this difference into consideration. For example, if using PARSESS=(4,1), each CD/Plex Server can have 4 processes to/from the Adjacent Node. Thus, a CD/Plex with 2 Servers could allow 8 Processes and a CD/Plex with 4 Servers could allow 16 Processes, assuming Processes are not restricted by PLEXCLASS to a specific Server.
ZFBA=(addr,addm)

The ZFBA parameter has no default value; if it is not specified, the node will be ineligible for ZFBA transfers.

The range is specified as a pair of 4-hex-digit device addresses separated by a comma or space; the second value must be greater than the first value. Adjacent.node example defines 4 devices, 2000-2003 as the zFBA device range.
COMPRESS.EXT=ALLOW | DISALLOW | FORCE This is an optional parameter that can be used to control how extended compression will be used on a node.

ALLOW specifies that extended compression may be used. In this case, extended compression may be specified within the Process or by the other node.

DISALLOW specifies that extended compression cannot be used.

FORCE specifies that extended compression is required.
COMPRESS.STD=ALLOW | DISALLOW | FORCE This is an optional parameter that can be used to control how standard compression will be used on a node.

ALLOW specifies that standard compression may be used. Standard compression may be specified within the Process or by the other node.

DISALLOW specifies that standard compression cannot be used.

FORCE specifies that standard compression is required.
COMPRESS.STD.
PRIMECHAR=C'x' | X'xx'
 This is an optional parameter used for text data or single-character repetitive data to specify the primary compression character. It is specified as either two hex digits preceded by “X” or a single character preceded by “C”, for example, COMPRESS.STD.PRIMECHAR=C'$', or this can also be expressed as COMPRESS.STD.PRIMECHAR=X'4B'
Note: If COMPRESS.STD is specified and COMPRESS.STD.PRIMECHAR is not specified, then the Process default for COMPRESS.STD.PRIMECHAR, which is X'40' (an EBCDIC space), will be in effect.
SOURCEIP = IP address If an IPv6 or IPv4 address is required for the network map, this parameter defines the source IP address that is bound to during outbound connection requests. If the SOURCEIP parameter is not specified, the local or default address is bound. The destination address is obtained from the network map. The source port is obtained as assigned by TCP/IP, or through the TCP.SRC.PORTS table. If the address from the SOURCEIP cannot be bound during Process execution, the Process is placed in a TI RE state (Timer Queue Retry Status).
Note:
  • If the network map adjacent node contains a IPv6 address, but IBM Connect:Direct is not enabled to support it, the submit of a Process for that network map entry fails. For information about enabling IBM Connect:Direct for IPv6 support, refer to TCP/IP Addressing.
  • If the address from the SOURCEIP cannot be bound at Process start, the Process is placed in WA or WT state.
SESS.SNODE.MAX = nnn This is an optional parameter that can be used to control the number of concurrent sessions that an adjacent node can initiate as the SNODE. The range for SESS.SNODE.MAX is 1 to 255. The default value is 255. In a IBM Connect:Direct/Plex environment, this parameter controls the number of sessions that an adjacent node can initiate with each IBM Connect:Direct/Plex server.
Note: For use with TCP/IP and LU6.2 only.
LDNS=hostname LDNS is an optional parameter that specifies the host name in the network map adjacent node entry.

If you use this parameter, you can leave the third positional parameter (IP address or alias) blank. You must also specify TCP as the fourth positional parameter (session type).

hostname specifies the host name for this node. The host name length is from 1–256 characters.

To see an example of a long DNS record, see The Network Map in the IBM Connect:Direct for z/OS User Guide.
ENVIRONMENT= operating environment The ENVIRONMENT parameter identifies the adjacent node operating system environment. This parameter is required when the session type positional parameter specifies LU6.2 protocol for i5/OS systems and when one IBM Connect:Direct system (either a IBM Connect:Direct/Plex environment or IBM Connect:Direct/Stand-alone Server) communicates with a IBM Connect:Direct/Plex environment. Other protocols can use it for documentation purposes.

Valid values are: GIS, HPNONSTOP, I5OS, LINUX, OPENVMS, OS400, SELECT, VOS, STRATUS, UNIX, VM, VMS, WINDOWS, and ZOS.

Note: When an OS/390 or z/OS IBM Connect:Direct system communicates with another IBM Connect:Direct system in a IBM Connect:Direct/Plex environment and ENVIRONMENT=ZOS|OS390 is not specified, Process redirection does not function correctly.
LOGMODE=logmode entry name Identifies the VTAM logmode entry that defines the communication protocol for this node.

This parameter is only required for LU6.2 nodes.

It is optional for LU0 connections. If you specify this parameter for LU0 connections, the RUSIZE defined within this LOGMODE is used for any transfer with this node. For a host-to-host transfer, the LOGMODE entry in the VTAM MODETAB of the SNODE determines the RUSIZE. For a host-to-PC transfer, the LOGMODE entry in the host VTAM MODETAB is used.

This parameter is not valid for TCP/IP nodes or CTCA connections.

Refer to Sample VTAM Definitions in the IBM Connect:Direct for z/OS Configuration Guide for information about VTAM definitions.
APPLIDS=(vtam applid1 [,vtam applid2,...] )

or

BATCHAPPLIDS=(batch.
applid1 [,batch.applid2,...] )
TSO.APPLIDS=(tso.applid1
[,tso.applid2,...] )
INTERACTIVE.APPLIDS=
(interactive.applid1
[,interactive.applid2,...] )
CICS.APPLIDS=(cics.applid1
[,cics.applid2,...] )
 The APPLIDS parameter specifies the VTAM APPLIDs that establish a session between the local IBM Connect:Direct SNA LU0 API and the IBM Connect:Direct DTF. APPLIDs are defined on the local nodes adjacent node record for LU0 sessions to this DTF and are defined on the remote nodes adjacent node record for SNA LU0 multi-session signon to those remote DTFs. This parameter is valid only for z/OS and VM/ESA nodes, and the actual VTAM APPLIDs must be defined and active on the VTAM system where the SNA LU0 IUI / API signon is taking place.

To isolate or separate the VTAM pools to specific user interfaces, you can use the following parameters to define special-purpose APPLIDS or just use the APPLIDS parameter itself:

  • BATCH.APPLIDS with the batch user interface
  • INTERACTIVE or TSO APPLIDS with the ISPF user interface
  • CICS.APPLIDS with the CICS user interface
NETID=networkid | servername The NETID parameter specifies the 1–8 character network ID for this node. When a Process starts, the network ID provided at the session start is verified against the network ID in the network map for the adjacent node. If they do not match, the Process is terminated with an error.

For multiple session signons, the network ID of the node signing on is verified against the network map network ID of the node being signed on to. If they do not match, the signon fails.

If this keyword is not coded or the IBM Connect:Direct initialization parameter NETMAP.CHECK is set to NO, the network ID is not checked at Process start or multiple session signon.

For a CTCA connection in a IBM Connect:Direct/Plex environment, this parameter specifies the 1–8 character name of the IBM Connect:Direct/Server.
PNODE.LUS=(luname1 [,luname2,...] ) ) The PNODE.LUS parameter specifies the logical units used by a remote node to initiate a session with this local node. Do not specify the communications name when you use this parameter.

Applies to OpenVMS nodes. It is not valid for CTCA connections.
SNODE.LUS=(luname1 [,luname2,...] ) ) For OpenVMS, the SNODE.LUS parameter specifies the logical unit names used by the local node to initiate a session with this remote node. For all other platforms, it specifies the logical units used for all communications with the remote node.

Communications to nodes that cannot handle parallel sessions can require a pool of logical units. If an adjacent node is defined in its host environment to use more than one logical unit for communications, then each of the logical unit names that can communicate with the local node must be defined to the local node on the corresponding adjacent node network map entry.

HP NonStop and i5/OS adjacent node entries use the SNODE.LUS keyword only to define the LU pool.

OpenVMS nodes assign the logical units in the pool as either ACTIVE, session initiating, PASSIVE, or listening for session requests. This distinction in function is defined to the z/OS node by specifying the ACTIVE logical units with the PNODE.LUS keyword and the PASSIVE logical units with the SNODE.LUS keyword.

This parameter is not valid for CTCA connections.
PNODE.LAST.USED=(mm.dd.yyyy,hh:mm:ss) The date and time the Adjacent Node was last used as the PNODE that is, the Local Node was the SNODE. This parameter is only unloaded by program DGADNTLD if the usage (US) record exists for the Adjacent Node, and the PNODE last used fields in the US record are not binary zeroes.
SNODE.LAST.USED=(mm.dd.yyyy,hh:mm:ss) The date and time the Adjacent Node was last used as the SNODE that is, the Local Node was the PNODE. This parameter is only unloaded by program DGADNTLD if the usage (US) record exists for the Adjacent Node, and the SNODE last used fields in the US record are not binary zeroes.
USE.SERVER.NODE = YES | NO Setting this parameter to YES tells a IBM Connect:Direct/Server to use its CDPLEX.SERVER.NODE initialization parameter as identification when communicating with this adjacent node. If this parameter is set to NO, the IBM Connect:Direct/Server identifies itself to this adjacent node as the same local node as all other members of the IBM Connect:Direct/Plex environment. (See CDPLEX.SERVER.NODE = node name for more information.)

This parameter is required if a remote IBM Connect:Direct system, using NETMAP checking, communicates with more than one IBM Connect:Direct/Server in a IBM Connect:Direct/Plex environment.

This parameter is ignored in a IBM Connect:Direct/Stand-alone Server.
TCPAPI=(port number, IP address) This parameter defines the adjacent node communication address used by an external API that uses TCP to communicate with the node. This value must be the same as the TCP.API.PORTNUM initialization parameter of the node that you are communicating with.

If the adjacent node is an SNA node, include both the port number and IP address.

If the adjacent node is a TCP node, you must supply the port number, but do not need to supply the IP address. If you do not supply the IP address, you must define the IP address in the Adjacent node record. See API Signons for more information.
CRC =(OFF|ON|DEFAULT) Determines if you will perform CRC checking for any TCP/IP Process sending to this node. If overrides are allowed, this parameter enables you to override the CRC setting in the initialization parameters for this node.
Note: Although DEFAULT is an acceptable value, it is the equivalent of not specifying the network map parameter at all and would normally only be seen in the output of the network map file unload when no CRC specification had been supplied previously.
PLEXCLASS= (* | plexclass, * | plexclass) This parameter specifies a default PLEXCLASS for the PNODE (the first parameter) and SNODE (the second parameter). This IBM Connect:Direct/Server checks this PLEXCLASS to determine if it can run the Process. (See the initialization parameter, CDPLEX.PLEXCLASSES = (*,plexclass,…,plexclass), for more information.)

Each PLEXCLASS name is 1–8 characters long. An asterisk (*) is also an acceptable entry, which indicates that the IBM Connect:Direct/Server supports any Process that does not specify a PLEXCLASS, or specifies a PLEXCLASS of ‘*'.
BUFFER.SIZE=V2.buffer override V2.buffer override defines the buffer size for the adjacent node. It is only valid for TCP and CTCA session types. Use it to dynamically override the V2.BUFSIZE value of the local node during TCP buffer size negotiation. This parameter is generally coded to reduce the V2.BUFSIZE value so that IBM Connect:Direct provides less data on each TCP send. Valid values are 3072–2097152 | 3K–2M.
ALTernate.COMMinfo=

(ALTernate.RESTART=YES | NO

ALTernate.DIRection=

BALANCE | TOP,

(ALTernate.ADDRess= | ALTernate.NODEDEF=, ALTernate.PORT=, SOURCEIP=,

.

.

.

 This parameter enables you to specify multiple remote node addresses for NETMAP checking.'
Note: The number of ALT.ADDR parameters can not exceed the maximum length of the Netmap Alternate Address Record.

ALTernate.RESTART indicates if an alternate communications path is considered when a Process must restart.

Note: Do not specify ALT.NODEDEF if you use ALT.RESTART. All alternate communications paths must use ALT.ADDR and the same protocol (all Version 1 or Version 2). For example, if you use ALT.TYPE=SNA, specify all alternate addresses as ALT.TYPE=SNA (Version 1 protocol). Since LU62 and TCP are Version 2 protocols, you can use LU62 or TCP when specifying alternate addresses.
ALTernate.DIRection specifies the direction of the communications paths are selected as the primary path. BALANCE (default) indicates a balanced approach; that is, all current sessions are scanned for this same adjacent node and the least used path is selected as the primary path for the Process. The list is processed forward from there.
Note: BALANCE does not guarantee a truly balancing between all alternate paths. It is simply used to select the first path attempted and the Connect:Direct Process may not necessarily execute on that path. TOP indicates the paths are processed from the top.

ALTernate.ADDRess specifies either a TCP/IP address or an SNA address as appropriate.

If ALT.TYPE=SNA or ALT.TYPE=LU62, ALT.ADDR must be a 1–8 character APPLID. If ALT.TYPE=TCP, ALT.ADDR must be a 15-character IPv4 or 39-character IPv6 TCP/IP address or a 1–256 character LDNS name. This subparameter is required if you do not specify ALTernate.NODEDEF.

ALTernate.NODEDEF specifies an alternate node definition to use for NETMAP checking. This subparameter references another entry in the NETMAP. This subparameter is required if you do not specify ALTernate.ADDRess.

ALTernate.PORT specifies the alternate address port number if the alternate address is TCP/IP. This field is not required. This subparameter defaults to the port of the adjacent node record. If not specified in the adjacent node record, the default is 1364. You can only use this subparameter if ALT.TYPE=TCP.

Note: If ALTernate.DIRection=BALANCE is specified, the value specified for ALTernate.PORT is not used.

SourceIP, which has no short form, specifies an alternate IPv6 or IPv4 address that is bound to during outbound connection requests. The source port is obtained as assigned by TCP/IP, or through the TCP.SRC.PORTS table. If the address from the SOURCEIP cannot be bound during Process execution, the Process is placed in WA or WT state.

If SourceIP is specified for this ADJACENT NODE but not in the ALT.COMM entry, the value specified for the ADJACENT NODE also applies to this ALT.COMM entry.

Note: If the network map adjacent node contains a IPv6 address, but IBM Connect:Direct is not enabled to support it, the submit of a Process for that network map entry fails. For information about enabling Connect:Direct for IPv6 support, refer to TCP/IP Addressing.
ALTernate.COMMinfo=

.

.

.

ALTernate.TYPE=SNA | TCP | LU62, ALTernate.LOGmode=

logmode entry name, ALTernate.USE.OUTbound=Yes | No)

(Continued from previous page)

 ALTernate.TYPE specifies the protocol used for the alternate address. This value defaults to that of the adjacent node record. Valid values are SNA, TCP, LU62. This subparameter is only used with ALTernate.ADDRess. This subparameter is required if you do not specify ALTernate.NODEDEF.

ALTernate.LOGmode specifies an SNA logmode used when ALTernate.TYPE=SNA or LU62. This parameter is required for LU62 if the adjacent node is not defined as LU62.

ALTernate.USE.OUTbound specifies whether the alternate communications path is used for outbound Processes, providing session failover for Processes sent to this adjacent node. Valid values are Yes (default) and No.

For more information on this parameter, refer to Using Alternate Communications Paths.
CDFTP.PLUGIN=”fully qualified installation directory of the IBM Connect:Direct FTP+ Plug-in” IBM Connect:Direct FTP+ for z/OS gets its configuration information about remote systems it connects to from the Netmap.

Configure the CDFTP.PLUGIN parameter in your Netmap to specify where the IBM Connect:Direct FTP+ Plug-in is installed on each remote system that IBM Connect:Direct FTP+ for z/OS connects to.

This parameter is not required when the Netmap entry defines a z/OS system.
CDFTP.TEMPFILE=”fully qualified name of the IBM Connect:Direct FTP+ temporary file” IBM Connect:Direct FTP+ for z/OS gets its configuration information about remote systems it connects to from the Netmap.

Configure the CDFTP.TEMPFILE parameter in your Netmap to specify the fully qualified name of the IBM Connect:Direct FTP+ temporary file for each remote system that IBM Connect:Direct FTP+ for z/OS connects to.

The FTP+ Plug-in creates a temporary file to store the results of a directory command RUNTASK operation.

Note: If no variables are used in the CDFTP.TEMPFILE, then IBM Connect:Direct FTP+ for z/OS appends the job userid and the ASID and CPUID to the CDFTP.TEMPFILE parameter as a further specification of uniqueness.

Several variables are available for substitution in the CDFTP.TEMPFILE specification. These variables are:

  • &userid;—The remote userid (lower case)
  • &USERID;—The remote userid (upper case)
  • &lusrid;—The local userid padded to 8 characters with '$'
  • &lcpuid;—The first 8 bytes of the local CPUID with "C" overlaying the first byte
  • &asid;—The 4 character Address Space ID prefixed with "AS"

For example, you can specify CDFTP.TEMPFILE= with a variable, such as "&userid;". IBM Connect:Direct FTP+ for z/OS inserts the remote userid in place of the “&userid;”.
CONTACT.NAME=”name”

CONTACT.PHONE=”phone information”

DESCRIPTION=”description information”

 These are free-form text parameters, which provide additional general information about an Adjacent Node entry. The CONTACT.NAME and CONTACT.PHONE parameters are limited to a maximum of 40 characters. The DESCRIPTION parameter is limited to a maximum of 255 characters.
FASP = (NO | SSP , NO | SSP) The first positional parameter is used for when this IBM Connect:Direct z/OS Server is the PNODE and the second is for when this IBM Connect:Direct z/OS Server is the SNODE. The default of NO indicates that the FASP via SSP support is globally set to FASP=NO. IBM Connect:Direct Processes should not attempt to use the FASP transport unless overridden by the NETMAP or Process. SSP indicates that the IBM Connect:Direct Processes should request the FASP transport when in session with SSP unless override by the NETMAP or Process.
FASP.BANDWIDTH = nnn | nK | nM | nG

This is an optional FASP configuration parameter that specifies how much bandwidth each transfer can use. The default is taken from the license and is negotiated with the remote to the smaller of the values. The value cannot exceed the value defined in the license and SSP will ensure the smaller is used. This value is represented as number of bits and 1K equals 1000.
FASP.FILESIZE.THRESHOLD = nnn | nK | nM | nG The default of 1G defines the threshold to limit the use of the FASP transport to specific file sizes. If the estimated file size is less than this threshold, IBM Connect:Direct for z/OS will proceed as FASP=NO for that file transfer. This value is represented as number of bytes and 1K equals 1024. The sending IBM Connect:Direct Server will apply the threshold using the PNODE's setting.
FASP.POLICY = FAIR | FIXED | HIGH | LOW This is an optional FASP configuration parameter that specifies the 'fairness' of each transfer. The default is FAIR.