HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs

APING

A password and user ID are required to start the TP, but the password must not be sent in clear text.

If password substitution is not supported on the session, the

aping fails. Otherwise, the password is

sent encrypted.

pwd

Password required to access the partner TP; this parameter is required only if the security parameter is set to

AP_PGM. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces if

the password is shorter than 10 bytes.

user_id

User ID required to access the partner TP; this parameter is required only if the security parameter is set

to AP_SAME or AP_PGM. This is a 10-byte type-AE EBCDIC character string, padded on the right with

EBCDIC spaces if the user ID is shorter than 10 bytes.

dlen

Length of the data string to be sent to the partner LU. (The NOF API application does not need to provide a

data string; the APING TP simply sends a string of zeros of the speciﬁed length.)

consec

Number of consecutive data strings sent to the partner LU during each iteration. The APING TP sends this

number of data strings, each containing the number of bytes speciﬁed by the

dlen parameter. It then requests

either data or a conﬁrmation message from the partner TP, depending on the setting of the echo parameter.

fqplu_name

Fully qualiﬁed network name for the partner LU. This parameter is used only if the plu_alias ﬁeld is set to

8 binary zeros, and is ignored otherwise. This should be the name of an LU on a remote node; you are not

recommended to use APING with a partner LU on the local node.

The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of

up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string

characters.

echo

Speciﬁes whether the APING TP requests data from the partner LU after sending data to it. Possible values

are:

AP_YES

After sending the speciﬁed number of data strings, APING waits to receive data from the partner LU.

AP_NO

After sending the speciﬁed number of data strings, APING requests conﬁrmation from the partner LU,

but does not receive data.

iterations

Number of times that the APING TP should perform the sequence of sending data to the partner LU and

requesting either data or conﬁrmation.

partner_ver_len

Maximum length of the partner TP veriﬁcation data string which can be received by the NOF API application.

The application must supply a VCB large enough to include this string as well as the basic APING VCB

structure, because the string will be appended to the returned VCB.

3.4.3 Returned Parameters: Successful Execution

If the verb executes successfully, APING returns the following parameters: