EZBNMIFR parameters

JobName

Supplied and returned parameter.

Type:

Character

Length:

Doubleword

The name of an 8-character field that contains the EBCDIC job name of the target TCP⁄IP stack or TN3270E Telnet server. If the first character of the supplied job name is an asterisk (*), the call is made to the first active TCP⁄IP stack and its job name is returned.

Tips:

You can use the GetTCPListeners request to find all active TN3270E Telnet servers. The returned listener list indicates which application names are TN3270E Telnet server-type applications. Use the results from all TCP⁄IP stacks to determine which TN3270E Telnet servers have affinity to a particular stack and which servers have no affinity.
For the GetFTPDaemonConfig request, you can use the GetTCPListeners request to find all the active FTP daemons. The application data in the returned listener list indicates which applications are FTP daemon applications. See GetFTPDaemonConfig (NWMFTPDConfigType) for more information. Use the results from all TCP/IP stacks to determine which FTP daemons have affinity to a particular stack and which servers have no affinity.

RequestResponseBuffer

Supplied parameter

Type:

Character

Length:

Variable

The name of the storage area that contains an input request. The input request must be in the format of a request header (NWMHeader) as defined in the EZBNMRHA macro or EZBNMRHC header file. On successful completion of the request, the storage will contain an output response in the same format.

Rule: For C/C++ applications, the LANGLVL(EXTENDED) compiler option must be specified because of the definition of anonymous unions in header file EZBNMRHC.

RequestResponseBufferAlet

Supplied parameter.

Type:

Integer

Length:

Fullword

The name of a fullword that contains the ALET of RequestResponseBuffer. If a nonzero ALET is specified, the ALET must represent a valid entry in the caller's dispatchable unit access list (DU-AL).

RequestResponseBufferLength

Supplied parameter.

Type:

Integer

Length:

Fullword

The name of a fullword that contains the length of the request/response buffer. If the buffer length is too short to contain all of the requested information, the request fails with the return code ENOBUFS. The length that is needed to contain all of the information is provided in the NWMHeader data structure of the response, in the NWMBytesNeeded field. If the buffer length is not the minimum size for the request, the request fails with the return code ENOBUFS, but the value that is needed is not provided in the NWMBytesNeeded field. The minimum size is the length of the NWMHeader data structure.

ReturnValue

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBNMIFR service returns one of the following values:

0 or positive, if the request is successful. A value greater than 0 indicates the number of output data bytes copied to the response buffer. See TCP⁄IP NMI response format for additional details about processing request completions.
-1, if the request is not successful.

ReturnCode

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBNMIFR service stores the return code (errno). The EZBNMIFR service returns ReturnCode only if ReturnValue is -1.

ReasonCode

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBNMIFR service stores the reason code (errnojr). The EZBNMIFR service returns ReasonCode only if ReturnValue is -1. ReasonCode further qualifies the ReturnCode value.

Table 1 shows the return codes and reason codes that the EZBNMIFR service sets.

Table 1. EZBNMIFR service return codes and reason codes
ReturnValue	ReturnCode	ReasonCode	Meaning
0	0	0	The request was successful.
-1	ENOBUFS	JRBuffTooSmall	The request was not successful. The request/response buffer is too small to contain all of the requested information. Some of the requested information might be returned. If the buffer was large enough for some information to be returned, the NWMHeader NWMBytesNeeded field might contain the buffer size needed to return all of the requested information. See the description of the RequestResponseBufferLength parameter for an explanation of when the NWMBytesNeeded value is provided.
-1	EACCES	JRSAFNotAuthorized	The request was not successful. The caller is not authorized. For the DropConnection request, this might be returned if the user is not permitted to the MVS™.VARY.TCPIP.DROP security profile in the OPERCMDS class.
-1	EAGAIN	JRTCPNOTUP	The request was not successful. The target TCP⁄IP stack or TN3270E Telnet server was not active.
-1	EAGAIN	JRMustBeSysplex	The request was not successful. The target TCP/IP stack has not joined a sysplex.
-1	EFAULT	JRReadUserStorageFailed	The request was not successful. A program check occurred while copying input parameters, or while copying input data from the request/response buffer.
-1	EFAULT	JRWriteUserStorageFailed	The request was not successful. A program check occurred while copying output parameters, or while copying output data to the request/response buffer.
-1	EINVAL	JRInvalidValue	The request was not successful. A value that is not valid was specified in the request/response header.
-1	EINVAL	JRInvalidFilter	The request was not successful. A filter specified is not valid. This ReasonCode is set only by the GetFTPDaemonConfig request. This request requires one input filter that contains the ASID of the FTP daemon address space.
-1	ETCPERR	JRTcpError	The request was not successful. An unexpected error occurred.

Network management applications can use any of the following methods to invoke the EZBNMIFR service:

Issue a LOAD macro to obtain the EZBNMIFR service entry point address, and then CALL that address. The EZBNMIFR load module must be in a linklist data set (for example, the SEZALOAD load library of TCP⁄IP), or in the LPA.
Issue a LINK macro to invoke the EZBNMIFR service. The EZBNMIFR load module must be in a linklist data set (for example, the SEZALOAD load library of TCP⁄IP), or in the LPA.
Link-edit EZBNMIFR directly into the application load module, and then CALL the EZBNMIFR service. Include SYS1.CSSLIB(EZBNMIFR) in the application load module link-edit.
For 64-bit C/C++ applications, link-edit the EZBNMIF4 program directly into the application load module, and then invoke NWMServices. Include SYS1.CSSLIB(EZBNMIF4) in the application load module link-edit.