Print Test Book Edition 3 HP 9000 Networking Manufacturing Part Number: B5736-90020 E0601 United States © Copyright 2001 © Hewlett-Packard Company, 2001. All rights reserved.
Legal Notices The information in this document is subject to change without notice. Hewlett-Packard makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be held liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance, or use of this material. Warranty.
California. ©copyright 1980, 1984, 1986 Novell, Inc. ©copyright 1986-1992 Sun Microsystems, Inc. ©copyright 1985-86, 1988 Massachusetts Institute of Technology. ©copyright 1989-93 The Open Software Foundation, Inc. ©copyright 1986 Digital Equipment Corporation. ©copyright 1990 Motorola, Inc.
Contents 1. Introduction to the NOF API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purpose of the NOF API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Node Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Domain Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents NOF Status Indications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 2. Writing NOF Applications Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Description of the NOF API Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Synchronous Entry Point: nof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Activation Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ADD_BACKUP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_CN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents DEFINE_DLC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . .
Contents Default LUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_LS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_RJE_WKSTN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_TP_LOAD_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_CPIC_SIDE_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . .
Contents DELETE_DSPU_TEMPLATE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . .
Contents Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_LU62_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_PARTNER_LU . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_TN3270_ASSOCIATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INITIALIZE_SESSION_LIMIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_ACTIVE_TRANSACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . .
Contents State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_CN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_CPIC_SIDE_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_DIRECTORY_STATS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Function Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_DLUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_LS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Function Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_MDS_STATISTICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents QUERY_NODE_ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . .
Contents QUERY_RCF_ACCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Function Not Supported . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_TP_LOAD_INFO. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996 Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997 Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999 Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999 Returned Parameters: Other Conditions. .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET_GLOBAL_LOG_TYPE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET_TRACE_TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TERM_NODE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents DOWNSTREAM_PU_INDICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FOCAL_POINT_INDICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . .
Contents Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SESSION_INDICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SNA_NET_INDICATION . .
Preface HP-UX SNAplus2 NOF Programmers Guide contains the information required to develop C-language application programs that use the Node Operator Facility (NOF) API to manage SNAplus2 resources. SNAplus2 is a software product that enables a server running HP-UX to exchange information with other nodes on an SNA network. The guide provides detailed reference information for experienced NOF programmers. This guide applies to Release 6 of SNAplus2.
Prerequisite Knowledge Before reading this manual, you should have a knowledge of the following subjects: • SNA and APPN concepts (see “Related Publications”) • The C compiler cc • HP-UX version 10.
Organization of This Book This book is organized as follows: Chapter 1, “Introduction to the NOF API.” Provides an overview of the SNAplus2 NOF API and the functions it provides. Chapter 2, “Writing NOF Applications.” Contains general information a programmer needs when writing NOF applications and information about compiling and linking the applications. Chapter 3, “NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE).” Provides a detailed description of the NOF verbs, including parameters and return codes.
Typographic Conventions Table 1, “Typographic Conventions,” shows the typographic styles used in this document. Table 1 Typographic Conventions Special Element Sample of Typography Document title HP-UX SNAplus2 NOF Programmers Guide File or path name sna.net Directory name /var Header file nof_c.
Table 1 Typographic Conventions Special Element Sample of Typography Function, call, or entry point ioctl Data structure NOF_CALLBACK Hexadecimal value 0x20 45
SNAplus2 Publications SNAplus2 publications include user guides, administrator guides, and programmer guides. The following sections describe the contents of each book. Publications for Users SNAplus2 provides the following user’s guides: HP-UX SNAplus2 General Information Provides an introduction to SNAplus2 and explains key product concepts and features.
Explains how to install the SNAplus2 software and set up system files. HP-UX SNAplus2 Upgrade Guide Provides information about upgrading to the current version of SNAplus2 from previous versions. It includes information about converting configuration files, rebuilding applications that use the SNAplus2 application program interfaces (APIs), and changes in other SNAplus2 functions. HP-UX SNAplus2 Administration Guide Explains how to enable, configure, and manage SNAplus2.
Communications (CPI-C). HP-UX SNAplus2 3270 & TN3270 HLLAPI Programmers Guide Contains the information you need to write application programs using High-Level Language Application Program Interface (HLLAPI). HP-UX SNAplus2 LUA Programmers Guide Contains the information you need to write applications using the Conventional LU Application Programming Interface (LUA).
Related Publications For information about SNA, APPN, or LU 6.2 architecture, refer to the following IBM documents: • Systems Network Architecture: — APPN Architecture Reference, SC30-3422 — Format and Protocol Reference Manual: Architectural Logic, SC30-3112 — Formats, GA27-3136 — LU6.
1 Introduction to the NOF API Chapter 1 51
Introduction to the NOF API Overview Overview This chapter provides an introduction to the SNAplus2 NOF API.
Introduction to the NOF API Purpose of the NOF API Purpose of the NOF API The SNAplus2 NOF API provides access to a standard set of commands, called NOF verbs, that can be used to administer the SNAplus2 system from within an application program.
Introduction to the NOF API Purpose of the NOF API • Develop your own application programs to manage the SNAplus2 system • Develop application programs that use the other SNAplus2 APIs so that they can also manage their own resources (for example, an APPC application can check that the communications link to its partner TP is active before attempting to allocate a conversation or can define the remote LU where its partner TP is located).
Introduction to the NOF API Purpose of the NOF API SNAplus2 software or to restart the software when you make changes.
Introduction to the NOF API SNAplus2 Components SNAplus2 Components SNAplus2 implements an APPN node to communicate with other nodes on the SNA network. This provides logical unit (LU) 6.2 support for APPC and CPI-C capabilities and for 5250 emulation, as well as LU 0, 1, 2, and 3 support for 3270, RJE, and LUA communications. SNAplus2 can operate either as a LEN node or as an APPN end node, depending on its configuration.
Introduction to the NOF API SNAplus2 Components Figure 1-1 SNAplus2 Components The local node, including its associated connectivity resources (DLCs, ports and LSs), is implemented as STREAMS components in the kernel of the HP-UX system. The 3270 emulation program, RJE workstation, APPC transaction programs, CPI-C applications, LUA applications, and the Remote Command Facility (RCF) are user-space programs.
Introduction to the NOF API SNAplus2 Resources SNAplus2 Resources The resources of the SNAplus2 system can be divided into two types: Node resources Define the communications capabilities of a particular APPN node: • Connectivity resources: — — — — DLCs Ports Link stations Connection networks • LUs — Type 0-3 for: — 3270 — RJE — LUA communications — Type 6.
Introduction to the NOF API SNAplus2 Resources Facility and Service Point Command Facility For more information about these resources, refer to the HP-UX SNAplus2 Administration Guide. Dependent LU Requester (DLUR) This section does not apply to LEN nodes. As well as providing direct access to a host computer, SNAplus2 can also provide DLUR facilities. This feature enables sessions for dependent LUs to span multiple nodes in an APPN network, instead of requiring a direct connection to the host.
Introduction to the NOF API SNAplus2 Resources Figure 1-2 PU Concentration Facilities Provided by SNAplus2 The downstream computer must contain an SNA PU type 2.0 or 2.1 to support dependent LUs. For example, the downstream computer could be a PC running Microsoft's SNA Server for Windows NT or another SNAplus2 computer. Using this feature, all the data transferred between the host and the downstream computer is routed through the SNAplus2 local node.
Introduction to the NOF API SNAplus2 Resources TN Server SNAplus2 TN server provides access to 3270 host computers for TN3270 users on other computers. The TN server feature enables TN3270 users to share a host connection with SNAplus2 or with other TN3270 users, instead of requiring a direct link. It also enables TN3270 users to access hosts that are not running TCP/IP.
Introduction to the NOF API SNAplus2 Resources TN Server Users Any 3270 emulation programs that communicate over TCP/IP rather than over an SNA network are referred to as TN3270 programs (Telnet 3270 emulation programs). SNAplus2 TN server supports various TN3270 programs, including SNAplus2 TN3270 (packaged separately from the main SNAplus2 product).
Introduction to the NOF API Client-Server Operation Client-Server Operation The computers on the SNAplus2 LAN are of two types: servers and clients. A server contains a SNAplus2 node and its associated connectivity components; a client does not contain these connectivity components, but accesses them on the server by means of the LAN. Servers must be HP-UX computers; clients may be running HP-UX or Windows systems.
Introduction to the NOF API Client-Server Operation hold a copy of the latest information. If the master server fails or if the SNA software on that computer is stopped, a backup server takes over as the master. The domain configuration file on this server is used as the master copy and is copied to other servers as necessary. When the master server is restarted, it receives a copy of the domain configuration from the backup server currently acting as master and then takes over as the master.
Introduction to the NOF API Client-Server Operation to it are automatically copied to all other servers, in the same way that changes to the domain configuration file are copied to backup servers. You cannot edit the contents of the file directly; instead, SNAplus2 provides NOF verbs to access the file. For more information about the SNA network data file, refer to the HP-UX SNAplus2 Administration Command Reference.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions NOF Verbs to Manage Specific SNAplus2 Functions The following sections list the NOF verbs that are relevant to particular SNAplus2 functions. For more information about individual verbs, see Chapters 3, 4, and 5. Managing the Target (Node or File) for NOF Verbs A NOF verb can be issued to a node, to the domain configuration file, or to the SNA network data file.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions more information, see “SET_CS_TRACE”, “QUERY_CS_TRACE”, “SET_TRACE_FILE”, and “QUERY_TRACE_FILE”. No other NOF verbs can be issued to client computers. Getting Started The first step is to define the SNAplus2 node that runs on each computer, and its communications links to other computers.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions If you are communicating with many nodes on the same shared-access transport facility (SATF), you can set up a connection network (CN) to represent these nodes, instead of having to define explicit LSs to each node. CNs cannot be used if the local node is a LEN node. To set up the CN, you first define a DLC and port to access each of the nodes on the SATF.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions You then need to define LUs that can be used for 3270 emulation and also the users that can access these LUs.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions 5250 Communications If SNAplus2 users will be using 5250 emulation to communicate with AS/400 systems, you need to define the communications link to the AS/400. For more information, see “Getting Started”. You then need to define local LUs that can be used for 5250 emulation.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • QUERY_LU_0_TO_3 To obtain information about the PU that owns an LU, use the following verb: • QUERY_PU To define workstations, use the following verb: • DEFINE_RJE_WKSTN To obtain information about the definition of a workstation or about its current status, use the following verbs: • QUERY_RJE_WKSTN_DEF, QUERY_RJE_WKSTN To delete LUs or workstations when they are no longer required, use the following verbs: • DELETE_LU_0_TO_3, DE
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To obtain information about the PU that owns an LU, use the following verb: • QUERY_PU If you want to provide LU pools (groups of LUs that can be assigned to applications as required, rather than having LUs explicitly defined for each application), use the following verbs to define a pool, to obtain information about the definition, or to delete a pool or remove LUs from it when no longer required: • DEFINE_LU_POOL, QUERY_LU_POOL, D
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • QUERY_PARTNER_LU, QUERY_PARTNER_LU_DEFINITION If the local application communicates with its partner using one of the standard SNA-defined modes, you do not need to define a mode. However, you may want to define additional modes for applications that have particular requirements not covered by the standard modes.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To delete local LUs, partner LUs, modes, or COSs when they are no longer required, use the following verbs: • DELETE_LOCAL_LU, DELETE_PARTNER_LU • DELETE_MODE, DELETE_COS SNAplus2 negotiates session limits with the partner LU automatically when sessions are established.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions If the invokable TP requires conversation-level security, you need to define user IDs and passwords that remote TPs can use to access SNAplus2 TPs.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions Started”. The LS must be defined with the following parameters: solicit_sscp_sessions = NO dspu_services = PU_CONCENTRATION dspu_name = the name of the PU serving the LUs on the downstream computer pu_name = all zeros • One or more type 0-3 LUs on the SNAplus2 node (and optionally an LU pool containing these LUs) for communications with the host. For information about defining LUs and LU pools, see “3270 Communications”.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To define and manage the LUs associated with this PU, see “3270 Communications”, “RJE Communications”, or “LUA Communications”, earlier in this section.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions emulation, use the following verb: • DELETE_TN3270_ACCESS Managing SNA Management Services Functions If applications running on SNAplus2 will be using the MS API to communicate with remote MS applications, you do not need to define any resources for this explicitly, because the node will locate the appropriate remote applications as required.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To define these permissions and enable NetView operators to access SPCF or UCF or both, use the following verb: • DEFINE_RCF_ACCESS To check the permissions currently defined, use the following verb: • QUERY_RCF_ACCESS To prevent operators from using either SPCF or UCF, use the following verb: • DELETE_RCF_ACCESS To remove access to one function but leave the other available, use the following verb: • DEFINE_RCF_ACCESS Managing Dia
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions defaults for a particular server, use the following verbs: • SET_GLOBAL_LOG_TYPE, SET_LOG_TYPE To change the file names or directories used for log messages or to change the size at which files are backed up and reset, use the following verb: • SET_LOG_FILE To check which server is currently defined as the central logger or to check whether central logging is enabled, use the following verbs: • QUERY_CENTRAL_LOGGER, QUERY_CENTRAL_LO
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions required data, use the following verb: • SET_BCK_CS_TRACE If you want to activate tracing to diagnose problems with the SNAplus2 TN server feature or to deactivate it after collecting the required data, use the following verb: • SET_TN_SERVER_TRACE The default files used for trace data are as follows: • /var/opt/sna/sna1.trc and /var/opt/sna/sna2.trc for tracing on a particular computer • /var/opt/sna/snacs1.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions up wildcard entries in the directory to indicate that all LUs in the range are on the specified node.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions use the following verb: • DELETE_DIRECTORY_ENTRY Delete only directory entries that were explicitly defined using the verbs described previously (these entries return an entry type of HOME on the QUERY_DIRECTORY_ENTRY verb). Do not use this verb to delete cached entries (entries that have been set up dynamically as a result of network searches).
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • ADD_BACKUP, DELETE_BACKUP Managing Configuration File Header Information To add a descriptive comment string to the domain configuration file, use the following verb: • DEFINE_DOMAIN_CONFIG_FILE To obtain information about the SNAplus2 version number for which the domain configuration file was created or about the comment string stored in it, use the following verb: • QUERY_DOMAIN_CONFIG_FILE There are no corresponding verbs for
Introduction to the NOF API NOF Indications NOF Indications A NOF application can use the REGISTER_INDICATION_SINK verb to request information about changes to the SNAplus2 configuration or to the status of its resources. SNAplus2 then sends an indication message to the application each time a change occurs. For a complete list of indications that an application can request, see Chapter 6, “NOF Indications.
Introduction to the NOF API NOF Indications No specific VCB structure is associated with this indication type. Instead, when a change to the configuration occurs, SNAplus2 indicates this change to the application by sending a copy of the completed VCB from the NOF verb that made the change. For more information about configuration indications, see “CONFIG_INDICATION”. SNA Network File Indications An application can register to receive information about changes to the SNA network file sna.
Introduction to the NOF API NOF Indications The application does not need to register explicitly to receive this indication; SNAplus2 returns it to any application that has registered for any type of NOF indications on the appropriate target. The indication is returned on the callback routine that the application supplied to the REGISTER_INDICATION_SINK verb (or to the first REGISTER_INDICATION_SINK verb, if the application has issued more than one).
Introduction to the NOF API NOF Indications 88 Chapter 1
2 Writing NOF Applications Chapter 2 89
Writing NOF Applications Overview Overview This chapter describes how a NOF application: • Uses the NOF API entry points • Schedules asynchronous events • Is compiled and linked to use the NOF API This chapter also describes the following information: • Target (node or file) for NOF verbs, and how they interact with the target • Ordering and dependencies between NOF verbs • NOF restrictions based on node configuration • How to request single or multiple data entries with QUERY_* verbs 90 Chapter 2
Writing NOF Applications Description of the NOF API Entry Points Description of the NOF API Entry Points An application accesses the NOF API using the following entry point function calls: nof Issues a NOF verb synchronously. SNAplus2 does not return control to the application until verb processing has finished. All NOF verbs except REGISTER_INDICATION_SINK and UNREGISTER_INDICATION_SINK can be issued through this entry point.
Writing NOF Applications Description of the NOF API Entry Points The nof_async entry point is defined in the NOF header file nof_c.h. nof_async callback routine When using the asynchronous NOF API entry point, the application must supply a pointer to a callback routine. SNAplus2 uses this callback routine both for completion of a verb and also for returning NOF data and status indications. Synchronous Entry Point: nof An application uses the nof entry point to issue a NOF verb synchronously.
Writing NOF Applications Description of the NOF API Entry Points • For the following verbs, the application supplies a null value: — QUERY_NODE_ALL (to obtain a list of running nodes) — QUERY_CENTRAL_LOGGER • For all other NOF verbs, the application supplies the value that was returned on the CONNECT_NODE or OPEN_FILE verb. nofvcb Pointer to a Verb Control Block (VCB) that contains the parameters for the verb being issued. The VCB structure for each verb is described in Chapters 3, 4, and 5.
Writing NOF Applications Description of the NOF API Entry Points when SNAplus2 returns control to the application, so SNAplus2 does not use the application's callback routine.
Writing NOF Applications Description of the NOF API Entry Points yet started) — OPEN_FILE (to access the domain configuration fileor the SNA network data file) • For the following verbs, the application supplies a null value: — QUERY_NODE_ALL (to obtain a list of running nodes) — QUERY_CENTRAL_LOGGER • For all other NOF verbs, the application supplies the value that was returned on the CONNECT_NODE or OPEN_FILE verb.
Writing NOF Applications Description of the NOF API Entry Points does not call the supplied callback routine for this verb. AP_IN_PROGRESS The verb has not yet completed. The application can continue with other processing, including issuing other NOF verbs, provided that they do not depend on the completion of the current verb. However, the application should not attempt to examine or modify the parameters in the VCB supplied to this verb.
Writing NOF Applications Description of the NOF API Entry Points an asynchronous verb that specifies a callback routine; the callback is called each time the indication is received. For other NOF verbs, an indication is received when the verb completes.) The application must examine the opcode parameter in the VCB to determine which event is contained in the callback routine. This section describes how SNAplus2 uses the callback routine and the functions that the callback routine must perform.
Writing NOF Applications Description of the NOF API Entry Points described in “Using the Callback Routine for Indications”). The callback routine can perform all the necessary processing on the returned parameters, or it can simply set a variable to inform the NOF application that the verb has completed. Returned Values The callback function does not return any values.
Writing NOF Applications Scheduling Asynchronous Events Scheduling Asynchronous Events The method that an application uses to schedule asynchronous events depends on which of the following types of application it is: Single-threaded applications Applications that are based around a single main thread of execution to receive and process requests Multithreaded applications Applications that can have several threads of execution receiving and processing requests Motif applications Applications that use the Mo
Writing NOF Applications Scheduling Asynchronous Events generate any subsequent callbacks. For more information about callbacks, see “The Callback Routine Specified on the nof_async Entry Point”. The application scheduling mode assumes that the application is structured as a main loop consisting of a call to either select or poll followed by code to process event information returned by the select or poll call.
Writing NOF Applications Scheduling Asynchronous Events application from signal catcher context. The disadvantages of signal-based scheduling mode are: • Applications that receive work from multiple sources are difficult to write. • Applications are required to use HP-UX V.3 signal calls. • Applications can use only a subset of system calls made from signal catcher context and therefore from the API callback context.
Writing NOF Applications Scheduling Asynchronous Events Multithreaded Applications SNAplus2 API libraries are available for linking with multithreaded applications. When you develop applications to operate in a multithreaded environment, the following restrictions apply: • When an application uses the asynchronous entry point, the application is required to maintain the consistency of its data structures when callbacks are invoked.
Writing NOF Applications Scheduling Asynchronous Events XtAppAddInput function to register the SNA work sources. When work subsequently arrives on the SNA file descriptor, the Xt library scheduling loop calls the SNA event handler, which then makes any required API callbacks to the application.
Writing NOF Applications Compiling and Linking the NOF Application Compiling and Linking the NOF Application Applications are compiled with different options in order to select one of the scheduling modes described in “Scheduling Asynchronous Events”. NOTE Applications that use asynchronous API callbacks must either be built as multithreaded applications or include support for the application scheduled mode. Motif applications must include the code fragment described in “Motif Applications”.
Writing NOF Applications Compiling and Linking the NOF Application following options: cc -I /opt/sna/include -L /opt/sna/lib -lnof -lmgrdce -ldce • For HP-UX 11.0 using DCE threads, link with the following options: cc -I /opt/sna/include -L /opt/sna/lib -lnof -lsna -ldce • For HP-UX 11.
Writing NOF Applications Target For NOF Verbs Target For NOF Verbs A NOF verb can be directed to any of the following targets: • A running node (to manage the node's resources) • The node on a server where the SNAplus2 software is running but where the node has not been started (to start the node, to query the node's stored configuration, or to modify the configuration so that the changes take effect when the node is restarted) • The domain configuration file (to manage domain resources) • The sna.
Writing NOF Applications Target For NOF Verbs • START_* and STOP_* verbs, to start and stop node resources, must be issued to a running node. • Verbs associated with domain resources, such as DEFINE_EMULATOR_USER, must be issued to the domain configuration file. • Different QUERY_* verbs return information about the definition of a resource, on its current status, or on both definition and status. Status information can only be obtained from a running node.
Writing NOF Applications Target For NOF Verbs it. AP_READ_WRITE All NOF verbs are enabled in this mode, including those that change a resource's configuration or status. AP_COMMIT This mode is only available if the target handle identifies the domain configuration file (not when issuing verbs to a node).
Writing NOF Applications Ordering and Dependencies between NOF Verbs Ordering and Dependencies between NOF Verbs The main restriction on the order of NOF verbs is that the first reference to a particular resource must be in a DEFINE_* verb for that resource. This leads to the following dependencies: • When creating a new node configuration file, the first verb issued must be DEFINE_NODE. • A DLC must be defined before any port that refers to it.
Writing NOF Applications NOF Restrictions Based on Node Configuration NOF Restrictions Based on Node Configuration The DEFINE_NODE verb includes parameters that define the range of functions supported by a node. Several NOF verbs relate to optional functions that a node can or can not support; these verbs are valid only when issued to a node that supports the relevant functions. This section summarizes the optional functions that affect which NOF verbs can be used.
Writing NOF Applications NOF Restrictions Based on Node Configuration PU Concentration and DLUR Restrictions The local node can be run with or without support for PU concentration or DLUR or both. The following NOF verbs are valid only if the node is running with PU concentration enabled; the primary return code AP_FUNCTION_NOT_SUPPORTED is returned if you attempt to issue them at a node without PU concentration.
Writing NOF Applications List Options For QUERY_* Verbs List Options For QUERY_* Verbs A NOF application can obtain information about a particular SNAplus2 resource by issuing a QUERY_* verb for the appropriate resource type. For example, it can obtain information about the configuration of an LS by issuing QUERY_LS.
Writing NOF Applications List Options For QUERY_* Verbs list_options The position in the list of the first entry required: • First entry in the list • Entries starting from a specific named entry • Entries starting from the next entry after a specific named entry.
Writing NOF Applications List Options For QUERY_* Verbs next section of the list. The application repeats this process until it has received all the required entries. Obtaining Summary or Detailed Information Some QUERY_* verbs provide the option of returning either summary or detailed information about the specified resources.
3 NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) Chapter 3 115
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) Overview Overview The NOF API verbs are described in alphabetic order in this and the following two chapters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION ACTIVATE_SESSION The ACTIVATE_SESSION verb requests SNAplus2 to activate a session between the local LU and a specified partner LU, using a specified mode. You must issue an INITIALIZE_SESSION_LIMIT verb before issuing an ACTIVATE_SESSION verb, unless cnos_permitted is set to AP_YES. This verb must be issued to a running node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION of its LU name, set this parameter to 8 binary zeros. lu_alias LU alias of the local LU, as defined to SNAplus2. This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. This parameter is used only if lu_name is set to zeros. If both the LU name and the LU alias are set to all zeros, the verb is forwarded to the LU associated with the CP (the default LU).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION AP_POL_BIDDER If AP_POL_EITHER is set, ACTIVATE_SESSION activates a first speaker session if available, otherwise a bidder session is activated. If AP_POL_FIRST_SPEAKER or AP_POL_BIDDER is set, ACTIVATE_SESSION only succeeds if a session of the requested polarity is available. cnos_permitted Indicates that CNOS processing is permitted. Possible values are: AP_YES CNOS processing is permitted. AP_NO CNOS processing is not permitted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_EXCEEDS_MAX_ALLOWED The session cannot be activated, because this would exceed the current session limit for this LU-LU-mode combination. AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION condition that requires action (such as a configuration mismatch or a session protocol error). Check the SNAplus2 log file for information about the error condition, and correct it before retrying this verb. AP_ACTIVATION_FAIL_RETRY The session could not be activated because of a temporary condition (such as a link failure). Retry the verb, preferably after a timeout to allow the condition to clear.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_BACKUP ADD_BACKUP An application uses this verb to add a server to the list of backup master servers in the sna.net file, so that this server can act as the master configuration file server if the current master becomes inactive. The new server is added to the end of the list, so that it will only become the master if all the other servers listed in the file are inactive. This verb must be issued to the sna.net file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_BACKUP Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_DUPLICATE_RECORD The server name specified is already listed in the file. AP_INVALID_TARGET The target handle on the NOF API call specified a configuration file or a node. This verb must be issued to the sna.net file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_DLC_TRACE ADD_DLC_TRACE This verb specifies tracing on SNA messages sent on a DLC. It can be used to activate tracing on a particular DLC, port, or LS, or on a particular session on a specified LS, and to specify which types of messages are to be traced. It can also be used to activate tracing on all DLCs, ports, and LSs. For more information about how to use SNAplus2 tracing, see the HP-UX SNAplus2 Administration Guide.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_DLC_TRACE unsigned char } DLC_TRACE_FILTER; typedef struct sna_lfsid { union { AP_UINT16 struct { unsigned char unsigned char } s; } uu; AP_UINT16 } SNA_LFSID; message_type /* type of messages */ session_id; sidh; sidl; odai; Supplied Parameters The application supplies the following parameters: opcode AP_ADD_DLC_TRACE filter.resource_type Specifies the resource to be traced, and optionally the specific message types to be traced for this resource.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_DLC_TRACE Set up tracing options for the LS named in resource_name. AP_PORT_DEFINED_LS Set up tracing options for the port named in resource_name, and for all defined LSs (but not implicit LSs) that use this port. AP_PORT_IMPLICIT_LS Set up tracing options for the port named in resource_name, and for all implicit LSs (but not defined LSs) that use this port. filter.resource_name The name of the DLC, port, or LS for which tracing is being activated.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_DLC_TRACE AP_TRACE_SC Session Control RUs AP_TRACE_DFC Data Flow Control RUs AP_TRACE_FMD FMD messages AP_TRACE_SEGS Non-BBIU segments that do not contain an RH AP_TRACE_CTL Messages other then MUs and XIDs AP_TRACE_NLP Trace Network-Layer Protocol messages AP_TRACE_NC Trace Network Control messages Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ADD_DLC_TRACE Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING APING APING is the APPN version of the “ping” utility; it allows a management application to check the communications path from a local LU to a remote LU in the network. SNAplus2 APING is implemented using an internally-defined APPC TP. This TP sends data to the partner LU, and optionally receives data from the partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 PARTNER_VER_DATA } APING; consec; fqplu_name[17]; echo; iterations alloc_time; min_time; avg_time; max_time; partner_ver_len; partner_ver_data; typedef struct partner_ver_data { AP_UINT16 partner_ver_len; } PARTNER_VER_DATA; /* /* /* /* /* /* /* /* /* number of consecutive sends fully qualified partner LU name data echo flag number of iterations time taken
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING Partner LU alias. This should be the alias of an LU on a remote node; you are not recommended to use APING with a partner LU on the local node. The alias is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is identified by its fully qualified name instead of its alias, set this parameter to 8 binary zeros and specify the LU name in the fqplu_name parameter.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING are: AP_YES After sending the specified number of data strings, APING waits to receive data from the partner LU. AP_NO After sending the specified number of data strings, APING requests confirmation 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 confirmation.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING The minimum time in milliseconds required for a data-sending iteration (the shortest measured time for a single iteration of sending data and receiving either data or confirmation). If iterations was set to zero, this parameter is not used. avg_time The average time in milliseconds required for a data-sending iteration (the average time for a single iteration of sending data and receiving either data or confirmation).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING The lu_name parameter did not match any defined LU name. AP_BAD_SECURITY The security parameter was not set to a valid value. AP_UNKNOWN_PARTNER_MODE The value specified for plu_alias, fqplu_name, or mode_name did not match any defined partner LU or mode. AP_BAD_PARTNER_LU_ALIAS The value specified for plu_alias did not match any defined partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING The user ID or password specified was not accepted by the partner LU. AP_TP_NAME_NOT_RECOGNIZED The partner LU does not recognize the specified TP name. AP_TRANS_PGM_NOT_AVAIL_NO_RETRY The remote LU rejected the allocation request because it was unable to start the requested partner TP. The condition is permanent. The reason for the error may be logged on the remote node. Do not retry the APING verb until the cause of the error has been corrected.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING occurs again, check the error log file to determine the cause of the error. primary_rc AP_DEALLOC_ABEND The partner TP deallocated the conversation because of an error condition. The reason for the error may be logged on the remote node. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT CHANGE_SESSION_LIMIT The CHANGE_SESSION_LIMIT verb requests SNAplus2 to change the session limits for a particular LU-LU-mode combination. Sessions may be activated or deactivated as a result of processing this verb. This verb must be issued to a running node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT opcode AP_CHANGE_SESSION_LIMIT lu_name LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is defined by its LU alias instead of its LU name, set this parameter to 8 binary zeros. lu_alias LU alias of the local LU, as defined to SNAplus2.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT Name of the mode to be used by the LUs. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the name is shorter than 8 bytes. set_negotiable Specifies whether the maximum negotiable session limit for this mode should be modified.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT auto_act Number of sessions to automatically activate after the session limit is changed. Specify a value in the range 0-32,767. The actual number of automatically activated sessions is the minimum of this value and the negotiated minimum number of contention winner sessions for the local LU. When sessions are deactivated normally (specifying AP_DEACT_NORMAL) below this limit, new sessions are activated up to this limit.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT secondary_rc Possible values are: AP_EXCEEDS_MAX_ALLOWED The plu_mode_session_limit, min_conwinners_source, min_conwinners_target, or auto_act parameter was set to a value outside the valid range. AP_CANT_CHANGE_TO_ZERO The plu_mode_session_limit parameter cannot be set to zero using this verb; use RESET_SESSION_LIMIT instead. AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc AP_MODE_RESET No sessions are currently active for this LU-LU-mode combination. Use INITIALIZE_SESSION_LIMIT instead of CHANGE_SESSION_LIMIT to specify the limits.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT SNAplus2 log file for information about the error condition, and correct it before retrying this verb. primary_rc AP_CNOS_PARTNER_LU_REJECT secondary_rc AP_CNOS_COMMAND_RACE_REJECT The verb failed because the specified mode was being accessed by another administration program (or internally by the SNAplus2 software) for session activation or deactivation, or for session limit processing.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CLOSE_FILE CLOSE_FILE An application uses this verb to release its handle to the domain configuration file, or to the sna.net file,when it has finished issuing NOF verbs to the file. The file which the application wishes to close is identified by the target_handle parameter on the call. The application should always issue CLOSE_FILE for any open file handles before it exits.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CLOSE_FILE Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc AP_VERB_IN_PROGRESS The specified file cannot be released because a previous verb issued for this target handle is still outstanding. All verbs for the target file must be completed before attempting to close the file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CONNECT_NODE CONNECT_NODE An application uses this verb in order to establish communications with a SNAplus2 node (active or inactive). The verb returns a handle identifying the node, which the application can then use on other NOF verbs to indicate the target for the verb. The application should always issue DISCONNECT_NODE for any open node handles before it exits.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CONNECT_NODE This value is required if the application will be issuing the following verbs: • SET_CENTRAL_LOGGING, QUERY_CENTRAL_LOGGING • SET_GLOBAL_LOG_TYPE, QUERY_GLOBAL_LOG_TYPE • SET_LOG_FILE, QUERY_LOG_FILE (if central logging is in use) node_name Name of the SNAplus2 node to connect to. This parameter is reserved if node_type is set to AP_CENTRAL_LOGGER.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CONNECT_NODE AP_NDE_STOPPING The node is in the process of being deactivated. AP_NDE_STOPPED The node is not active. Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_NODE_NAME The value that was specified for the node_name parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CONNECT_NODE software. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_CONV_GROUP DEACTIVATE_CONV_GROUP The DEACTIVATE_CONV_GROUP verb requests the deactivation of the session corresponding to the specified conversation group. Although this verb is part of the NOF API, it is primarily intended for use by application programmers writing TPs that use the APPC API. The conversation group identifier is returned by the APPC verbs [MC_]ALLOCATE, [MC_]GET_ATTRIBUTES, and RECEIVE_ALLOCATE.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_CONV_GROUP is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. It is used only if lu_name is set to zeros. To indicate the LU associated with the CP (the default LU), set both lu_name and lu_alias to 8 binary zeros. conv_group_id Conversation group identifier for the session to be deactivated. type Type of deactivation.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_CONV_GROUP The type parameter was not set to a valid value. AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined LU alias. AP_INVALID_LU_NAME The lu_name parameter did not match any defined LU name. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_LU_0_TO_3 DEACTIVATE_LU_0_TO_3 The DEACTIVATE_LU_0_TO_3 verb requests SNAplus2 to deactivate the session for a particular LU for use with 3270 emulation or LUA (an LU of type 0, 1, 2, or 3) SNAplus2 deactivates the session by sending a TERM_SELF message to the host for the PLU-SLU session. This verb must be issued to a running node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_LU_0_TO_3 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME The lu_name parameter did not match any defined LU name. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_SESSION DEACTIVATE_SESSION The DEACTIVATE_SESSION verb requests SNAplus2 to deactivate a particular session, or all sessions on a particular mode. This verb must be issued to a running node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_SESSION characters, padded on the right with spaces if the name is shorter than 8 bytes. It is used only if lu_name is set to zeros. To indicate the LU associated with the CP (the default LU), set both lu_name and lu_alias to 8 binary zeros. session_id 8-byte identifier of the session to deactivate. If this field is set to 8 binary zeros, SNAplus2 deactivates all sessions for the partner LU and mode. plu_alias LU alias of the partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_SESSION to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters. This return code can also indicate that the session ID did not match the session ID of an active session (implying that the session has already been deactivated).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_SESSION Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG DEFINE_3270_DIAG DEFINE_3270_DIAG specifies the 3270 diagnostics parameters for SNAplus2: the parameters used to record and display response-time data, and the 3270 user alerts that users can send to the host NetView program. It can be used to define 3270 diagnostics parameters for the first time, or to modify an existing definition. This verb must be issued to the domain configuration file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG typedef struct alert_3270_data { AP_UINT16 overlay_size; unsigned char description[53]; unsigned char parameter1[33]; unsigned char parameter2[33]; unsigned char parameter3[33]; } ALERT_3270_DATA; /* /* /* /* /* reserved description parameter 1 parameter 2 parameter 3 */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_3270_DIAG overlay_size For compatability with future releases of SNAplu
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG AP_YES Send RTM data to the host each time a session ends. AP_NO Do not send RTM data to the host at session end. RTM data may be lost when the session ends. def_data.rtm_timer_option Specifies how the host response time is measured.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG def_data.num_alerts The number of 3270 user alerts defined for the SNAplus2 system; the range is 0-20. The host NetView program identifies each alert by a number in the range 1-20; check with the NetView administrator at the host to determine which alert numbers are used and the meaning of each alert.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_ADJACENT_LEN_NODE DEFINE_ADJACENT_LEN_NODE DEFINE_ADJACENT_LEN_NODE adds entries to the node directory database for an adjacent LEN node and its associated LUs, or adds additional LU entries for a previously-defined LEN node. This verb is equivalent to a series of DEFINE_DIRECTORY_ENTRY verbs for the LEN node and its associated LUs; it provides a fast method of defining the LEN node's configuration with a single verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_ADJACENT_LEN_NODE adjacent CP name specified on the DEFINE_LS for the link to the LEN 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. description A null-terminated text string (0-31 characters followed by a null character) describing the adjacent LEN node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_ADJACENT_LEN_NODE the name. For example, the wildcard LU name “LU” will match “LUNAME” or “LU01” (but will not match “NAMELU”). However, all the LU names specified on a single verb must be of the same type (wildcard or explicit), as defined by the wildcard_lus parameter. To add both types of LU names for the same LEN node, use multiple DEFINE_ADJACENT_LEN_NODE verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_ADJACENT_LEN_NODE Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_CP_NAME The specified CP name is already defined in a directory entry, and is not a LEN node. AP_INVALID_LU_NAME One or more of the specified LU names was already defined on a different parent node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN DEFINE_CN DEFINE_CN defines a Connection Network (otherwise known as a Virtual Routing Node or VRN). The verb provides the network qualified name of the connection network along with its Transmission Group (TG) characteristics. Also provided is a list of the names of the local ports that can access this connection network. DEFINE_CN can be used to redefine an existing Connection Network.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } TG_DEFINED_CHARS; connect_cost; byte_cost; reserve2; security; prop_delay; modem_class; user_def_parm_1; user_def_parm_2; user_def_parm_3; /* /* /* /* /* /* /* /* /* connection cost byte cost reserved security propagation delay reserved user-defined parameter 1 user-defined parameter 2 user-defined parameter 3 */ */ */ */
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN encoded as a 1-byte floating point number, represented by the formula 0.1 mmm * 2 eeeee where the bit representation of the byte is b'eeeeemmm'. Each unit of effective capacity is equal to 300 bits per second. def_data.tg_chars.connect_cost Cost per connect time. Valid values are integer values in the range 0-255, where 0 is the lowest cost per connect time and 255 is the highest. def_data.tg_chars.byte_cost Cost per byte.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN def_data.tg_chars.prop_delay Propagation delay: the time that a signal takes to travel the length of the link. Specify one of the following values, according to the type of link: AP_PROP_DELAY_MINIMUM Minimum propagation delay. AP_PROP_DELAY_LAN Delay is less than 480 microseconds (typical for a LAN). AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN names. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameter: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_DEF_LINK_INVALID_SECURITY The security parameter was not set to one of the valid values.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_PORT_ACTIVE The specified port cannot be modified because it is currently active. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS DEFINE_COS DEFINE_COS adds a class of service definition or modifies a previously defined COS. The definition specifies TG “rows” and node “rows”, which associate a range of node and TG characteristics with weights used for route calculation. The lower the weight the more favorable the route.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } TG_DEFINED_CHARS; effect_cap; reserve1[5]; connect_cost; byte_cost; reserve2; security; prop_delay; modem_class; user_def_parm_1; user_def_parm_2; user_def_parm_3; typedef struct cos_node_row { COS_NODE_STATUS minimum; COS_NODE_STATUS maximum; unsigned char unsigned char } COS_NODE_ROW; weight;
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS by a null character) describing the COS. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_COS verb, but SNAplus2 does not make any other use of it. transmission_priority Transmission priority. Possible values are: AP_LOW AP_MEDIUM AP_HIGH AP_NETWORK num_of_node_rows Number of node rows which follow the DEFINE_COS VCB (after the TG rows). The maximum is 8.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS cos_tg_row.minimum.connect_cost Minimum limit for cost per connect time. Valid values are integer values in the range 0-255, where 0 is the lowest cost per connect time and 255 is the highest. cos_tg_row.minimum.byte_cost Minimum limit for cost per byte. Valid values are integer values in the range 0-255, where 0 is the lowest cost per byte and 255 is the highest. cos_tg_row.minimum.security Minimum level of security.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS AP_PROP_DELAY_MINIMUM Minimum propagation delay. AP_PROP_DELAY_LAN Delay is less than 480 microseconds (typical for a LAN). AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network). AP_PROP_DELAY_PKT_SWITCHED_NET Delay is in the range 49,512-245,760 microseconds (typical for a packet-switched network). AP_PROP_DELAY_SATELLITE Delay is greater than 245,760 microseconds (typical for a satellite link).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS cos_tg_row.maximum.byte_cost Maximum limit for cost per byte. Valid values are integer values in the range 0-255, where 0 is the lowest cost per byte and 255 is the highest. cos_tg_row.maximum.security Maximum level of security. Possible values are: AP_SEC_NONSECURE No security. AP_SEC_PUBLIC_SWITCHED_NETWORK Data is transmitted over a public switched network. AP_SEC_UNDERGROUND_CABLE Data is transmitted over secure underground cable.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS LAN). AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network). AP_PROP_DELAY_PKT_SWITCHED_NET Delay is in the range 49,512-245,760 microseconds (typical for a packet-switched network). AP_PROP_DELAY_SATELLITE Delay is greater than 245,760 microseconds (typical for a satellite link). AP_PROP_DELAY_MAXIMUM Maximum propagation delay. cos_tg_row.maximum.user_def_parm_1 through cos_tg_row.maximum.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS cos_node_row.minimum.status Specifies the minimum congestion status of the node. Possible values are: AP_UNCONGESTED The number of ISR sessions is below the isr_sessions_upper_threshold value in the node's configuration. AP_CONGESTED The number of ISR sessions exceeds the threshold value. cos_node_row.maximum.rar Route additional resistance maximum. Values must be in the range 0-255. cos_node_row.maximum.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_COS_NAME The cos_name parameter contained a character that was not valid. AP_INVALID_NUMBER_OF_NODE_ROWS The num_of_node_rows parameter was not in the valid range.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS cos_cache_size parameter on DEFINE_NODE). Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO DEFINE_CPIC_SIDE_INFO This verb adds or replaces a side information entry. A CPI-C side information entry associates a set of conversation characteristics with a symbolic destination name. If there is already a side information entry with the same symbolic destination name as the one supplied with this verb, it is overwritten with the data supplied to this call.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO unsigned char AP_UINT32 unsigned char unsigned char AP_UINT32 reserved[3]; tp_name_type; tp_name[64]; mode_name[8]; conversation_security_type; unsigned char unsigned char unsigned char security_user_id[10]; security_password[10]; lu_alias[8]; /* /* /* /* /* /* /* /* /* /* partner LU name Reserved TP name type TP name Mode name Conversation security type User ID Password LU alias */ */ */ */ */ */ */ */ */ */ } CPIC_SIDE_INFO; Supp
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO The type of the target TP (the valid characters for a TP name are determined by the TP type). Possible values are: XC_APPLICATION_TP Application TP. All characters in the TP name must be valid ASCII characters. XC_SNA_SERVICE_TP Service TP. All characters, except the first, in the TP name must be valid ASCII characters. The first character must be a hexadecimal digit in the range 0x0-0x3F, excluding 0x0E and 0x0F. def_data.side_info.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO SNAplus2 node cannot provide the appropriate restrictions on sending the password; if a CPI-C application attempts to issue the Allocate call with this value set, the call will fail with a return code indicating that the requested security type is not supported.) XC_SECURITY_SAME The target TP uses conversation security, and can accept an “already verified” indicator from the local TP.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_SYM_DEST_NAME The sym_dest_name parameter contained a character that was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DEFAULT_PU DEFINE_DEFAULT_PU DEFINE_DEFAULT_PU specifies which PU is the default for handling SNAplus2 management services data. Only one default PU for each node can be defined at any time; a second DEFINE_DEFAULT_PU verb for a different PU name overrides the previous definition. DEFINE_DEFAULT_PU enables the user to define, redefine, or modify any field of a default PU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DEFAULT_PU padded on the right with EBCDIC spaces if necessary. To delete the default PU, specify all zeros. description A null-terminated text string (0-31 characters followed by a null character) describing the PU. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_DEFAULT_PU verb, but SNAplus2 does not make any other use of it.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DEFAULTS DEFINE_DEFAULTS DEFINE_DEFAULTS specifies default parameters used by the node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DEFAULTS QUERY_DEFAULTS verb, but SNAplus2 does not make any other use of it. default_chars.mode_name Name of the default mode. If an application specifies an unrecognized mode name when attempting to start a session, the parameters from this mode will be used as a default definition for the unrecognized mode. This must be either a mode defined by a previous DEFINE_MODE verb or one of the SNA-defined modes listed in “Purpose of the NOF API”.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DEFAULTS the range 0-65,535 seconds. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_MODE_NAME The mode_name parameter did not match any defined mode name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DIRECTORY_ENTRY DEFINE_DIRECTORY_ENTRY DEFINE_DIRECTORY_ENTRY defines a new entry in the node directory database. This verb cannot be used to modify existing entries. The verb provides a network qualified resource name along with a resource type (network node, end node, LU or Wildcard). When defining an adjacent node and its LUs, you are recommended to use DEFINE_ADJACENT_LEN_NODE instead of DEFINE_DIRECTORY_ENTRY.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DIRECTORY_ENTRY AP_UINT16 parent_type; unsigned char reserv4[8]; } DEFINE_DIRECTORY_ENTRY; /* parent's resource type /* reserved */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_DIRECTORY_ENTRY resource_name Fully qualified name of the resource being registered. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DIRECTORY_ENTRY parent_name Fully qualified name of the parent resource; for an LU the parent resource is the owning Control Point, and for an end node or LEN node it is the network node server. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DIRECTORY_ENTRY AP_INVALID_FQ_OWNING_CP_NAME The parent_name parameter did not match the name of a defined resource. AP_INVALID_LU_NAME The resource_name parameter contained a character that was not valid or was not in the correct format. AP_INVALID_RESOURCE_TYPE The resource_type parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC DEFINE_DLC DEFINE_DLC defines a new DLC. It can also be used to modify the DLC-specific parameters of an existing DLC, if the DLC is not currently active, but other parameters cannot be modified.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC SDH_CREATE_PARMS } SDL_SPEC_DATA; sdh_parms; /* HMOD stub create_parms structure */ /* /* /* /* */ */ */ */ typedef struct sdh_create_parms { AP_UINT16 AP_UINT16 AP_UINT32 V0_MUX_INFO } SDH_CREATE_PARMS; length; num_ports; creators_pid; mux_info; Length of HMOD stub create_parms max number of ports DLC can support process ID of DLC reserved DLC-specific data for QLLC: typedef struct vql_dlc_spec_data { V0_MUX_INFO mux_info; } VQL_DLC_SPEC_DAT
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC opcode AP_DEFINE_DLC dlc_name Name of the DLC. This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. def_data.description A null-terminated text string (0-31 characters followed by a null character) describing the DLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC set to AP_YES. Possible values are: AP_YES Link stations using this DLC may be negotiable. AP_NO Link stations using this DLC must be defined as either primary or secondary; negotiable link stations are not supported. def_data.port_types If dlc_type is set to AP_ETHERNET/AP_FDDI, set this parameter to AP_PORT_SATF. For all other DLC types, this parameter is reserved. def_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC Otherwise, set this parameter to 0 (zero). sdl_spec_data.mu_credit Specifies the credit value for sending DLC_MUs to the link component. Set this parameter to 4. sdl_spec_data.stats_support Specifies whether the DLC collects link statistics information. Possible values are: AP_YES The DLC collects link statistics information, which can be examined using QUERY_STATISTICS. AP_NO The DLC does not collect link statistics information. sdl_spec_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC Type of the DLC. Possible values are: AP_IMPL_TR_DLPI Token Ring AP_IMPL_ETHER_DLPI Ethernet AP_IMPL_FDDI_DLPI FDDI vdl_dlc_cfg.mux_info.card_type Type of the adapter card. Possible values are: AP_CARD_TOKEN_RING_DLPI Token Ring AP_CARD_ETHERNET_DLPI Ethernet AP_CARD_FDDI_DLPI FDDI vdl_dlc_cfg.mux_info.adapter_number Adapter number used by the DLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC secondary_rc Possible values are: AP_INVALID_DLC_NAME The supplied dlc_name parameter contained a character that was not valid. AP_INVALID_DLC_TYPE The supplied dlc_type parameter was not one of the allowed values. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLUR_DEFAULTS DEFINE_DLUR_DEFAULTS DEFINE_DLUR_DEFAULTS defines a default Dependent LU server (DLUS) and a backup default DLUS; if a default DLUS or backup default DLUS is already defined, the verb overrides the existing definition. The default DLUS name is used by DLUR when it initiates SSCP-PU activation for PUs that do not have an explicitly specified associated DLUS. (To define a PU and its associated DLUS, use DEFINE_INTERNAL_PU .
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLUR_DEFAULTS by a null character) describing the DLUR defaults. This string is for information only; it is stored in the node's configuration file, but SNAplus2 does not make any other use of it. dlus_name Name of DLUS node which will serve as the default. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLUR_DEFAULTS Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_DLUS_NAME The supplied dlus_name parameter contained a character that was not valid or
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLUR_DEFAULTS primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOMAIN_CONFIG_FILE DEFINE_DOMAIN_CONFIG_FILE DEFINE_DOMAIN_CONFIG_FILE specifies a comment string to be included in the header of the domain configuration file, or modifies an existing comment string. There is no equivalent verb for a node configuration file, because the header for this file does not contain a comment string; use the description parameter in the DEFINE_NODE verb to include comment information in a node configuration file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOMAIN_CONFIG_FILE the file. This is an ASCII string of 0-99 characters, followed by a null character. This parameter is for information only; SNAplus2 returns it on the QUERY_DOMAIN_CONFIG_FILE verb, but does not make any other use of it.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU DEFINE_DOWNSTREAM_LU DEFINE_DOWNSTREAM_LU defines a new downstream LU, and maps it to an upstream host LU or LU pool (defined using DEFINE_LU_0_TO_3 or DEFINE_LU_POOL). This allows the downstream LU to access the host computer using the PU concentration feature of SNAplus2. This verb cannot be used to modify an existing downstream LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU opcode AP_DEFINE_DOWNSTREAM_LU dslu_name Name of the downstream LU that is being defined. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. def_data.description A null-terminated text string (0-31 characters followed by a null character) describing the downstream LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU on the upstream LU definition. Possible values are: AP_YES Allow the session this downstream LU has with the upstream LU to timeout. AP_NO Do not allow the session this downstream LU has with the upstream LU to timeout. def_data.delayed_logon Specifies whether to use delayed logon with this downstream LU (the upstream LU is not activated until the user requests it).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU The supplied NAU address was not in the valid range. AP_INVALID_ALLOW_TIMEOUT The supplied allow_timeout parameter value was not valid. AP_INVALID_DELAYED_LOGON The supplied delayed_logon parameter value was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU AP_LU_NAME_POOL_NAME_CLASH The specified LU name clashes with the name of an existing LU pool. AP_PU_NOT_ACTIVE The PU specified by the dspu_name parameter is not currently active. AP_LU_ALREADY_ACTIVATING An LU with the name specified by the dslu_name parameter is currently activating. AP_LU_DEACTIVATING An LU with the name specified by the dslu_name parameter is currently deactivating.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE DEFINE_DOWNSTREAM_LU_RANGE DEFINE_DOWNSTREAM_LU_RANGE defines a new range of downstream LUs, and maps them to an upstream host LU or LU pool (defined using DEFINE_LU_0_TO_3 or DEFINE_LU_POOL). This allows the downstream LUs to access the host computer using the PU concentration feature of SNAplus2. This verb cannot be used to modify existing downstream LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE AP_DEFINE_DOWNSTREAM_LU_RANGE dslu_base_name Base name for the names of the new LUs. This is a 5-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the base name is less than 5 characters. SNAplus2 generates the LU name for each LU by appending the 3-digit decimal value of the NAU address to this name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE period specified on the upstream LU definition. Possible values are: AP_YES Allow the sessions this range of downstream LUs have with the upstream LU to timeout. AP_NO Do not allow the session this range of downstream LUs have with the upstream LU to timeout. delayed_logon Specifies whether to use delayed logon with this range of downstream LUs (the upstream LU is not activated until the user requests it).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE character that was not valid. AP_INVALID_NAU_ADDRESS One or more of the supplied NAU addresses was not in the valid range. AP_INVALID_ALLOW_TIMEOUT The supplied allow_timeout parameter value was not valid. AP_INVALID_DELAYED_LOGON The supplied delayed_logon parameter value was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE An LU has already been defined with an NAU address that matches one of the addresses in the range. AP_INVALID_HOST_LU_NAME The specified host LU name was not valid. AP_LU_NAME_POOL_NAME_CLASH One of the LU names in the range clashes with the name of an existing LU pool. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DSPU_TEMPLATE DEFINE_DSPU_TEMPLATE The DEFINE_DSPU_TEMPLATE verb defines a template for the downstream LUs that use the SNAplus2 PU concentration feature. This template is used to define downstream LUs on a group of downstream workstations when a workstation connects over an implicit link (a link not previously defined)..
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DSPU_TEMPLATE AP_DEFINE_DSPU_TEMPLATE template_name The name of the template for downstream LUs that are present on a group of downstream workstations. description Resource description that is returned on the QUERY_DSPU_TEMPLATE verb. modify_template Specifies whether this verb should add additional DSLU templates to an existing DSPU template or should replace an existing DSPU template.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DSPU_TEMPLATE allow_timeout Specifies whether to timeout host LUs used by the downstream LU if the session is left inactive for the timeout period specified on the host LU definition. Possible values are: AP_YES SNAplus2 is allowed to timeout host LUs used by this downstream LU. AP_NO SNAplus2 is not allowed to timeout host LUs used by this downstream LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DSPU_TEMPLATE Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_TEMPLATE_NAME The name specified for the template_name parameter was not valid. AP_INVALID_NAU_ADDRESS The min_nau or max_nau parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DSPU_TEMPLATE codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_HOST_LU_NAME The specified host_lu_name parameter value was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER DEFINE_EMULATOR_USER DEFINE_EMULATOR_USER identifies a user of the SNAplus2 system that can use 3270 emulation or 5250 emulation, and defines the resources available to that user. It can be used to define a new user, to define new sessions for use by an existing user, or to modify the user parameters and session parameters for an existing user. (To delete sessions from an existing user, use DELETE_EMULATOR_USER.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER unsigned char unsigned char change_style; user_is_group; unsigned char status; unsigned char reserv2; } EMULATOR_USER_DEF_DATA; /* /* /* /* /* Can user modify initial style file? */ Does user_name specify a */ HP-UX group? */ reserved */ reserved */ typedef struct session_def_data { AP_UINT16 sub_overlay_size; /* reserved unsigned char session_name[8]; /* Long session name unsigned char emulator_type; /* Emulator type - 3270 or 5250 un
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER opcode AP_DEFINE_EMULATOR_USER sub_overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. user_name The name of the user or group.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER • If the user ID cannot be matched but the user's group ID matches a record for a group, this record is used. • If neither the user ID nor the group ID can be matched, but there is a record defined, this record is used. def_data.description An optional text string (0-31 characters followed by a null character).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER • To specify no limit, set this field to 0xFFFFFFFF. def_data.view_rtm Specifies whether the user has permission to view Response Time Monitor (RTM) data. This also determines whether the Last Transaction Time Indicator (LTTI) is displayed on the 3270 status line. (For a 5250-only user, this field is ignored.) Possible values are: AP_YES The user can view RTM data; the LTTI is displayed.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER Specifies whether the user has permission to load style files, modify style files, or both. Possible values are: AP_STYLE_ADVANCED The user can specify a style file name when starting the emulation program, and can create or modify style files using the emulation program's menu interface.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER AP_NO The user_name parameter identifies a user name. For each session being defined by this verb, up to the number specified in num_sessions, a session_def_data structure is required with the following information: session_def_data.session_name A name identifying the session. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER An optional text string (0-31 characters followed by a null character). The string is for information only; it is stored in the configuration file and returned on the QUERY_EMULATOR_USER_DEF verb, but SNAplus2 does not make use of it. For a 3270 session, the following fields are included: session_def_data.session_variant.def_data_3270.lu_name Name of the LU or LU pool that this session uses.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER Specifies whether the user has permission to change the session to use a different screen model from the one specified. Possible values are: AP_YES The user can change the screen model. AP_NO The user cannot change the screen model. For a 5250 session, the following fields are included: session_def_data.session_variant.def_data_5250.local_lu _alias LU alias of the local LU that this session uses.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER session_def_data.session_variant.def_data_5250.mode_name Name of the mode that this session uses. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. The mode name must match the name of an APPC mode that has already been defined; it is generally set to the SNA-defined mode name QPCSUPP. session_def_data.session_variant.def_data_5250.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs. Defining Partner LUs This verb allows you to specify the partner LU using either its fully qualified LU name or its LU alias.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_FOCAL_POINT DEFINE_FOCAL_POINT The DEFINE_FOCAL_POINT verb specifies the focal point for a particular Management Services category. When a new focal point is specified, SNAplus2 attempts to establish an implicit primary focal point relationship with the specified focal point by sending an MS_CAPABILITIES request.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_FOCAL_POINT user-defined category name is an 8-byte type-1134 EBCDIC string, padded with EBCDIC spaces (0x40) if necessary. fp_fqcp_name Fully qualified control point name of the focal point. 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. ms_appl_name Focal point application name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_FOCAL_POINT Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_CATEGORY_NAME The supplied category name contained a character that was not valid. AP_INVALID_FP_NAME The fully qualified name or the application name was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_FOCAL_POINT the focal point specified by the second verb. Returned Parameters: Unsuccessful If the verb does not execute successfully because the focal point relationship cannot be established, SNAplus2 returns the following parameters: primary_rc AP_UNSUCCESSFUL secondary_rc Possible values are: AP_IMPLICIT_REQUEST_REJECTED The specified focal point rejected the request.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU DEFINE_INTERNAL_PU The DEFINE_INTERNAL_PU verb defines a PU on the local node that is served by DLUR. (To define a downstream PU served by PU concentration or to define a local PU that is directly attached to the host, use DEFINE_LS instead of DEFINE_INTERNAL_PU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU Name of the internal PU that is being defined. This is a type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. def_data.description A null-terminated text string (0-31 characters followed by a null character) describing the internal PU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU up to 8 A-string characters. To indicate that DLUR should use the global backup default DLUS, set this parameter to 17 binary zeros. In this case, you must also use DEFINE_DLUR_DEFAULTS to define the global backup default DLUS. def_data.pu_id PU identifier. This is a 4-byte hexadecimal string, consisting of a block number (3 hexadecimal digits) and a node number (5 hexadecimal digits). The PU ID must match the pu_id configured at the host.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU secondary_rc Possible values are: AP_INVALID_PU_NAME The pu_name parameter contained a character that was not valid. AP_INVALID_PU_ID The pu_id parameter contained a character that was not valid. AP_INVALID_DLUS_NAME The dlus_name parameter contained a character that was not valid or was not in the correct format. AP_INVALID_BKUP_DLUS_NAME The bkup_dlus_name parameter contained a character that was not valid or was not in the correct format.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU DEFINE_LOCAL_LU The DEFINE_LOCAL_LU verb defines a new local LU. It can also be used to modify the attach routing data or description of an existing LU (or of the default LU associated with the local node's Control Point), but not any of the other parameters; when modifying an existing LU, all the other parameters must be set to their currently defined values.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU { unsigned char signed long unsigned char unsigned char } ROUTING_DATA; sys_name[64]; timeout; back_level; reserved[59]; /* /* /* /* Name of target system for TP timeout value in seconds is target system back-level? reserved */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_LOCAL_LU lu_name Name of the local LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU using any locally displayable characters, padded on the right to 8 bytes if necessary. def_data.nau_address Network accessible unit address of the LU. Specify zero if the LU is an independent LU, or an address in the range 1-255 if the LU is a dependent LU. def_data.syncpt_support Specifies whether the LU supports Syncpoint functions.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU AP_YES The LU is in the pool of default LUs, and can be used by applications that do not specify an LU name. AP_NO The LU is not in the pool. If the LU is an independent LU, this parameter is reserved. def_data.pu_name Name of the PU which this LU will use, as specified on the DEFINE_LS verb. This field is used only by dependent LUs, and should be set to 8 binary zeros for independent LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU Enable the local LU. def_data.attach_routing_data.sys_name The name of the target computer for incoming Allocate requests (requests from a partner TP to start an APPC or CPI-C conversation) that arrive at this local LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME The supplied LU name contained a character that was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU AP_LU_ALREADY_DEFINED An LU with this name has already been defined. You cannot use this verb to modify any parameters of an existing LU except the attach routing data. AP_PU_NOT_DEFINED The pu_name parameter did not match any defined PU name. AP_LU_ALIAS_ALREADY_USED An LU with this alias has already been defined. You cannot use this verb to modify any parameters of an existing LU except the attach routing data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU partner LUs for the applications, these must be defined on all nodes where default LUs are defined (so that the application can contact the correct partner LU using any of the default local LUs). • If the applications require independent LUs, do not use the default_pool parameter to define any local LUs as default LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS DEFINE_LS DEFINE_LS is used to define a new link station (LS) or modify an existing one. Before issuing this verb, you must issue the DEFINE_PORT verb to define the port that this LS uses. Link specific data is concatenated to the basic structure. You cannot use DEFINE_LS to modify the port used by an existing LS; the port_name specified on the verb must match the previous definition of the LS. The LS can be modified only if it is not started.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS unsigned char unsigned char disable_remote_act; dspu_services; unsigned char dspu_name[8]; unsigned char dlus_name[17]; unsigned char bkup_dlus_name[17]; unsigned char hpr_supported; unsigned char hpr_link_lvl_error; AP_UINT16 link_deact_timer; unsigned char reserv1; unsigned char default_nn_server; unsigned char ls_attributes[4]; unsigned char adj_node_id[4]; unsigned char local_node_id[4]; unsigned char cp_cp_sess_support; unsigned char use_d
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS { AP_UINT16 AP_UINT16 unsigned char } LINK_ADDRESS; reserve1; length; address[32]; /* reserved /* length /* address */ */ */ /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ DLC-specific data for SDLC: typedef struct sdl_link_spec_data { V0_MUX_INFO mux_info; AP_UINT16 reserve8; AP_UINT16
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_UINT16 stub_spec_data_len; STUB_SPEC_DATA stub_spec_data; } SDL_LINK_SPEC_DATA; typedef struct stub_spec_data { int mux_id; unsigned char opt1; unsigned char opt2; unsigned char pad[2]; AP_UINT32 linesp; AP_UINT16 rcv_pool_size; AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 unsigned char unsigned char } STUB_SPEC_DATA; poll_wait; hmod_data_len; hmod_data[64]; x21_sequence[255]; x21_retry_count; x21_retry_delay; v
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_UINT16 AP_UINT16 retry_timeout; idle_timeout; AP_UINT16 AP_UINT16 unsigned char AP_UINT16 pvc_id; sn_id_len; sn_id[4]; cud_len; unsigned char cud[16]; AP_UINT32 xtras; AP_UINT32 xtra_len; unsigned char rx_thruput_class; unsigned char tx_thruput_class; unsigned char cugo; unsigned char cug; AP_UINT16 cug_index; AP_UINT16 nuid_length; unsigned char nuid_data[109]; unsigned char reserve3[2]; unsigned char rpoa_count; AP_UINT16 rpoa_ids[30]; } VQL_L
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_UINT32 AP_UINT32 AP_UINT32 int } V0_MUX_INFO; card_type; adapter_number; oem_data_length; mux_ids[5]; /* /* /* /* reserved reserved reserved reserved */ */ */ */ For Token Ring, Ethernet, or FDDI, the address parameter in the link_address structure is replaced by the following: typedef struct tr_address { unsigned char mac_address[6]; unsigned char lsap_address; } TR_ADDRESS; /* MAC address /* local SAP address */ */ Supplied Parameters The
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_NO The LS is not automatically started; it must be started manually. def_data.react_timer Reactivation timer for reactivating a failed LS. If the react_timer_retry parameter below is nonzero, to specify that SNAplus2 should retry activating the LS if it fails, this parameter specifies the time in seconds between retries.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS spaces if the name is shorter than 8 bytes, which must match the name of a defined port. def_data.adj_cp_name Fully qualified name of the adjacent CP for this LS. If the adj_cp_type parameter below is set to AP_NETWORK_NODE or AP_END_NODE, and preassigned TG numbers are being used, set this parameter to the CP name defined at the adjacent node; if the adjacent node sends a CP name during XID exchange, it will be checked against this value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_APPN_NODE The node type is unknown. SNAplus2 will determine the type during XID exchange. AP_END_NODE End node, or up-level LEN node (one that includes the Network Name CV in its XID3). AP_NETWORK_NODE Network node. If the adjacent node is not an APPN node, use one of the following values: AP_BACK_LEVEL_LEN_NODE Back-level LEN node (one that does not include the Network Name CV in its XID3).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS the following parameter or parameters. For SDLC: def_data.dest_address.address Address of the secondary station on this LS. • If the port that owns this LS is used only for incoming calls (out_link_act_lim on DEFINE_PORT is zero), this parameter is reserved.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS If the local and adjacent nodes are on LANs of different types (one Token Ring or FDDI, the other Ethernet) connected by a bridge, you will probably need to reverse the bit order of the bytes in the MAC address. For more information, see “Bit Ordering in MAC Addresses”. If the two nodes are on the same LAN, or on LANs of the same type connected by a bridge, no change is required. def_data.dest_address.lsap_address Local SAP address of adjacent node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS the adjacent node is an APPN node (adj_cp_type is either AP_NETWORK_NODE or AP_END_NODE); it is ignored otherwise. This TG number is used to represent the link when the link is activated. The node will not accept any other number from the adjacent node during activation of this link; if the adjacent node is using preassigned TG numbers, the same TG number must be defined by the adjacent node on the adjacent link station.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS CP-CP session support, by setting this field to AP_NO_SESSIONS and cp_cp_sess_support to AP_YES. In this case, if CP-CP sessions are brought up over the link, SNAplus2 will not treat the link as a limited resource (and so will not deactivate it). def_data.solicit_sscp_sessions Specifies whether to request the adjacent node to initiate sessions between the SSCP and the local CP and dependent LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS The LS can only be activated by the local node; if the remote node attempts to activate it, SNAplus2 will reject the attempt. AP_NO The LS can be activated by the remote node. def_data.dspu_services Specifies the services which the local node will provide to the downstream PU across this link. This parameter is used only if the adjacent node is a downstream PU or an APPN node with solicit_sscp_sessions set to AP_NO; it is reserved otherwise.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS SSCP services when the link to the downstream node is activated. This field is reserved if dspu_services is not set to AP_DLUR. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS INACTIVITY. The minimum value is 5; values in the range 1-4 will be interpreted as 5. The value 0 (zero) indicates that no timeout is used (the link is not deactivated, as if limited_resource were set to AP_NO. def_data.default_nn_server End node: Specifies whether this is a link supporting CP-CP sessions to a network node that can act as the local node's network node server.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS listed below. Possible values are: AP_SNA Standard SNA host. AP_FNA Fujitsu Network Architecture (VTAM-F) host. AP_HNA Hitachi Network Architecture host. def_data.ls_attributes[1] Network Name CV suppression for a link to a back-level LEN node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS parameter is valid only if the adjacent node is an end node or network node (adj_cp_type is AP_NETWORK_NODE, AP_END_NODE, or AP_APPN_NODE); it is ignored otherwise. Possible values are: AP_YES CP-CP sessions are supported. The solicit_sscp_sessions parameter must be set to AP_NO. AP_NO CP-CP sessions are not supported. def_data.use_default_tg_chars Specifies whether the default TG characteristics supplied on the DEFINE_PORT verb should be used.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Cost per byte. Valid values are integer values in the range 0-255, where 0 is the lowest cost per byte and 255 is the highest. def_data.tg_chars.security Security level of the network. Possible values are: AP_SEC_NONSECURE No security. AP_SEC_PUBLIC_SWITCHED_NETWORK Data is transmitted over a public switched network. AP_SEC_UNDERGROUND_CABLE Data is transmitted over secure underground cable.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network). AP_PROP_DELAY_PKT_SWITCHED_NET Delay is in the range 49,512-245,760 microseconds (typical for a packet-switched network). AP_PROP_DELAY_SATELLITE Delay is greater than 245,760 microseconds (typical for a satellite link). AP_PROP_DELAY_MAXIMUM Maximum propagation delay. def_data.tg_chars.user_def_parm_1 through def_data.tg_chars.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS If you need to override the port's LS role for an individual LS, specify one of the following values: AP_LS_PRI Primary AP_LS_SEC Secondary AP_LS_NEG Negotiable def_data.max_ifrm_rcvd The maximum number of I-frames that can be received by this link station before an acknowledgment is sent. Specify a value in the range 0-127. If 0 is specified, the value from DEFINE_QLLC_PORT DEFINE_SDLC_PORTis used. def_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS contact_timer Timeout required before a SNRM or XID is retransmitted in the event of nonacknowledgment (used for primary SDLC only). This value must be greater than the no response (T1) timeout value no_resp_timer described below. The timer is specified in milliseconds. This timer is also used for special pre-activation polling.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS disc_timer_retry The Disconnect timer retry limit value corresponds to the number of times transmission and retransmission of a DISC is allowed. A value of 0xFFFF indicates an unlimited retry count. A value of 0x0001 indicates that an outage should be generated after the first timer expiry.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS and stopped only when a frame with an F-bit is received. The timeout should be set to a value not less than twice the transmission time for the longest I-frame plus adjacent station frame processing time. The timer is specified in milliseconds. no_resp_timer_retry Number of times an adjacent secondary station is seen to fail to respond before the primary sends an outage message to the DLC user. A value of 0xFFFF indicates an unlimited retry count.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS The frame to use for pre-activation polling. This is normally XID, indicating that polling is in the control of the DLC user. However, when SNAplus2 is primary talking to an old secondary implementation, it may be necessary to poll using some other frame. Possible values are: XID, DISC, SNRM, SNRME, TEST. poll_on_iframe Specifies whether this link station is permitted to send the poll bit on an I-frame.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS bit 4 Line is full-duplex (half-duplex if not set) The remaining bits are reserved. stub_spec_data.opt2 Reserved. stub_spec_data.linesp The line speed for the line used on this port. For example, 2400 (0x00000960) for a 2400 baud line. Valid values are in the range 600-38,400 baud. The exact meaning of this parameter depends on the value set on the physical_link parameter. • If physical_link is set to SDLC_PL_X21, then the stub_spec_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS This is an ASCII string, specifying the dial string to be passed to the modem to initiate the call. Support for dial data depends on the SDLC adapter and modem that you are using; if they do not support dial data, set this parameter to a null string. Link-specific data for QLLC: mux_info.dlc_type Type of the DLC. Set this to AP_IMPL_NLI_QLLC. vc_type The Virtual Circuit type of the LS.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS to the remote station. The actual size used is 2 to the power of loc_packet; for example, setting loc_packet to 7 indicates a packet size of 2 to the power of 7, which is 128. To indicate using the default packet size for the network, set this parameter to zero. Check with the administrator of your X.25 network to determine the correct value to use. rem_packet Packet size used for receiving data from the remote station.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS about reverse charging options, packet sizes, and window sizes in the facilities data sent to the remote system. If your X.25 network or the remote system requires any other facilities data in addition to the above parameters, specify it using this parameter. Check with the administrator of your X.25 network, or the administrator of the remote system, to determine what to specify in this parameter. If the X.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS pvc_id PVC identifier. Set this to a decimal number to identify which PVC (from the range of PVCs defined for your X.25 provider software) is to be used for this LS. This field is reserved if vc_type above is set to VQL_SVC. sn_id_len Length of the subnet identifier that follows (in the sn_id parameter). Set this parameter to 1 for a single-port card, or 3 for a multi-port card, to match the length of the sn_id parameter as described below.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Call User Data: this parameter identifies the protocol to be used over the underlying X.25 virtual circuit. For most implementations, this should be set to a single hex byte 0xC3, indicating QLLC. Some remote systems may require additional bytes; check with the System Administrator of the remote system. DLC-specific data for Token Ring, Ethernet, FDDI: mux_info.dlc_type Type of the DLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS if the remote station is on a separate Token Ring connected by a bridge. xid_retry_limit The XID retry limit value corresponds to the number of times transmission and retransmission of an XID is allowed. This count does not include the initial transmission; that is, a value of 1 indicates “transmit once and then retry once”. Higher values may be needed if the remote station is on a separate Token Ring connected by a bridge.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_CANT_MODIFY_PORT_NAME The ls_name parameter matched the name of an existing LS, but the port_name parameter did not match the existing definition. You cannot modify the port name when changing the definition of an existing LS.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS value. AP_INVALID_PORT_NAME The port_name parameter did not match the name of any defined port. AP_INVALID_PU_NAME The pu_name parameter did not match the name of any defined PU, or was set when not expected. AP_INVALID_DSPU_NAME The dspu_name parameter did not match the name of any defined PU, or was set when not expected. AP_INVALID_DSPU_SERVICES The dspu_services parameter was not set to a valid value, or was set when not expected.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS the node does not support HPR. AP_INVALID_TG_NUMBER The TG number supplied was not in the valid range. AP_MISSING_CP_NAME A TG number was defined, but no CP name was supplied. AP_MISSING_CP_TYPE A TG number was defined, but no CP type was supplied. AP_MISSING_TG_NUMBER The link was defined to be auto-activated, but no TG number was supplied.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_DUPLICATE_CP_NAME A link to the CP name specified in the adj_cp_name parameter has already been defined. AP_DUPLICATE_DEST_ADDR A link to the destination address specified in the address parameter has already been defined.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS The downstream PU specified in the dspu_name parameter has already been defined. AP_DSPU_SERVICES_NOT_SUPPORTED AP_PU_CONCENTRATION or AP_DLUR has been specified on the dspu_services parameter, but the node does not support it. AP_DUPLICATE_TG_NUMBER The TG number specified in the tg_number parameter has already been defined. AP_TG_NUMBER_IN_USE The TG number specified for the tg_number parameter is already being used by another LS.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS hexadecimal digits. Step 3.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU62_TIMEOUT DEFINE_LU62_TIMEOUT The DEFINE_LU62_TIMEOUT verb defines a timeout period for unused LU 6.2 sessions. Each timeout is for a specified resource type and resource name. If a DEFINE_* verb is issued for a resource type and name pair already defined, the command overwrites the previous definitions. New timeout periods are only used for sessions activated after the definition is changed.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU62_TIMEOUT Timeout applies to all LU 6.2 sessions for the local LU specified in the resource_name parameter. AP_PARTNER_LU_TIMEOUT Timeout applies to all LU 6.2 sessions to the partner LU specified in the resource_name parameter. AP_MODE_TIMEOUT Timeout applies to all LU 6.2 sessions on the mode specified in the resource_name parameter. resource_name Name of the resource being queried.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU62_TIMEOUT returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_RESOURCE_TYPE The type of timeout defined was not valid. AP_INVALID_LU_NAME The resource_type parameter specified an LU name that was not valid. AP_INVALID_PARTNER_LU The resource_type parameter specified a partner LU name that was not valid. AP_INVALID_MODE_NAME The resource_type parameter specified a mode name that was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 DEFINE_LU_0_TO_3 The DEFINE_LU_0_TO_3 verb defines an LU for use with 3270 emulation or LUA (an LU of type 0, 1, 2, or 3), and optionally assigns the LU to an LU pool. If this verb is used to modify an existing LU, only the description, priority, and lu_model parameters can be changed; all other parameters must be set to their existing values.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 opcode AP_DEFINE_LU_0_TO_3 lu_name Name of the local LU. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. def_data.description A null-terminated text string (0-31 characters followed by a null character) describing the LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 AP_HIGH AP_MEDIUM AP_LOW def_data.lu_model Type of the LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 DEFINE_DOWNSTREAM_LU verb, then the LU is deactivated after the PLU-SLU session is left inactive for the specified period and one of the following conditions exist: • The session passes over a limited resource link. • Another application requests to use the LU before the session is used again. If the timeout is set to 0 (zero), the LU is not deactivated.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_PU_NAME The pu_name parameter was not valid. AP_PU_NOT_DEFINED The pu_name parameter did not match any defined PU name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE DEFINE_LU_0_TO_3_RANGE The DEFINE_LU_0_TO_3 verb defines a range of LUs for use with 3270 emulation or LUA (LUs of type 0, 1, 2, or 3), and optionally assigns the LUs to an LU pool. This verb cannot be used to modify existing LUs. The supplied parameters to this verb include a base name for the new LUs and the range of NAU addresses. The new LU names are generated by combining the base name with the NAU addresses.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE opcode AP_DEFINE_LU_0_TO_3_RANGE base_name Base name for the names of the new LUs. This is a 5-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the base name is less than 5 characters. SNAplus2 generates the LU name for each LU by appending the 3-digit decimal value of the NAU address to this name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE priority LU priority when sending to the host. Possible values are: AP_NETWORK AP_HIGH AP_MEDIUM AP_LOW lu_model Type of the LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE Timeout for the LU specified in seconds. If the timeout is set to a nonzero value and the user of the LU specified allow_timeout on the DEFINE_DOWNSTREAM_LU verb, then the LU is deactivated after the PLU-SLU session is left inactive for the specified period and one of the following conditions exist: • The session passes over a limited resource link. • Another application requests to use the LU before the session is used again.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME The base_name parameter contained a character that was not valid. AP_INVALID_POOL_NAME The pool_name parameter contained a character that was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3_RANGE The pu_name parameter did not match any defined PU name. AP_INVALID_PU_TYPE The PU specified by the pu_name parameter is not a host PU. AP_LU_NAME_POOL_NAME_CLASH One of the LU names in the range clashes with the name of an LU pool. AP_LU_ALREADY_DEFINED An LU has already been defined with the name of one of the LUs in the range. AP_LU_NAU_ADDR_ALREADY_DEFD An LU has already been defined with the address of one of the LUs in the range.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_LU_PASSWORD DEFINE_LU_LU_PASSWORD DEFINE_LU_LU_PASSWORD provides a password which is used for session-level security verification between a local LU and a partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_LU_PASSWORD LU alias of the local LU, as defined to SNAplus2. This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. It is used only if lu_name is set to zeros. To indicate the LU associated with the CP (the default LU), set both lu_name and lu_alias to 8 binary zeros. fqplu_name Fully qualified LU name for the partner LU, as defined to SNAplus2.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_LU_PASSWORD significant bit of each byte is not used in session-level security verification and does not need to match). Whatever value the application supplies for this parameter is immediately replaced by the encrypted version of the password. Therefore, the value supplied for the password parameter is never written out.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_POOL DEFINE_LU_POOL This verb is used to define an LU pool and assign LUs to it, or to assign additional LUs to an existing pool. The LUs must be defined before adding them to the pool. You can also define a pool by specifying the pool name when defining an LU; For more information, see “DEFINE_LU_0_TO_3”. This verb cannot be used to modify an existing pool by removing LUs from it; the DELETE_LU_POOL verb is used to do this.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_POOL configuration file and returned on the QUERY_LU_POOL verb, but SNAplus2 does not make any other use of it. num_lus Number of LUs to be added to the pool. This can be zero to define the pool without adding any LUs, or 1-10. To create a pool containing more than 10 LUs, issue multiple DEFINE_LU_POOL verbs for the same pool name. lu_names Names of the LUs that are being assigned to the pool.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_POOL AP_INVALID_NUM_LUS The num_lus parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE DEFINE_MODE The DEFINE_MODE verb defines a mode (a set of networking characteristics to be used by a group of sessions) or modifies a previously defined mode. You cannot modify the SNA-defined mode CPSVCMG or change the COS name used by the SNA-defined mode SNASVCMG. If you use this verb to modify an existing mode, the changes will apply to any new combination of local LU and partner LU that start to use the mode after you have made the change.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 } MODE_CHARS; cos_name[8]; cryptography; compression; reserv1; auto_act; min_conloser_src; max_ru_size_low; max_receive_pacing_win; /* /* /* /* /* /* /* /* class of service name reserved reserved reserved initial auto-activation count min source contention loser maximum RU size lower bound maximum receive pacing window */ */ */ */ */ */ */ */ Supplied
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE parameter (see below) is set to AP_YES, this parameter is ignored (and the value is not checked). mode_chars.receive_pacing_win Session pacing window for sessions using this mode; the range is 1-63. This value is used only for fixed pacing (not for adaptive pacing), and specifies the maximum number of frames that can be received from the partner LU before the local LU must send a response.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE LU and partner LU pair. This value is used when CNOS (Change Number of Sessions) exchange is initiated implicitly. Specify a value in the range 1-32,767 (which must not exceed the value in max_neg_sess_lim above). Zero indicates that SNAplus2 should not initiate implicit CNOS exchange when an application attempts to start a session using this mode; session limits must be specified explicitly using initialize_session_limit.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE initiated implicitly. Specify a value in the range 0-32,767. mode_chars.min_conloser_src Minimum number of contention loser sessions that can be activated by any one local LU that uses this mode. This value is used when CNOS (Change Number of Sessions) exchange is initiated implicitly. Specify a value in the range 0-32,767. mode_chars.max_ru_size_low Lower bound for the maximum size of RUs sent and received on sessions that use this mode.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_CPSVCMG_ALREADY_DEFD The SNA-defined mode CPSVCMG cannot be changed. AP_INVALID_CNOS_SLIM The plu_mode_session_limit parameter is not valid. AP_INVALID_COS_NAME The cos_name parameter did not match any defined COS name. AP_INVALID_COS_SNASVCMG_MODE The COS for the SNA-defined mode SNASVCMG cannot be changed.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE The SNA-defined mode SNASVCMG must have a session limit of 2 and min_conwin_src of 1. You cannot define SNASVCMG with different values for these parameters. AP_MODE_SESS_LIM_EXCEEDS_NEG The value specified for plu_mode_session_limit was larger than the value specified for max_neg_sess_lim. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE DEFINE_NODE An application issues this verb in order to define a new node, or to modify the parameters of an inactive node. This verb must be issued to a server where the node is not running. It cannot be issued to a running node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE unsigned char reg_with_cds; /* register resources with CDS AP_UINT16 mds_send_alert_q_size;/* size of MDS send alert queue AP_UINT16 cos_cache_size; /* number of cos definitions AP_UINT16 tree_cache_size; /* reserved AP_UINT16 tree_cache_use_limit; /* reserved AP_UINT16 max_tdm_nodes; /* reserved AP_UINT16 max_tdm_tgs; /* reserved AP_UINT32 max_isr_sessions; /* reserved AP_UINT32 isr_sessions_upper_threshold; /* reserved AP_UINT32 isr_sessions_lower_
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE Length of create parameters structure. cp_create_parms.description A text string (0-31 characters followed by a null character) describing the node. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_NODE verb, but SNAplus2 does not make any other use of it. cp_create_parms.node_type One of the following node types: AP_END_NODE AP_LEN_NODE cp_create_parms.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE cp_create_parms.mds_supported Specifies whether Management Services supports Multiple Domain Support and MS Capabilities. Possible values are: AP_YES MDS is supported. AP_NO MDS is not supported. cp_create_parms.node_id Node identifier used in XID exchange. This is a 4-byte hexadecimal string, consisting of a block number (3 hexadecimal digits) and a node number (5 hexadecimal digits). cp_create_parms.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE Register resources with the NN. The end node's network node server will only forward directed locates to it. AP_NO Do not register resources. The network node server will forward all broadcast searches to the end node. cp_create_parms.reg_with_cds End node: Specifies whether the network node server is allowed to register end node resources with a Central Directory server. This field is ignored if reg_with_nn is set to AP_NO.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE cp_create_parms.store_dlur_rscvs Specifies whether RSCVs should be stored for diagnostic purposes (AP_YES or AP_NO). If this field is set to AP_YES, then an RSCV will be returned on the QUERY_DLUR_LU verb. (Setting this value to AP_YES means an RSCV will be stored for each PLU-SLU session using DLUR. This extra storage can be up to 256 bytes per session.) cp_create_parms.dlur_support Specifies whether DLUR is supported (AP_YES or AP_NO).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE AP_SUPPRESS_REQDISCONT Do not use REQDISCONT. AP_OVERRIDE_REQDISCONT Use a modified version of REQDISCONT support. If REQDISCONT is specified, it must be combined with one or both of the following values, using a logical OR operation: AP_REQDISCONT_TYPE Use type “immediate” on REQDISCONT; if this value is not specified, SNAplus2 uses type “normal”.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE cp_create_parms.ptf[2] BIS support. SNAplus2 normally uses the BIS protocol prior to deactivating a limited resource LU 6.2 session. Set this byte to one of the following values: AP_NONE Use the normal processing. AP_SUPPRESS_BIS Do not use the BIS protocol. Limited resource LU 6.2 sessions are deactivated immediately using UNBIND(cleanup).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE AP_INVALID_NODE_TYPE The node_type parameter was not set to a valid value. AP_PU_CONC_NOT_SUPPORTED This version of SNAplus2 does not support the PU concentration feature. AP_DLUR_NOT_SUPPORTED This version of SNAplus2 does not support the DLUR feature. AP_HPR_NOT_SUPPORTED You specified a nonzero value for a reserved parameter.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU DEFINE_PARTNER_LU The DEFINE_PARTNER_LU verb defines the parameters of a partner LU for LU-LU sessions between a local LU and the partner LU, or modifies an existing partner LU. You cannot change the partner LU alias of an existing partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU unsigned char unsigned char AP_UINT16 unsigned char unsigned char unsigned char } PLU_CHARS; plu_un_name[8]; /* partner LU uninterpreted name appcip_routing_preference; /* reserved max_mc_ll_send_size; /* maximum MC send LL size conv_security_ver; /* already-verified security /* supported? parallel_sess_supp; /* parallel sessions supported? reserv3[8]; /* reserved */ */ */ */ */ */ */ Supplied Parameters The application supplies the followin
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU QUERY_PARTNER_LU_DEFINITION verbs, but SNAplus2 does not make any other use of it. plu_chars.plu_un_name Uninterpreted name of the partner LU (the name of the LU as defined to the remote SSCP). The name is an 8-byte EBCDIC character string. To use the default uninterpreted name (the same as the network name taken from the fqplu_name parameter above), set this parameter to 8 binary zeros.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_DEF_PLU_INVALID_FQ_NAME The fqplu_name parameter contained a character that was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU codes associated with AP_STATE_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT DEFINE_PORT DEFINE_PORT is used to define a new port or modify an existing one. Before issuing this verb, you must issue the DEFINE_DLC verb to define the DLC that this port uses. You can modify an existing port only if it is not started. You cannot change the DLC used by an existing port; the dlc_name specified when modifying an existing port must match the DLC that was specified on the initial definition of the port.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_UINT16 implicit_ls_limit; /* implicit ls limit */ unsigned char reserv4; /* reserved */ unsigned char implicit_dspu_services; /* implicit DSPU support */ AP_UINT16 implicit_deact_timer; /* deact timer for implicit LSs */ AP_UINT16 act_xid_exchange_limit; /* activation XID exchange limit */ AP_UINT16 nonact_xid_exchange_limit; /* non-activation XID */ /* exchange limit */ unsigned char ls_xmit_rcv_cap; /* LS transmit-receive capability */ unsigned
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT unsigned char modem_class; unsigned char user_def_parm_1; unsigned char user_def_parm_2; unsigned char user_def_parm_3; } TG_DEFINED_CHARS; /* /* /* /* reserved user-defined parameter 1 user-defined parameter 2 user-defined parameter 3 */ */ */ */ Port-specific data for SDLC: typedef struct sdl_port_spec_data { V0_MUX_INFO mux_info; /* AP_UINT32 idle_timer; /* AP_UINT16 idle_timer_retry; /* AP_UINT16 reserve1; /* AP_UINT32 np_rcv_timer; /* AP_UIN
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 reserve2; disc_timer; disc_timer_retry; reserve3; nve_poll_timer; nve_poll_timer_retry; reserve4; nve_poll_timer2; nve_poll_timer_retry2; reserve5; no_resp_timer; AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 unsigned char unsigned char AP_UINT32 unsigned char unsigned char no_resp_timer_retry; reserve6; rem_busy_timer; rem_busy_timer_retry; re_
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT { V0_MUX_INFO mux_info; unsigned char driver_name[13]; unsigned char cud_mode; AP_UINT16 cud_len; unsigned char cud[16]; unsigned char add_mode; AP_UINT16 add_len; AP_UINT32 xtras; AP_UINT32 xtra_len; } VQL_PORT_SPEC_DATA; /* /* /* /* /* /* /* /* /* streams config info reserved matching required on CUD length of Call User Data in octets Call User Data matching reqd on called address length of called address to match reserved reserved */ */ */ */ *
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT } VDL_SAP_CFG; Link-specific data for Token Ring, Ethernet, FDDI: typedef struct vdl_ls_cfg { V0_MUX_INFO mux_info; AP_UINT16 reserve1; AP_UINT16 reserve2; AP_UINT16 test_timeout; AP_UINT16 test_retry_limit; AP_UINT16 xid_timeout; AP_UINT16 xid_retry_limit; AP_UINT16 t1_timeout; AP_UINT16 t1_retry_limit; } VDL_LS_CFG; /* /* /* /* /* /* /* /* /* Streams config info reserved reserved TEST timeout value in seconds TEST retransmission limit XID timeou
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_DEFINE_PORT port_name Name of port being defined. This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. def_data.description A null-terminated text string (0-31 characters followed by a null character) describing the port.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_PORT_NONSWITCHED Nonswitched line. For QLLC, this parameter must be set to AP_PORT_SWITCHED. For Token Ring / Ethernet / FDDI, this parameter must be set to AP_PORT_SATF (shared access transport facility). def_data.port_attributes This is a one-bit parameter that may take the following values: AP_NO Incoming calls are resolved by CP name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT parameter must be set to 1. def_data.inb_link_act_lim Inbound link activation limit (the number of links reserved for inbound activation). The sum of inb_link_act_lim and out_link_act_lim must not exceed tot_link_act_lim; the difference between inb_link_act_lim and tot_link_act_lim defines the maximum number of links that can be activated outbound at any time. For an SDLC port with port_type set to AP_NONSWITCHED, this parameter must be zero.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_LS_SEC Secondary AP_LS_NEG Negotiable For Token Ring / Ethernet/ FDDI, this must be set to AP_LS_NEG. implicit_dspu_template Specifies the DSPU template, defined on the DEFINE_DSPU_TEMPLATE verb. This template is used for definitions if the local node is to provide PU concentration for an implicit link activated on this port.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT parameter implicit_dspu_template. AP_NONE Local node will provide no services for this downstream PU. def_data.implicit_deact_timer Implicit limited resource link deactivation timer (in seconds). If implicit_limited_resource is set to AP_INACTIVITY, an implicit link using this port will be deactivated if no data flows on it for the time specified by this parameter. The minimum value is 5; values in the range 1-4 will be interpreted as 5.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT def_data.max_send_btu_size Maximum BTU size that can be sent from this port. This value is used to negotiate the maximum BTU size that a pair of link stations can use to communicate with each other. The value includes the length of the TH and RH (total 9 bytes) as well as the RU. Specify a value in the range 265-65,535 (265-4105 for SDLC). def_data.dlc_data.length Length of the port address (in the following parameter). def_data.dlc_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_YES CP-CP sessions are permitted for implicit LSs. AP_NO CP-CP sessions are not permitted for implicit LSs. def_data.implicit_limited_resource Specifies whether implicit link stations off this port should be defined as limited resources. Possible values are: AP_NO Implicit links are not limited resources, and will not be deactivated automatically.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Length of port-specific data. The data should be concatenated to the basic VCB structure. def_data.link_spec_data_len Length of link-specific data. The link-specific data should be concatenated immediately following the port-specific data. For details of these parameters, see “DEFINE_LS”; the values specified on DEFINE_PORT are used as defaults for processing incoming calls (when the LS name is not initially known).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT milliseconds. np_rcv_timer_retry The nonproductive receive retry limit is used in conjunction with the timeout value to provide the overall time before an outage message is issued. A value of 0xFFFF indicates an unlimited retry count. A value of 0x0001 indicates that an outage should be generated after the first timer expiry. write_timer The write timeout corresponds to the maximum time allowed to transmit a complete frame.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Specifies whether the primary SDLC station on this link supports full duplex. Possible values are: AP_YES The primary station supports full-duplex. FULL_DUPLEX in the stub_spec_data.opt1 parameter below must also be set. AP_NO The primary station does not support full-duplex. sec_fdplx Specifies whether the secondary station(s) on the link is (are) full duplex. Possible values are: AP_YES The secondary station supports full-duplex.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT requests retransmission of frames through RR, RNR or I-frames. Use of REJ is only beneficial when full duplex protocol operation is being used. Some SDLC stations may not recognize the REJ command; to connect to them, the value AP_NO must be set. port_type Type of the port. If def_data.port_type above is AP_NONSWITCHED, set this parameter to AP_PORT_LEASED. For a switched line (def_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT HMOD port options flag 1. Set the appropriate bits of this field as follows (bit 7 is the most significant bit): bit 7 4-wire connection (2 wire connection if not set). bit 6 Use NRZI (NRZ if not set). bit 5 Reserved (must be set to 0). bit 4 Line is full-duplex (half-duplex if not set). This bit must be set if either pri_fdplx or sec_fdplx above is set to AP_YES. bit 3 Internal line speed clocking (external if not set).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT the physical_link parameter. • If physical_link is set to SDLC_PL_X21, then the stub_spec_data.linesp parameter is ignored. • If physical_link is set to SDLC_PL_V25 or SDLC_PL_SMART_MODEM, then the value of the stub_spec_data.linesp parameter is the speed at which the dial string is sent to the modem. • If physical_link is set to any other value, then the value of the stub_spec_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT mux_info.dlc_type Type of the DLC. Set this to AP_IMPL_NLI_QLLC. cud_mode Specifies the type of matching required between the Call User Data (CUD) supplied on an incoming call and the cud parameter below. Possible values are: VQL_DONTCARE CUD on incoming calls is not checked. VQL_IDENTITY The received CUD must match the string specified in the cud parameter.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT VQL_IDENTITY The received address must match the string specified in the address parameter. VQL_STARTSWITH The initial bytes (up to add_len) of the received address must match the string specified in the address parameter; any bytes following add_len are not checked. If the address parameter is set to a null string, this parameter must be set to VQL_DONTCARE.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Timeout in milliseconds within whichSNAplus2 expects a response to any I-frames sent to the adjacent link station. sap_spec_data.p_bit_timeout Time in milliseconds that SNAplus2 waits for a response to a frame sent with the POLL bit set. sap_spec_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_PORT_NAME The port_name parameter was not valid. AP_INVALID_DLC_NAME The specified dlc_name did not match any defined DLC. AP_INVALID_PORT_TYPE The port_type parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_PU_CONC_NOT_SUPPORTED The implicit_dspu_services parameter was set to a reserved value. AP_INVALID_TEMPLATE_NAME The DSPU template specified on the implicit_dspu_template parameter was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT these calls, because SNAplus2 will define one dynamically when the incoming call is received. However, if the incoming calls are from a host computer that supports dependent LUs or from a downstream computer using PU concentration, you need to define an LS explicitly, because the LS definition includes the name of the PU associated with the dependent LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RCF_ACCESS DEFINE_RCF_ACCESS DEFINE_RCF_ACCESS specifies access to the SNAplus2 Remote Command Facility (RCF): the user ID used to run HP-UX Command Facility (UCF) commands, and the restrictions on which administration commands can be issued using the Service Point Command Facility (SPCF). For more information about SPCF and UCF, see the HP-UX SNAplus2 Administration Guide.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RCF_ACCESS specify the name root, because SNAplus2 does not allow UCF commands to be run as root for security reasons. All UCF commands will be run using this user's user ID, with the default shell, default group ID, and access permissions that are defined on the HP-UX system for this user. To prohibit access to UCF, set this parameter to a null string. spcf_permissions Specifies the types of SNAplus2 verbs that can be accessed using SPCF.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RCF_ACCESS The START_*, STOP_*, ACTIVATE_*, DEACTIVATE_*, APING, INITIALIZE_SESSION_LIMIT, CHANGE_SESSION_LIMIT, and RESET_SESSION_LIMIT verbs are allowed to be directed at any node in the domain.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RJE_WKSTN DEFINE_RJE_WKSTN DEFINE_RJE_WKSTN defines a workstation for use by a group of SNAplus2 RJE users. This verb must be issued to the domain configuration file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RJE_WKSTN The name of the workstation. This is an ASCII string of 1-4 characters; it is not case-sensitive. def_data.description An optional text string (0-31 characters followed by a null character). The string is for information only; it is stored in the configuration file and returned on the QUERY_RJE_WORKSTATION verb, but SNAplus2 does not make use of it. def_data.primary_user The HP-UX user ID of the main user of this workstation.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RJE_WKSTN in the directory /etc/opt/sna; for more information about the workstation style file, refer to the HP-UX SNAplus2 RJE Users Guide. All other files and directories required by the workstation will be created automatically when the workstation is started. In general, RJE users must run the spool commands (to submit, list, or cancel jobs) on the same computer as the workstation.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RJE_WKSTN Names of the LUs that this workstation uses. Each name is an 8-byte EBCDIC string, padded on the right with EBCDIC spaces. It must match the name of a type 0-3 LU that has already been defined. If the workstation uses more than one LU, all LUs must be defined at the same host (although they may be associated with different local PUs and so access the host using different LSs).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_SECURITY_ACCESS_LIST DEFINE_SECURITY_ACCESS_LIST DEFINE_SECURITY_ACCESS_LIST defines a list of users who can access a particular local LU or invokable TP, so that access to that LU or TP is restricted to the named users. It can also be used to add user names to an existing security access list. The user names in the list are defined using the DEFINE_USERID_PASSWORD verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_SECURITY_ACCESS_LIST typedef struct define_security_access_list { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char list_name[14]; unsigned char reserv3[2]; SECURITY_LIST_DEF def_data; } DEFINE_SECURITY_ACCESS_LIST; typedef struct security_list_def { unsigned char description[32]; unsigned char reserv3[16]; AP_UINT32 num_users; unsigned char reserv2[16]; } SECURITY_LIST_DEF; typedef
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_SECURITY_ACCESS_LIST access list. This string is for information only. It is stored in the node’s configuration file and returned on the QUERY_SECURITY_ACCESS_LIST verb, but SNAplus2 does not make any other use of it. def_data.num_users Number of user names being defined by this verb. Each user must be specified by a security_user_data structure following the def_data structure.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS DEFINE_TN3270_ACCESS DEFINE_TN3270_ACCESS defines TN3270 access details for a particular client (or default TN3270 access details for all clients). Each verb specified details for one or more sessions. Each session is uniquely identified by the client address and the server port number. The DEFINE_TN3270_ACCESS verb can be used to define a new user, to define new sessions for use by an existing client, or to modify the session parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS AP_UINT16 unsigned char unsigned char unsigned char unsigned char sub_overlay_size; description[32]; tn3270_support; allow_specific_lu; printer_lu_name[8]; unsigned char AP_UINT16 reserv1[6]; port_number; unsigned char lu_name[8]; unsigned char session_type; unsigned char model_override; unsigned char reserv3[4]; AP_UINT32 reserv4; } TN3270_SESSION_DEF_DATA; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* reserved Session description Le
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS client_address and address_format parameters are reserved. AP_NO This verb defines a normal TN3270 user record. A default record provides access to the TN server function for any TN3270 user that can determine the TCP/IP address of the computer where the TN server is running.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS An optional text string (0-31 characters followed by a null character). The string is for information only; it is stored in the configuration file and returned on a query_tn3270_access_def structure for a QUERY_TN3270_ACCESS_DEF verb, but SNAplus2 does not make use of it. You can use it to store additional information to help distinguish between users. def_data.address_format Specifies the format of the client_address parameter.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS Specifies that TN3270E protocols are disabled. AP_TN3270E Specifies that TN3270E protocols are enabled. This is the default value. TN3270 and TN3287 protocols are always enabled. allow_specific_lu Indicates whether access to specific LUs is allowed. Possible values are: AP_YES Access to specific LUs is allowed. AP_NO Access to specific LUs is not allowed.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS that session is replaced; otherwise a new session is added. If the TN3270 program uses TCP/IP port number 23 (the port number used by the Telnet daemon program on the HP-UX computer), you will need to set up an additional initialization file to share this port number between TN server and the Telnet daemon program. For more information, see “Using the Telnet Daemon's TCP/IP Port”.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_UNKNOWN_CLIENT_ADDRESS The specified name or alias could not be mapped to a fully qualified name. AP_CLIENT_ADDRESS_CLASH The fully qualified name, resolved from the client_address parameter, clashes with one that has already been defined. AP_TCPIP_PORT_IN_USE The TCP/IP port number cannot be used by TN server because it is already in use by a different program.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS Telnet daemon program, which are included in this line; typically these are /etc/telnetd and telnetd. Comment out this line by inserting a # character at the start of the line, and save the file. Step 4. Create an ASCII text file /etc/snapinetd.conf. This file should consist of a single line containing the Telnet daemon executable name and parameters, as determined in step 3, for example: /etc/telnetd telnetd Step 5.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ASSOCIATION DEFINE_TN3270_ASSOCIATION DEFINE_TN3270_ASSOCIATION defines an association between a display LU and a printer LU. This association allows a TN3270E client to connect to the printer LU that is associated with a display LU without knowing the name of the printer LU. The DEFINE_TN3270_ASSOCIATION verb can be used to define a new association or to overwrite an existing association for a particular display LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ASSOCIATION def_data.printer_lu_name parameter. This is an EBCDIC string padded on the right with EBCDIC spaces. The specified display LU should be a display LU defined on the local node, but this is not enforced by the NOF API. def_data.description Description of the association being defined. This parameter is optional. def_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ASSOCIATION returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME Either the supplied display LU name or the supplied printer LU name was not a valid EBCDIC string. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_DEFAULTS DEFINE_TN3270_DEFAULTS DEFINE_TN3270_DEFAULTS defines TN3270 parameters used on all client sessions.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_DEFAULTS print large jobs if definite responses are not requested. If necessary, set force_responses to AP_YES to avoid problems. AP_NO Request responses matching SNA traffic. def_data.keepalive_method Method for sending keep-alive messages. Keep-alive messages are sent to ensure periodic traffic on each connection, so that connection failure is detected.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_DEFAULTS primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_KEEPALIVE The keepalive_method parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP DEFINE_TP The DEFINE_TP verb provides information that SNAplus2 needs to start a TP as a result of an incoming attach from a partner LU. This verb can also be used to modify one or more fields on a previously defined TP. The standard parameters for invoked TPs are defined in the invokable TP information file (for more information, see the HP-UX SNAplus2 Administration Guide).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP AP_UINT16 unsigned char } TP_CHARS; tp_data_len; tp_data[120]; /* reserved /* reserved */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_TP tp_name Name of the TP being defined. tp_chars.description A null-terminated text string (0-31 characters followed by a null character) describing the TP.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP AP_MAPPED The TP supports only mapped conversations. AP_EITHER The TP supports either basic or mapped conversations. tp_chars.security_rqd Specifies whether conversation security information is required to start the TP. Possible values are: AP_YES A user ID and password are required to start the TP. AP_NO No security information is required. tp_chars.sync_level Specifies the values of synchronization level supported by the TP.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP Possible values are: AP_YES TP can be attached. AP_NO TP cannot be attached. tp_chars.pip_allowed Specifies whether the TP can receive Program Initialization Parameters (PIP). Possible values are: AP_YES TP can receive PIP. AP_NO TP cannot receive PIP. tp_chars.tp_instance_limit Limit on the number of instances of this TP that can be active at any one time. A value of zero means no limit.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP The conv_type parameter was not set to a valid value. AP_INVALID_SYNC_LEVEL The sync_level parameter was not set to a valid value. AP_INVALID_DYNAMIC_LOAD The dynamic_load parameter was not set to a valid value. AP_INVALID_ENABLED The enabled parameter was not set to a valid value. AP_INVALID_PIP_ALLOWED The pip_allowed parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP_LOAD_INFO DEFINE_TP_LOAD_INFO DEFINE_TP_LOAD_INFO defines or changes an entry that describes information to be used when a transaction program is loaded. An application must issue OPEN_FILE with a requested role of AP_TP_LOAD_INFO before issuing the DEFINE_TP_LOAD_INFO verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP_LOAD_INFO The TP name of the TP load info entry to be defined. This is a 64-byte EBCDIC string, padded on the right with spaces if the name is shorter than 64 characters. lu_alias The LU alias of the TP load info entry to be defined. This is an 8-byte ASCII character string. def_data.description A null-terminated text string (0-32 characters followed by a null character) describing the TP load info.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP_LOAD_INFO • A 2-byte length field with a maximum value of 258 bytes. This field is in line format and is read or written using NB_PUT_SHORT or NB_GET_SHORT. • A 1-byte type field with the following possible values defined with #define: 0x01 AP_TYPE_TP_PATH 0x02 AP_TYPE_TP_ARGUMENTS 0x03 AP_TYPE_TP_STDIN 0x04 AP_TYPE_TP_STDOUT 0x05 AP_TYPE_TP_STDERR 0x06 AP_TYPE_TP_ENV • A value field consisting of up to 255 bytes of ASCII data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP_LOAD_INFO An LTV value parameter contained data that was not valid. AP_INVALID_TP_NAME The TP name parameter contains EBCDIC spaces. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_USERID_PASSWORD DEFINE_USERID_PASSWORD DEFINE_USERID_PASSWORD defines a user ID / password pair for use with APPC and CPI-C conversation security, or adds profiles for a defined user ID and password.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_USERID_PASSWORD are: AP_ADD_USER Add a new user, or change the password for an existing user. AP_ADD_PROFILES Add to the profiles for an existing user. user_id User identifier. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces. Some CPI-C implementations have a maximum user ID length of 8 characters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_USERID_PASSWORD ID and password. Whatever value the application supplies for this parameter is immediately replaced by the encrypted version of the password. Therefore, the value supplied for the password_chars.password parameter is never written out. password_chars.profiles Profile names associated with the user ID and password. Each of these is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_USERID_PASSWORD was not valid. AP_INVALID_PROFILE One or more of the specified profiles was not valid. AP_INVALID_UPDATE_TYPE The define_type parameter was not set to a valid value. AP_INVALID_USERID The user_id parameter contained a character that was not valid. AP_NO_PROFILES The verb was used to add profiles to an existing user, but no profiles were specified. AP_TOO_MANY_PROFILES The profile_count parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_ADJACENT_LEN_NODE DELETE_ADJACENT_LEN_NODE DELETE_ADJACENT_LEN_NODE removes entries in the node directory database for an adjacent LEN node and its associated LUs, or removes LU entries for the LEN node without removing the LEN node itself. It is equivalent to issuing a series of DELETE_DIRECTORY_ENTRY verbs for the LEN node and its associated LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_ADJACENT_LEN_NODE string, right-padded with EBCDIC spaces. Do not specify any LU names if you are deleting the entire LEN node definition (if num_of_lus is zero). You can specify a “wildcard” LU name to match multiple LU names, by specifying only the initial characters of the name. For example, the wildcard LU name APPN.LU will match APPN.LUNAME or APPN.LU01 (but will not match APPN.NAMELU).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_ADJACENT_LEN_NODE AP_INVALID_LU_NAME One or more of the specified LU names contained a character that was not valid. AP_INVALID_NUM_LUS The num_of_lus parameter was not in the valid range. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_CP_NAME The specified CP name does not exist.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_BACKUP DELETE_BACKUP An application uses this verb to delete a server from the list of backup master servers in the sna.net file, so that this server can no longer act as the master configuration file server. You can use this verb to delete any server in the list, including the master server, whether or not the SNA software is running on the server you are deleting.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_BACKUP primary_rc AP_OK secondary_rc Not used. Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_RECORD_NOT_FOUND The server name specified is not listed in the file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_CN DELETE_CN DELETE_CN deletes a connection network, or deletes selected ports from a connection network. This verb is valid only at an end node, and not at a LEN node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_CN zero), these names must be set to binary zeros.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_COS DELETE_COS DELETE_COS deletes a class of service entry. Only locally defined classes of service can be deleted; the default classes of service defined by SNA cannot be deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_COS Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_COS_NAME_NOT_DEFD The supplied name is not the name of a COS defined on the SNAplus2 system. AP_SNA_DEFD_COS_CANT_BE_DELETE The supplied name is the name of one of the SNA-defined classes of service, which cannot be deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_CPIC_SIDE_INFO DELETE_CPIC_SIDE_INFO This verb deletes an entry from the side information table. Note the difference between this verb and the CPI-C function Delete_CPIC_Side_Information(). This verb modifies a configuration file, so that it affects all SNAplus2 CPI-C applications. The CPI-C function modifies the application's own copy in memory of the side information table, and does not affect any other CPI-C applications.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_CPIC_SIDE_INFO parameters: primary_rc AP_OK Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc AP_INVALID_SYM_DEST_NAME The sym_dest_name parameter was not the name of a defined CPI-C side information entry.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DIRECTORY_ENTRY DELETE_DIRECTORY_ENTRY DELETE_DIRECTORY_ENTRY deletes an entry in the Network Directory. If the entry for a parent resource is deleted, then all entries for child resources associated with it are also deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DIRECTORY_ENTRY End node or LEN node AP_NNCP_RESOURCE Network node AP_LU_RESOURCE LU AP_WILDCARD_LU_RESOURCE Wildcard LU name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DLC DELETE_DLC DELETE_DLC deletes a DLC. This verb also deletes the following: • All ports, link stations and connection network TGs associated with the DLC • All PUs associated with LSs on the DLC, all LUs owned by these PUs, and all LU-LU passwords associated with these LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DLC returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_DLC_NAME The supplied DLC name was not the name of a DLC defined on the SNAplus2 system. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DOWNSTREAM_LU DELETE_DOWNSTREAM_LU This verb is used to delete a downstream LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DOWNSTREAM_LU The dslu_name parameter contained a character that was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DOWNSTREAM_LU_RANGE DELETE_DOWNSTREAM_LU_RANGE This verb is used to delete a range of downstream LUs. The supplied parameters to this verb include a base name for the LUs and the range of NAU addresses. The LU names to be deleted are determined by combining the base name with the NAU addresses. For example, a base name of LUNME combined with a NAU range of 11 to 14 would delete the LUs LUNME011, LUNME012, LUNME013, and LUNME014.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DOWNSTREAM_LU_RANGE name. min_nau NAU address of the first LU, in the range 1-255. max_nau NAU address of the last LU, in the range 1-255.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DOWNSTREAM_LU_RANGE range. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DSPU_TEMPLATE DELETE_DSPU_TEMPLATE The DELETE_DSPU_TEMPLATE verb deletes a specific downstream physical unit (DSPU) template that was previously defined using a DEFINE_DSPU_TEMPLATE verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DSPU_TEMPLATE max_nau Maximum NAU address in the range of DSLU templates to be deleted. Specify a value in the range 1-255. allow_timeout Specifies whether SNAplus2 is allowed to timeout host LUs used by this downstream LU if the session is left inactive for the timeout period specified on the host LU definition. Possible values are: AP_YES SNAplus2 is allowed to timeout host LUs used by this downstream LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_DSPU_TEMPLATE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_TEMPLATE_NAME The template specified by the template_name parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_EMULATOR_USER DELETE_EMULATOR_USER DELETE_EMULATOR_USER is used to do one of the following: • Delete a user of the 3270 emulation program or 5250 emulation program, so that this user can no longer use the program. • Delete one or more of the user's sessions but leave the user configured. This verb must be issued to the domain configuration file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_EMULATOR_USER leave other sessions configured, specify the number of sessions that are being deleted. Each of these must be defined by its session name, as described below. • To delete all sessions, or to delete the user, specify zero in this parameter and do not include any session names. Specify the type of deletion required in the delete_options parameter below.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_EMULATOR_USER primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_EMULATOR_USER The specified user name was not defined as an emulation program user name. AP_INVALID_USER_SESSION The specified session name did not match the name of a session defined for this user.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_FOCAL_POINT DELETE_FOCAL_POINT The DELETE_FOCAL_POINT verb removes the definition of a focal point for a specified MS category (either the main focal point for that category or a backup focal point). If the defined focal point application is active and acting as the current focal point for that category, SNAplus2 sends an MS_CAPABILITIES message to the focal point to revoke it so that it no longer acts as the focal point.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_FOCAL_POINT AP_ACTIVE The currently active focal point (which may be of any type) is revoked. AP_IMPLICIT The implicit definition (defined using DEFINE_FOCAL_POINT with backup set to AP_NO) is removed. If this focal point is currently active, then it is revoked. AP_BACKUP The backup definition (defined using DEFINE_FOCAL_POINT with backup set to AP_YES) is removed. If this focal point is currently active, then it is revoked.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_FOCAL_POINT Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node configuration does not support it, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support MS network management functions; this is defined by the mds_supported parameter on the DEFINE_NODE verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_INTERNAL_PU DELETE_INTERNAL_PU DELETE_INTERNAL_PU deletes a DLUR-served local PU. The PU can be deleted only if it does not have an active SSCP-PU session.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_INTERNAL_PU The pu_name parameter was not the name of a defined internal PU. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_PU_NOT_RESET The PU cannot be deleted because it still has an active PU-SSCP session. AP_INVALID_PU_TYPE The specified PU is a remote PU and not an internal PU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LOCAL_LU DELETE_LOCAL_LU The DELETE_LOCAL_LU verb deletes a local LU, and also deletes any LU-LU passwords associated with the local LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LOCAL_LU secondary_rc Possible values are: AP_CANT_DELETE_CP_LU The supplied LU name was blank (indicating the LU associated with the CP); this LU cannot be deleted. AP_INVALID_LU_NAME The supplied LU name is not the name of a local LU defined on the SNAplus2 system. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LS DELETE_LS DELETE_LS deletes a defined Link Station (LS). This verb also deletes the PU associated with the LS, all LUs owned by this PU, and all LU-LU passwords associated with these LUs. The LS cannot be deleted if it is active.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LS primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_LINK_NAME The supplied LS name contains a character that was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU62_TIMEOUT DELETE_LU62_TIMEOUT The DELETE_LU62_TIMEOUT verb deletes a definition of an LU type 6.2 session timeout that was defined previously with a DEFINE_LU62_TIMEOUT verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU62_TIMEOUT AP_MODE_TIMEOUT Delete timeouts that apply to all LU 6.2 sessions on the mode specified in the resource_name parameter. resource_name Name of the resource whose timeout is being deleted. This value can be one of the following: • If resource_type is set to AP_GLOBAL_TIMEOUT, do not specify this parameter. • If resource_type is set to AP_LOCAL_LU_TIMEOUT, specify 1-8 locally displayable type-A characters as a local LU name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU62_TIMEOUT The LU name specified in the resource_name parameter was not valid. AP_INVALID_PARTNER_LU The partner LU name specified in the resource_name parameter was not valid. AP_INVALID_MODE_NAME The mode name specified in the resource_name parameter was not valid. AP_GLOBAL_TIMEOUT_NOT_DEFINED The value AP_GLOBAL_TIMEOUT was specified for the resource_type parameter but there is no defined global timeout.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3 DELETE_LU_0_TO_3 This verb is used to delete an LU used for 3270 emulation or LUA (an LU of type 0-3).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3 secondary_rc AP_INVALID_LU_NAME The supplied LU name contained a character that was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3_RANGE DELETE_LU_0_TO_3_RANGE This verb is used to delete a range of LUs used for 3270 emulation or LUA (type 0-3 LUs). The supplied parameters to this verb include a base name for the LUs and the range of NAU addresses. The LU names to be deleted are determined by combining the base name with the NAU addresses. For example, a base name of LUNME combined with a NAU range of 11-14 would delete the LUs LUNME011, LUNME012, LUNME013, and LUNME014.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3_RANGE on the right with EBCDIC spaces if the base name is less than 5 characters. SNAplus2 determines the names of the LUs to be deleted by appending the 3-digit decimal value of each NAU address to this name. min_nau NAU address of the first LU, in the range 1-255. max_nau NAU address of the last LU, in the range 1-255. name_attributes Specifies the extension type of the LUs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3_RANGE Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_NAU_ADDRESS The min_nau or max_nau parameter was not valid. AP_INVALID_LU_NAME The base_name parameter contained a character that was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_LU_PASSWORD DELETE_LU_LU_PASSWORD DELETE_LU_LU_PASSWORD deletes an LU-LU password associated with a local LU. LU-LU passwords are deleted automatically when the local LU is deleted; you need only use this verb if you need to remove the password but leave the LU configured.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_LU_PASSWORD fqplu_name Fully qualified LU name for the partner LU, as defined to SNAplus2. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_POOL DELETE_LU_POOL DELETE_LU_POOL is used to do one of the following: • Remove one or more LUs from a pool • Remove all LUs from a pool and delete the pool This verb does not delete the LUs; they remain defined, but are not associated with any pool.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_POOL removed. The number of names specified must match the num_lus parameter. Each name is an 8-byte type A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the name is shorter than 8 characters. If num_lus is set to zero, to remove all LUs from the pool and delete the pool, this parameter is not used.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_MODE DELETE_MODE DELETE_MODE deletes the definition of a mode. You cannot delete SNA-defined modes such as SNASVCMG and CPSVCMG.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_MODE secondary_rc Possible values are: AP_CP_OR_SNA_SVCMG_UNDELETABLE The specified mode name is one of the SNA-defined mode names, and cannot be deleted. AP_MODE_NAME_NOT_DEFD The specified mode name is not the name of a mode defined on the SNAplus2 system. AP_DEL_MODE_DEFAULT_SPCD The specified mode was defined as the default mode using the DEFINE_DEFAULTS verb, so it cannot be deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_PARTNER_LU DELETE_PARTNER_LU The DELETE_PARTNER_LU verb deletes a partner LU definition.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_PARTNER_LU primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_PLU_NAME The supplied fqplu_name parameter did not match any defined partner LU name. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_PORT DELETE_PORT DELETE_PORT deletes a port. This verb also deletes the following: • All link stations and connection network TGs associated with the port. • All PUs associated with LSs on the port, all LUs owned by these PUs, and all LU-LU passwords associated with these LUs. The port must be inactive when the verb is issued.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_PORT Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_PORT_NAME The specified port name was not the name of a port defined on the SNAplus2 system. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_RCF_ACCESS DELETE_RCF_ACCESS DELETE_RCF_ACCESS prevents access to the SNAplus2 Remote Command Facility (RCF), which was previously specified using DEFINE_RCF_ACCESS. For more information about RCF, see the HP-UX SNAplus2 Administration Guide. This verb prevents access to both SPCF and UCF. To allow access to one of them but prevent access to the other, use DEFINE_RCF_ACCESS. This verb must be issued to the domain configuration file.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_RCF_ACCESS Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_RJE_WKSTN DELETE_RJE_WKSTN DELETE_RJE_WKSTN deletes an RJE workstation. Before deleting the workstation, check with the users of the workstation to ensure that it is not being used. If you delete a workstation while it is running, the only RJE commands that will subsequently be accepted for that workstation are the commands to stop the workstation and to clear out its directory structure.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_RJE_WKSTN Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_WORKSTATION_NAME The specified workstation_name parameter did not match any RJE workstation name. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_SECURITY_ACCESS_LIST DELETE_SECURITY_ACCESS_LIST DELETE_SECURITY_ACCESS_LIST is used to do one of the following: • Delete a security access list. • Delete one or more users from a security access list but leave the list configured. You can delete a user name from the security access list regardless of whether there are active conversations that were set up using that user name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_SECURITY_ACCESS_LIST Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_SECURITY_ACCESS_LIST list_name The name of the security access list being deleted, or the list from which user names are being deleted. This is an ASCII string of 1 - 14 characters, padded on the right with spaces if the name is shorter than 14 characters, which must match a previously-defined security access list name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_SECURITY_ACCESS_LIST primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LIST_NAME The specified security access list name was to defined as a security access list name. AP_INVALID_USER_NAME One or more of the specified user names did not match the name of a user defined for this security access list.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS DELETE_TN3270_ACCESS DELETE_TN3270_ACCESS is used to do one of the following: • Delete a TN3270 user, so that this user can no longer use TN server to access a host. • Delete one or more of the user's sessions but leave the user configured.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS TN3270 user record that is used by any TN3270 user not explicitly identified by a TCP/IP address (deleting this record means that such users cannot access TN server). Possible values are: AP_YES This verb refers to the default TN3270 user record. The client_address parameter is reserved. AP_NO This verb refers to a normal TN3270 user record. client_address The TCP/IP address of the TN3270 user to be deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS configured. AP_DELETE_USER Delete the user and all the user's sessions. For each session to be deleted, up to the number specified in num_sessions, the following parameter is required: tn3270_session_name.port_number The TCP/IP port number used for the session. This must match a port number defined for this TN3270 user.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ASSOCIATION DELETE_TN3270_ASSOCIATION DELETE_TN3270_ASSOCIATION deletes an association between a display LU and a printer LU, given the display LU name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ASSOCIATION primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_LU_NAME The display LU name was not a valid EBCDIC string. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TP DELETE_TP DELETE_TP deletes a TP definition.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TP defined TP. AP_SYSTEM_TP_CANT_BE_DELETED The specified TP name is the name of a TP used internally by SNAplus2 you cannot delete it. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TP_LOAD_INFO DELETE_TP_LOAD_INFO The DELETE_TP_LOAD_INFO verb deletes a TP load information entry.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TP_LOAD_INFO returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_TP_NAME The tp_name parameter did not match the name of a defined TP. AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined LU alias specified for a TP load info entry for the TP name specified.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_USERID_PASSWORD DELETE_USERID_PASSWORD DELETE_USERID_PASSWORD deletes a password associated with a user ID, or removes profiles for a user ID and password.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_USERID_PASSWORD Delete the user, password, and all associated profiles. AP_REMOVE_PROFILES Delete the specified profiles. user_id User identifier. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces if the name is shorter than 10 characters. password_chars.description This parameter is ignored. password_chars.profile_count Number of profiles to be deleted.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_USERID_PASSWORD The delete_type parameter was set to AP_REMOVE_PROFILES, but no profiles were specified. AP_UNKNOWN_USER The user_id parameter did not match a defined user ID. AP_INVALID_UPDATE_TYPE The delete_type parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DISCONNECT_NODE DISCONNECT_NODE An application uses this verb to release its handle to a SNAplus2 node when it has finished issuing NOF verbs to the node. The node from which the application wishes to disconnect is identified by the target_handle parameter on the call. After the verb completes successfully, the target handle identifying the node is no longer valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DISCONNECT_NODE Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters: primary_rc AP_STATE_CHECK secondary_rc AP_VERB_IN_PROGRESS The specified target handle cannot be released because a previous verb issued for this handle is still outstanding. All verbs for the target handle must be completed before attempting to disconnect from the node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INIT_NODE INIT_NODE This verb starts a previously-defined node. The application must first issue CONNECT_NODE to obtain a target handle for the node; it then uses this target handle on the INIT_NODE call to identify the node to start. This verb must be issued to a server where the node is not running.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INIT_NODE secondary_rc Possible values are: AP_INVALID_NODE_NAME The node name specified in the configuration file does not match the name of the SNAplus2 computer to which the verb was issued. AP_NOT_SERVER The node name specified in the configuration file matches the name of the SNAplus2 computer, but the specified computer is a client (not a server) and cannot run the node.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INIT_NODE codes associated with AP_STATE_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT INITIALIZE_SESSION_LIMIT The INITIALIZE_SESSION_LIMIT verb initializes the session limits for a combination of local LU, partner LU, and mode. You must issue this verb before you issue an ACTIVATE_SESSION verb.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT lu_name LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is defined by its LU alias instead of its LU name, set this parameter to 8 binary zeros. lu_alias LU alias of the local LU, as defined to SNAplus2.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT set_negotiable Specifies whether the maximum negotiable session limit for this mode, as defined by DEFINE_MODE, should be modified. Possible values are: AP_YES Use the value specified by plu_mode_session_limit as the maximum negotiable session limit for this LU-LU-mode combination. AP_NO Leave the maximum negotiable session limit as the value specified for the mode.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT contention winner sessions for the local LU. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Possible values are: AP_AS_NEGOTIATED The session limits were initialized, but one or more values were negotiated by the partner LU. AP_AS_SPECIFIED The session limits were initialized as requested, without being negotiated by the partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias. AP_INVALID_LU_NAME The lu_name parameter did not match any defined local LU name. AP_INVALID_MODE_NAME The mode_name parameter did not match any defined mode name. AP_INVALID_PLU_NAME The fqplu_name parameter did not match any defined partner LU name. AP_INVALID_SET_NEGOTIABLE The set_negotiable parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT Returned Parameters: Session Allocation Error If the verb does not execute because of a session allocation error, SNAplus2 returns the following parameters: primary_rc AP_ALLOCATION_ERROR secondary_rc AP_ALLOCATION_FAILURE_NO_RETRY A session could not be allocated because of a condition that requires corrective action.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE OPEN_FILE An application uses this verb to access the SNAplus2 domain configuration file in order to manage domain resources, or to access the sna.net file in order to manage backup master servers on the SNAplus2 LAN. The application should always issue CLOSE_FILE for any open file handles before it exits This verb must be issued with a null target handle.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE file_info.requested_role The type of file to be opened. Possible values are: AP_MASTER Open the master copy of the domain configuration file. This value must be used if the application intends to issue verbs that modify the configuration of domain resources. AP_BACKUP Open the master copy of the domain configuration file if available, otherwise a backup copy.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE AP_MASTER Master configuration file. AP_BACKUP Backup configuration file. For all other values of requested_role, this parameter is undefined. file_info.system_name Name of the SNAplus2 computer where the file is located. file_info.file_name Name of the file. This parameter is an ASCII string of 1-80 characters, followed by a null (0x00) character.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_CONNECTION_NOT_MADE SNAplus2 could not set up the local communications path to the file. AP_FILE_BAD_RECORD SNAplus2 detected an error in the configuration file. Check the error log file for a message giving more details of the error.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE of the SNAplus2 software. If you have upgraded your SNAplus2 license to include additional functions or users, check that you are using the correct version of the licensing software. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE 486 Chapter 3
4 NOF API Verbs (QUERY Verbs) Chapter 4 487
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG QUERY_3270_DIAG QUERY_3270_DIAG returns information about the 3270 diagnostics parameters for the SNAplus2 system. It always returns information about the parameters used to record and display response-time data; depending on the options used, it can also return data on a 3270 user alert that users can send to the host NetView program, or on multiple alerts. This verb must be issued to the domain configuration file.
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 } DIAG_3270_DATA; rtm_thresh2; rtm_thresh3; rtm_thresh4; num_alerts; typedef struct alert_3270_data { unsigned char description[53]; unsigned char parameter1[33]; unsigned char parameter2[33]; unsigned char parameter3[33]; } ALERT_3270_DATA; /* /* /* /* RTM threshold #2 RTM threshold #3 RTM threshold #4 Number of user alerts */ */ */ */ /* /* /* /* description parameter 1 parameter 2 parameter 3 */ */ */ */ Supplied
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the alert_number parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the alert_number parameter. For more information about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”. If no alerts have been defined, this parameter must be set to AP_FIRST_IN_LIST.
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG The number of alert entries actually returned. diag_3270_data Data structure containing 3270 diagnostics information. The format of this information is the same as for the DEFINE_3270_DIAG verb. For each alert, up to the number specified in num_entries, an alert_3270_data structure is included. The format of the information in this structure is the same as for the DEFINE_3270_DIAG verb.
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER QUERY_3270_USER QUERY_3270_USER returns information about users of the SNAplus2 3270 emulation program. It can return either summary or detailed information, about a single user or multiple users, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER } USER_3270_SUMMARY; typedef struct user_3270_detail { AP_UINT16 overlay_size; unsigned char user_name[32]; unsigned char system_name[64]; AP_UINT32 user_pid; AP_UINT32 reserv1; AP_UINT32 user_uid; AP_UINT32 user_gid; unsigned char user_gname[32]; AP_UINT32 user_session_count; AP_UINT32 user_start_time; /* /* /* /* /* /* /* /* /* /* /* size of returned entry 3270 user name computer name process ID reserved user ID group ID group name count of user's 3270 session
NOF API Verbs (QUERY Verbs) QUERY_3270_USER will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only. AP_DETAIL Detailed information.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER AP_USER Return information about all 3270 emulation programs running with the specified user name, or on all 3270 users if no name is specified. AP_SYSTEM Return information about 3270 emulation programs running on the specified computer. AP_USER_AT_SYSTEM Return information about all 3270 emulation programs running with the specified 3270 user name on the specified computer.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER AP_FIRST_IN_LIST. If this parameter is specified and you are running SNAplus2 in a client-server configuration, the system_name parameter must also be specified. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the buffer.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER user_3270_summary.user_pid The process ID of the 3270 emulation program. user_3270_detail.overlay_size The size of the returned user_3270_detail structure, and therefore the offset to the start of the next entry in the data buffer. user_3270_detail.user_name The name of the 3270 user. This is an ASCII string of 1-32 characters. user_3270_detail.system_name The computer name on which the 3270 emulation program is running. user_3270_detail.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER year 1970). Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_3270_USER The user_name, system_name, or user_pid parameter was not set to a valid value. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS QUERY_3270_USER_SESSIONS QUERY_3270_USER returns information about a 3270 emulation user's current sessions. It can return either summary or detailed information, about a single session or multiple sessions, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char nau_address; AP_UINT32 reserv1[3]; } USER_3270_SESSION_DETAIL; /* /* /* /* size of returned entry LU used by session NAU adddress of LU reserved */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_3270_USER_SESSIONS overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS Summary information only. AP_DETAIL Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first session in the list. AP_LIST_INCLUSIVE Start at the entry specified by the lu_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the lu_name parameter.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS If the SNAplus2 system includes only one server, this parameter is required only if the user is using more than one copy of the 3270 emulation program.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS The computer name on which the 3270 emulation program is running. user_pid The process ID of the 3270 emulation program. Each entry in the data buffer consists of the following: user_3270_session_summary.overlay_size The size of the returned user_3270_session_summary structure, and therefore the offset to the start of the next entry in the data buffer. user_3270_session_summary.lu_name The LU being used by the session. user_3270_session_detail.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION QUERY_ACTIVE_TRANSACTION QUERY_ACTIVE_TRANSACTION returns information about active Multiple Domain Support (MDS) transactions known to the SNAplus2 Management Services component. An active transaction is an MDS request for which a reply has not yet been received. This verb may be used to obtain information about a single transaction, or on multiple transactions, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION unsigned char fq_req_loc_cp_name[17]; unsigned char req_agent_appl_name[8]; unsigned char seq_num_dt[17]; unsigned char reserva[20]; } ACTIVE_TRANSACTION_DATA; /* /* /* /* /* /* fq cp name of transaction requestor appl name of transaction requestor sequence number date/time reserved */ */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_ACTIVE_TRANSACTION overlay_size For compatability with futur
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the fq_req_loc_cp_name, req_agent_appl_name, and seq_num_dt parameters. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the fq_req_loc_cp_name, req_agent_appl_name, and seq_num_dt parameters. The list is ordered by fq_req_loc_cp_name, then by req_agent_appl_name, and finally in numerical order of seq_num_dt.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION of the original transaction, as defined in the IBM SNA Formats manual. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION dot (period) character, and a network name of up to 8 A-string characters. active_transaction_data.origin_ms_appl_name Application name of the origin for the transaction.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION 0-9); alternatively, it can be one of the MS Discipline-Specific Application Programs specified in Systems Network Architecture: Management Services Reference (see “Related Publications”). active_transaction_data.seq_num_dt Sequence number date/time correlator (17 bytes long) of the original transaction, as defined in the IBM SNA Formats manual.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP QUERY_AVAILABLE_TP QUERY_AVAILABLE_TP returns information about active invokable TPs (APPC applications that have issued the RECEIVE_ALLOCATE verb, or CPI-C applications that have issued the Accept_Conversation or Accept_Incoming call). This verb can be used to obtain information about a specific TP or about multiple TPs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_AVAILABLE_TP overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof()function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP name. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. tp_name TP name. This is a 64-byte string, padded on the right with spaces if the name is shorter than 64 characters. This value is ignored if list_options is set to AP_FIRST_IN_LIST. system_name The computer name for which TP information is required.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: available_tp_data.overlay_size The size of the returned available_tp_data structure, and therefore the offset to the start of the next entry in the data buffer. available_tp_data.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_BCK_CS_TRACE QUERY_BCK_CS_TRACE This verb returns information about the current options for back-level client-server tracing (tracing of data sent between a current-level SNAplus2 server and a back-level server or client).
NOF API Verbs (QUERY Verbs) QUERY_BCK_CS_TRACE trace_flags The types of tracing currently active. If no tracing is active, this is set to AP_BCK_NO_TRACE. If tracing is being used on specific interfaces, this parameter is set to one or more values from the list below, combined using a logical OR operation.
NOF API Verbs (QUERY Verbs) QUERY_BUFFER_AVAILABILITY QUERY_BUFFER_AVAILABILITY This verb returns information about the amount of STREAMS buffers that SNAplus2 is currently using, the maximum amount it has used, and the maximum amount available (specified using the SET_BUFFER_AVAILABILITY verb). This allows you to check STREAMS buffer usage and set the limit appropriately, to ensure that sufficient buffers are available for SNAplus2 components and for other programs on the HP-UX computer.
NOF API Verbs (QUERY Verbs) QUERY_BUFFER_AVAILABILITY AP_UINT32 max_peak_usage; unsigned char max_throttle_status; unsigned char max_buf_use_status; unsigned char debug_param[32]; } QUERY_BUFFER_AVAILABILITY; /* /* /* /* maximum peak usage maximum throttle status maximum congestion status reserved */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_BUFFER_AVAILABILITY reset_max_values Specify whether SNAplus2 should reset the values for the max_* paramete
NOF API Verbs (QUERY Verbs) QUERY_BUFFER_AVAILABILITY Not used. buf_avail The maximum amount of STREAMS buffer space available to SNAplus2, in bytes, as defined by a SET_BUFFER_AVAILABILITY verb. buf_total_count The number of buffers currently allocated to SNAplus2 components. buf_total_bytes The total amount of storage in buffers currently allocated to SNAplus2 components. buf_rsrv_count The total number of buffers reserved. buf_rsrv_bytes The total amount of storage in buffers reserved, in bytes.
NOF API Verbs (QUERY Verbs) QUERY_BUFFER_AVAILABILITY AP_UNCONGESTED max_buf_total_count The maximum number of buffers that have been allocated to SNAplus2 components at any time. max_buf_total_bytes The maximum amount of buffer storage that has been allocated to SNAplus2 components at any time. max_buf_rsrv_count The maximum number of buffers that can be reserved. max_buf_rsrv_bytes The maximum amount of buffer storage that can be reserved, in bytes.
NOF API Verbs (QUERY Verbs) QUERY_CENTRAL_LOGGER QUERY_CENTRAL_LOGGER This verb returns the name of the node currently defined as the central logger (the node holding the central log file to which SNAplus2 log messages from all servers are sent). This verb does not return information about whether central logging is active; use QUERY_CENTRAL_LOGGING to determine this. This verb must be issued with a null target handle.
NOF API Verbs (QUERY Verbs) QUERY_CENTRAL_LOGGER the following parameters: primary_rc AP_STATE_CHECK secondary_rc AP_NO_CENTRAL_LOG No master server is currently active. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_CENTRAL_LOGGING QUERY_CENTRAL_LOGGING This verb returns information about whether SNAplus2 log messages are sent to a central file from all servers, or to a separate file on each server. For more information, see “SET_LOG_FILE”. This verb must be issued to the node that is currently acting as the central logger; for information about accessing this node, see “CONNECT_NODE”.
NOF API Verbs (QUERY Verbs) QUERY_CENTRAL_LOGGING a single file on the node currently acting as the central logger. AP_NO Central logging is disabled. Log messages from each server are sent to a file on that server (specified using the SET_LOG_FILE verb).
NOF API Verbs (QUERY Verbs) QUERY_CN QUERY_CN QUERY_CN returns information about adjacent Connection Networks. This information is structured as “determined data” (data gathered dynamically during execution) and “defined data” (the data supplied by the application on DEFINE_CN). This verb can be used to obtain information about a specific connection network, or about multiple connection networks, depending on the options used. It can be issued only at an end node; it is not valid at a LEN node.
NOF API Verbs (QUERY Verbs) QUERY_CN AP_UINT16 unsigned char } CN_DET_DATA; num_act_ports; reserva[20]; typedef struct cn_def_data { unsigned char description[32]; unsigned char reserve0[16]; unsigned char num_ports; unsigned char reserve1[16]; TG_DEFINED_CHARS tg_chars; } CN_DEF_DATA; typedef struct tg_defined_chars { unsigned char effect_cap; unsigned char reserve1[5]; unsigned char connect_cost; unsigned char byte_cost; unsigned char reserve2; unsigned char security; unsigned char prop_delay; unsigned
NOF API Verbs (QUERY Verbs) QUERY_CN a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list of CNs from which SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the fqcn_name parameter.
NOF API Verbs (QUERY Verbs) QUERY_CN buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_CN encoded as a 1-byte floating point number, represented by the formula 0.1 mmm * 2 eeeee where the bit representation of the byte is eeeeemmm. Each unit of effective capacity is equal to 300 bits per second. cn_data.def_data.tg_chars.connect_cost Cost per connect time. Valid values are integer values in the range 0-255, where 0 is the lowest cost per connect time and 255 is the highest. cn_data.def_data.tg_chars.byte_cost Cost per byte.
NOF API Verbs (QUERY Verbs) QUERY_CN AP_SEC_MAXIMUM Maximum security. cn_data.def_data.tg_chars.prop_delay Propagation delay: the time that a signal takes to travel the length of the link. Possible values are: AP_PROP_DELAY_MINIMUM Minimum propagation delay. AP_PROP_DELAY_LAN Delay is less than 480 microseconds (typical for a LAN). AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network).
NOF API Verbs (QUERY Verbs) QUERY_CN secondary_rc Possible values are: AP_INVALID_CN_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the fqcn_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_CN_PORT QUERY_CN_PORT QUERY_CN_PORT returns information about ports defined on an adjacent Connection Network. This verb can be used to obtain information about a specific port, or about multiple ports, depending on the options used. It can be issued only at an end node; it is not valid at a LEN node.
NOF API Verbs (QUERY Verbs) QUERY_CN_PORT opcode AP_QUERY_CN_PORT overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof()function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of ports for which data should be returned.
NOF API Verbs (QUERY Verbs) QUERY_CN_PORT port_name Name of the port for which information is required, or the name to be used as an index into the list of ports. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_CN_PORT network name of 1-8 A-string characters. cn_port_data.port_name Name of the port. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. cn_port_data.tg_num Transmission group number for the specified port.
NOF API Verbs (QUERY Verbs) QUERY_CN_PORT Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node is a LEN node, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node is a LEN node. This verb is valid only at an end node. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION QUERY_CONVERSATION QUERY_CONVERSATION returns information about conversations using a particular local LU. This verb can be used to obtain information about a specific conversation or a range of conversations, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION unsigned char } CONV_SUMMARY; reserv1; /reserved */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_CONVERSATION buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of conversations for which data should be returned. To request data for a specific conversation rather than a range, specify the value 1.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION specified by the combination of local LU and conversation ID. The combination of the local LU (lu_name or lu_alias and conversation ID (conv_id) specified is used as an index into the list of sessions if the list_options parameter is set to AP_LIST_INCLUSIVE or AP_LIST_FROM_NEXT. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. lu_name LU name.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION about conversations associated with a specific session, specify the session identifier. To obtain a complete list for all sessions, set this field to binary zeros. Returned Parameters: Successful Execution If the verb executes successfull, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION returned overlay may increase in furutre releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. conv_summary.conv_id Conversation identifier. The conversation ID was returned by the ALLOCATE verb in the invoking TP, or by the RECEIVE_ALLOCATE verb in the invoked TP. conv_summary.local_tp_name The name of the local TP in the conversation. conv_summary.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION The current state of the conversation.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_COS QUERY_COS QUERY_COS returns route calculation information for a specific class of service (COS). This verb can be used to obtain information about a specific COS or about multiple COSs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_COS Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_COS overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_COS specified by the cos_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. cos_name Class of service name for which data is required, or the name to be used as an index into the list. This value is ignored if list_options is set to AP_FIRST_IN_LIST.
NOF API Verbs (QUERY Verbs) QUERY_COS The size of the returned cos_data structure, and therefore the offset to the start of the next entry in the data buffer. cos_data.cos_name Class of service name. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. cos_data.description A null-terminated text string describing the COS, as specified in the definition of the COS. cos_data.transmission_priority Transmission priority.
NOF API Verbs (QUERY Verbs) QUERY_COS service. Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_COS_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the cos_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW QUERY_COS_NODE_ROW QUERY_COS_NODE_ROW returns node row information for a specified class of service as previously defined by DEFINE_COS (or implicitly by the node for the SNA-defined COSs). This verb can be used to obtain information about a specific COS node row, or about multiple COS node rows, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW unsigned char } COS_NODE_ROW; reserv1; typedef struct cos_node_status { unsigned char rar; unsigned char status; unsigned char reserv1[2]; } COS_NODE_STATUS; /* reserved */ /* route additional resistance /* node status /* reserved */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_COS_NODE_ROW overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine t
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the combination of the cos_name and node_row_index parameters. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of the cos_name and node_row_index parameters. The list is ordered by cos_name, and then by node_row_index for each COS.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW one of the other values listed, or to two or more of the other values combined using a logical OR. Possible values are: AP_UNCONGESTED The number of ISR sessions is below the isr_sessions_upper_threshold value in the node's configuration. AP_CONGESTED The number of ISR sessions exceeds the threshold value. AP_IRR_DEPLETED The number of ISR sessions has reached the maximum specified for the node.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW The number of ISR sessions exceeds the threshold value. AP_IRR_DEPLETED The number of ISR sessions has reached the maximum specified for the node. AP_ERR_DEPLETED The number of endpoint sessions has reached the maximum specified. AP_QUIESCING A STOP_NODE of type AP_QUIESCE or AP_QUIESCE_ISR has been issued. cos_node_row_data.node_row.weight Weight associated with this node row.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW QUERY_COS_TG_ROW QUERY_COS_TG_ROW returns TG row information for a specified class of service as previously defined by DEFINE_COS (or implicitly by the node for the SNA-defined COSs). This verb can be used to obtain information about a specific COS TG row, or about multiple COS TG rows, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW unsigned char } COS_TG_ROW; reserv1; typedef struct tg_defined_chars { unsigned char effect_cap; unsigned char reserve1[5]; unsigned char connect_cost; unsigned char byte_cost; unsigned char reserve2; unsigned char security; unsigned char prop_delay; unsigned char modem_class; unsigned char user_def_parm_1; unsigned char user_def_parm_2; unsigned char user_def_parm_3; } TG_DEFINED_CHARS; /* reserved */ /* /* /* /* /* /* /* /* /* /* /* */ */ */ */ */ */ */ *
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list of COS TG rows from which SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the combination of the cos_name and tg_row_index parameters.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW cos_tg_row_data.tg_row.minimum.effect_cap Minimum limit for actual bits per second rate (line speed). The value is encoded as a 1-byte floating point number, represented by the formula 0.1 mmm * 2 eeeee where the bit representation of the byte is b'eeeeemmm'. Each unit of effective capacity is equal to 300 bits per second. cos_tg_row_data.tg_row.minimum.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW Data is transmitted over a line that is protected against physical and radiation tapping. cos_tg_row_data.tg_row.minimum.prop_delay Minimum limits for propagation delay: the time that a signal takes to travel the length of the link. Possible values are: AP_PROP_DELAY_MINIMUM Minimum propagation delay. AP_PROP_DELAY_LAN Delay is less than 480 microseconds (typical for a LAN).
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW speed). The value is encoded as a 1-byte floating point number, represented by the formula 0.1 mmm * 2 eeeee where the bit representation of the byte is eeeeemmm. Each unit of effective capacity is equal to 300 bits per second. cos_tg_row_data.tg_row.maximum.connect_cost Maximum limit for cost per connect time; an integer value in the range 0-255, where 0 is the lowest cost per connect time and 255 is the highest. cos_tg_row_data.tg_row.maximum.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW AP_SEC_MAXIMUM Maximum security. cos_tg_row_data.tg_row.maximum.prop_delay Maximum limits for propagation delay: the time that a signal takes to travel the length of the link. Possible values are: AP_PROP_DELAY_MINIMUM Minimum propagation delay. AP_PROP_DELAY_LAN Delay is less than 480 microseconds (typical for a LAN). AP_PROP_DELAY_TELEPHONE Delay is in the range 480-49,512 microseconds (typical for a telephone network).
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_COS_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the cos_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO QUERY_CPIC_SIDE_INFO This verb returns the side information entry for a given symbolic destination name, or for multiple symbolic destination names, depending on the options used. Note the difference between this verb and the CPI-C function Extract_CPIC_Side_Information(). This verb queries a configuration file, so that it returns the default information used by all SNAplus2 CPI-C applications.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO typedef struct cpic_side_info_def_data { unsigned char description[32]; unsigned char reserv1[16]; CPIC_SIDE_INFO side_info; unsigned char reserv2[24]; } CPIC_SIDE_INFO_DEF_DATA; typedef struct cpic_side_info { unsigned char partner_lu_name[17]; unsigned char AP_UINT32 unsigned char unsigned char AP_UINT32 unsigned char unsigned char unsigned char } CPIC_SIDE_INFO; /* /* /* /* /* /* reserved[3]; /* tp_name_type; /* tp_name[64]; /* mode_name[8]; /* conversat
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO num_entries Maximum number of symbolic destination names for which data should be returned. To request data for a specific symbolic destination name rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters. cpic_side_info_data.def_data.side_info.tp_name_type The type of the target TP (the valid characters for a TP name are determined by the TP type). Possible values are: XC_APPLICATION_TP Application TP. All characters in the TP name must be valid ASCII characters. XC_SNA_SERVICE_TP Service TP.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO As for XC_SECURITY_PROGRAM, except that the local node must not send the password across the network in clear text format. (This value is included for compatibility with IBM CPI-C implementations. The SNAplus2 node cannot provide the appropriate restrictions on sending the password; if a CPI-C application attempts to issue the Allocate call with this value set, the call will fail with a return code indicating that the requested security type is not supported.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO AP_PARAMETER_CHECK secondary_rc AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE QUERY_CS_TRACE This verb returns information about the current tracing options for data sent between computers on the SNAplus2 LAN. For more information about tracing options, see the HP-UX SNAplus2 Administration Guide. This verb may be issued to a running node, or to a HP-UX client computer on which the SNAplus2 software is running.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE the target_handle parameter on the NOF API call) and one other server on the LAN, specify the name of the other server here. To query the default tracing options (set by a SET_CS_TRACE verb with no destination system name specified), set this parameter to 64 ASCII space characters. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE AP_CS_DATA Data messages trace_direction Specifies the direction or directions in which tracing is active. This parameter is not used if trace_flags is set to AP_NO_TRACE. Possible values are: AP_CS_SEND Messages flowing from the target computer to the computer defined by dest_sys are traced. AP_CS_RECEIVE Messages flowing from the computer defined by dest_sys to the target computer are traced. AP_CS_BOTH Messages flowing in both directions are traced.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DEFAULT_PU QUERY_DEFAULT_PU QUERY_DEFAULT_PU allows the user to query the default PU (defined using DEFINE_DEFAULT_PU).
NOF API Verbs (QUERY Verbs) QUERY_DEFAULT_PU right with EBCDIC spaces. If this field is set to all binary zeros, this indicates that no DEFINE_DEFAULT_PU verb has been issued or that the default PU has been deleted by issuing a DEFINE_DEFAULT_PU verb with the pu_name parameter specified as all zeros. description A null-terminated text string describing the default PU, as specified in the definition of the default PU. def_pu_sess Name of the PU associated with the currently active default PU session.
NOF API Verbs (QUERY Verbs) QUERY_DEFAULTS QUERY_DEFAULTS QUERY_DEFAULTS allows the user to query the default parameters defined for the node (defined using DEFINE_DEFAULTS).
NOF API Verbs (QUERY Verbs) QUERY_DEFAULTS default_chars.description A null-terminated text string describing the default parameters, as specified in DEFINE_DEFAULTS. default_chars.mode_name Name of the default mode. If an application specifies an unrecognized mode name when attempting to start a session, the parameters from this mode will be used as a default definition for the unrecognized mode. The mode name is an 8-byte type-A EBCDIC string.
NOF API Verbs (QUERY Verbs) QUERY_DEFAULTS conwinner sessions are deactivated. The range is 0-65,535 seconds. Returned Parameters: Node Not Started If the verb does not execute because the node has not yet been started, SNAplus2 returns the following parameter: primary_rc AP_NODE_NOT_STARTED Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY QUERY_DIRECTORY_ENTRY QUERY_DIRECTORY_ENTRY returns information about resources in the directory database. It can return either summary or detailed information, about a specific resource or multiple resources, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY typedef struct directory_entry_summary { AP_UINT16 overlay_size; unsigned char resource_name[17]; unsigned char reserve1; AP_UINT16 resource_type; description description; } DIRECTORY_ENTRY_SUMMARY; typedef struct directory_entry_detail { AP_UINT16 overlay_size; unsigned char resource_name[17] unsigned char reserv1a; AP_UINT16 resource_type; description description; unsigned char parent_name[17]; unsigned char reserv1b; AP_UINT16 parent_type; unsigned char e
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY Size of the supplied data buffer. num_entries Maximum number of resources for which data should be returned. To request data for a specific resource rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY resource_name Fully qualified name of the resource for which information is required, or the name to be used as an index into the list of resources. This value is ignored if list_options is set to AP_FIRST_IN_LIST. 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.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY Resource type of the parent resource. To return only entries belonging to the specified parent, set this parameter to the type of the parent resource; to return all entries, set this parameter to zero.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY directory_entry_summaryThe size of the returned structure, and therefore the offset to the start of the next entry in the data buffer. directory_entry_summary.resource_name Fully qualified name of the resource. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters directory_entry_summary.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY AP_ENCP_RESOURCE End node or LEN node AP_NNCP_RESOURCE Network node AP_LU_RESOURCE LU directory_entry_detail.description A null-terminated text string describing the directory entry, as specified in the definition of the directory entry. directory_entry_detail.parent_name Fully qualified resource name of the parent resource; for an LU the parent resource is the owning Control Point, and for an end node or LEN node it is the network node server.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY AP_HOME Local resource. AP_CACHE Cached entry. directory_entry_detail.location Specifies the location of the resource. This is one of the following. AP_LOCAL The resource is at the local node. AP_DOMAIN The resource belongs to an attached end node. AP_CROSS_DOMAIN The resource is not within the domain of the local node.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU QUERY_DIRECTORY_LU QUERY_DIRECTORY_LU returns a list of LUs from the directory database. It can be used to obtain information about a specific LU, or about multiple LUs, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU unsigned char lu_owner_name[17]; unsigned char location; unsigned char entry_type; unsigned char wild_card; unsigned char reserva[20]; } DIRECTORY_LU_DETAIL; /* /* /* /* /* network qualified lu owner name*/ Resource location */ Type of the directory entry */ type of wildcard entry */ reserved */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_DIRECTORY_LU overlay_size For compatability with future releases of SNAplus2
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU Summary information only. AP_DETAIL Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the lu_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the lu_name parameter.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters. directory_lu_detail.description A null-terminated text string describing the directory entry, as specified in the definition of the directory entry. directory_lu_detail.server_name Fully qualified name of the node that serves the LU.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU Local resource. AP_CACHE Cached entry. directory_lu_detail.wild_card Specifies whether the LU entry is for an explicit name, or for a wildcard value that will match a range of names. This is one of the following: AP_EXPLICIT The entry is an explicit LU name. AP_FULL_WILDCARD The entry is a full wildcard value that will match any LU name.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_STATS QUERY_DIRECTORY_STATS QUERY_DIRECTORY_STATS returns directory database statistics, which can be used to gauge the level of network locate traffic. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_STATS opcode AP_QUERY_DIRECTORY_STATS Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK max_caches This parameter is reserved. cur_caches This parameter is reserved. cur_home_entries Current number of home entries. cur_reg_entries Current number of registered entries. cur_directory_entries Total number of entries currently in the directory.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_STATS This parameter is reserved. not_found_locates Number of directed locates returned “not found”. not_found_bcast_locates This parameter is reserved. locates_outstanding Current number of outstanding locates. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DLC QUERY_DLC QUERY_DLC returns information about DLCs. This information is structured as “determined data” (data gathered dynamically during execution) and “defined data” (data supplied on DEFINE_DLC). This verb can be used to obtain either summary or detailed information, about a specific DLC or about multiple DLCs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_DLC unsigned char unsigned char DLC_DET_DATA DLC_DEF_DATA } DLC_DETAIL; dlc_name[8]; reserv2[2]; det_data; def_data; /* /* /* /* typedef struct dlc_det_data { unsigned char state; unsigned char reserv3[3]; unsigned char reserva[20]; }DLC_DET_DATA; typedef struct dlc_def_data { unsigned char description[32]; unsigned char initially_active; unsigned char reserv1[15]; unsigned char dlc_type; unsigned char neg_ls_supp; unsigned char port_types; unsigned char reserv3[11]; AP_
NOF API Verbs (QUERY Verbs) QUERY_DLC A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of DLCs for which data should be returned. To request data for a specific DLC rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_DLC DLC name for which information is required, or the name to be used as an index into the list of DLCs. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. The name is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_DLC than 8 characters. dlc_summary.description A null-terminated text string describing the DLC, as specified in the definition of the DLC. dlc_summary.state State of the DLC. This is one of the following: AP_ACTIVE The DLC is active. AP_NOT_ACTIVE The DLC is not active. AP_PENDING_INACTIVE STOP_DLC is in progress. dlc_summary.dlc_type Type of DLC. This is one of the following: AP_SDLC SDLC AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI dlc_detail.
NOF API Verbs (QUERY Verbs) QUERY_DLC DLC name. The name is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. dlc_detail.det_data.state State of the DLC. This is one of the following: AP_ACTIVE The DLC is active. AP_NOT_ACTIVE The DLC is not active. AP_PENDING_INACTIVE STOP_DLC is in progress. dlc_detail.def_data.description A null-terminated text string describing the DLC, as specified in the definition of the DLC. dlc_detail.def_data.
NOF API Verbs (QUERY Verbs) QUERY_DLC dlc_detail.def_data.neg_ls_supp Specifies whether the DLC supports negotiable link stations. Possible values are: AP_YES Link stations using this DLC may be negotiable. AP_NO Link stations using this DLC must be defined as either primary or secondary; negotiable link stations are not supported. dlc_detail.def_data.port_types If dlc_type is set to AP_ETHERNET /AP_FDDI, this parameter will be set to AP_PORT_SATF. For other DLC types, this parameter is reserved.
NOF API Verbs (QUERY Verbs) QUERY_DLC Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE QUERY_DLC_TRACE QUERY_DLC_TRACE returns information about DLC line tracing, which was set up using ADD_DLC_TRACE verbs. This verb can be used to obtain information about tracing on all resources, on a specific resource type, or on a specific resource, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE typedef struct sna_lfsid { union { AP_UINT16 struct { unsigned char unsigned char } s; } uu; AP_UINT16 } SNA_LFSID; session_id; sidh; sidl; odai; Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_DLC_TRACE overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() funct
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE list_options The position in the list of DLC_TRACE entries from which SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the filter structure. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the filter structure.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE List tracing options for port resources for which only defined LSs (not implicit LSs) are traced. AP_PORT_IMPLICIT_LS List tracing options for port resources for which only implicit LSs (not defined LSs) are traced. filter.resource_type Specifies the resource type of the entry to be returned, or the entry to be used as an index into the list. This parameter is used only if list_type is set to AP_ALL_DLC_TRACES and list_options is not set to AP_FIRST_IN_LIST.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE The name of the entry to be returned, or the entry to be used as an index into the list. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST, or if resource_type is set to AP_ALL_RESOURCES. filter.lfsid The Local Form Session Identifier for a session on the specified LS. This is only valid for resource_type AP_LS, and indicates that the required entry specifies messages on a particular session for the specified LS.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer contains the following parameters: overlay_size The size of the returned dlc_trace_data structure, and therefore the offset to the start of the next entry in the data buffer. dlc_trace_filter.resource_type The type of resource being traced.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE defined LSs) that use this port. dlc_trace_filter.resource_name The name of the DLC, port, or LS being traced. dlc_trace_filter.lfsid The Local Form Session Identifier for a session on the specified LS. This is only valid for resource_type AP_LS, and indicates that only messages on this session are to be traced. The structure contains the following three values, which are returned in the SESSION_STATS section of a QUERY_SESSION verb: dlc_trace_filter.lfsid.uu.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE AP_TRACE_NC (this message type is currently not used) AP_TRACE_SEGS Non-BBIU segments that do not contain an RH AP_TRACE_CTL Messages other then MUs and XIDs Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns one of the following. primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LIST_TYPE The list_type parameter specified a value that was not valid.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_DEFAULTS QUERY_DLUR_DEFAULTS The QUERY_DLUR_DEFAULTS verb allows the user to query the defaults defined using the DEFINE_DLUR_DEFAULTS verb.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_DEFAULTS A-string characters. bkup_dlus_name Name of the DLUS node that serves as the backup default. This name is set to all zeros or 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. dlus_retry_timeout Interval in seconds between second and subsequent attempts to contact a DLUS.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU QUERY_DLUR_LU QUERY_DLUR_LU returns information about active LUs that are using the DLUR feature of SNAplus2. This verb can be used to obtain information about a specific LU, or about multiple LUs, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU unsigned char unsigned char unsigned char lu_location; nau_address; plu_name[17]; unsigned char unsigned char } DLUR_LU_DETAIL; NOTE reserv1[27]; rscv_len; /* /* /* /* /* /* /* active downstream or local LU NAU address of LU PLU name if PLU-SLU session active reserved length of appended RSCV */ */ */ */ */ */ */ The DLUR_LU_DETAIL structure may be followed by a Route Selection Control Vector (RSCV) as defined by SNA Formats.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU if the name is shorter than 8 characters. pu_name PU name for which LU information is required. To list only information about LUs associated with a specific PU, specify the PU name. To obtain a complete list for all PUs, set this field to binary zeros. The name is an 8-byte EBCDIC type-A string, padded on the right with EBCDIC spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU the data buffer. dlur_lu_summary.lu_name Name of the LU. The name is an 8-byte EBCDIC type-A string, padded on the right with EBCDIC spaces if the name is shorter than 8 characters. dlur_lu_detail.overlay_size The size of the returned dlur_lu_detail structure, and therefore the offset to the start of the next entry in the data buffer. dlur_lu_detail.lu_name Name of the LU.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU 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. dlur_lu_detail.rscv_len Length of the RSCV that is appended to the dlur_lu_detail structure.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node configuration does not support it, SNAplus2 returns the following parameter: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support DLUR; this is defined by the dlur_supported parameter on the DEFINE_NODE verb.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU QUERY_DLUR_PU QUERY_DLUR_PU returns information about PUs that use the DLUR feature of SNAplus2. This verb can be used to obtain information about a specific PU, or about multiple PUs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char FQPCID AP_UINT16 AP_UINT16 } DLUR_PU_DETAIL initially_active; reserv1[15]; defined_dlus_name[17]; bkup_dlus_name[17]; pu_id[4]; pu_location; active_dlus_name[17]; ans_support; pu_status; dlus_session_status; reserv3; fqpcid; dlus_retry_timeout; dlus_retry_limit; typedef struct fqpcid { unsigned char pcid[8]; unsi
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU num_entries Maximum number of DLUR PUs for which data should be returned. To request data for a specific PU rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU if the name is shorter than 8 characters. dlus_name DLUS name for which PU information is required. To list only information about PUs associated with a specific DLUS, specify the DLUS name; a PU will be listed only if it has an SSCP-PU session to the specified DLUS node. To obtain a complete list for all DLUSs, set this field to binary zeros. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: dlur_pu_summary.overlay_size The size of the returned dlur_pu_summary structure, and therefore the offset to the start of the next entry in the data buffer. dlur_pu_summary.pu_name Name of the PU.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU started. AP_NO The PU is not automatically started; it must be started manually. dlur_pu_detail.defined_dlus_name Name of DLUS node, defined by either a DEFINE_INTERNAL_PU verb or a DEFINE_LS verb (with dspu_services set to AP_DLUR). 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. dlur_pu_detail.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU to all binary zeros. 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. dlur_pu_detail.ans_support Auto Network Shutdown support, as sent to DLUR from the DLUS at SSCP-PU activation.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU Having forwarded a DACTPU to the PU, DLUR is waiting for the PU to respond to it. AP_PEND_INOP DLUR is waiting for all necessary events to complete before it deactivates the PU. dlur_pu_detail.dlus_session_status Status of the DLUS pipe currently being used by the PU. Possible values are: AP_PENDING_ACTIVE The pipe is in the process of being activated. AP_ACTIVE The pipe is active. AP_PENDING_INACTIVE The pipe is in the process of being deactivated.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU node, depending on which node initiated the SSCP-PU session activation. dlur_pu_detail.dlus_retry_timeout The interval in seconds between the second and subsequent attempts to contact the DLUS specified by the def_data.dlus_name and def_data.bkup_dlus_name parameters. The interval between the first and second attempts is always 1 second. If zero is specified, then the defaults specified using the DEFINE_DLUR_DEFAULTS verb are used. . dlur_pu_detail.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node configuration does not support it, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support DLUR; this is defined by the dlur_supported parameter on the DEFINE_NODE verb.
NOF API Verbs (QUERY Verbs) QUERY_DLUS QUERY_DLUS QUERY_DLUS returns information about DLUS nodes known to the DLUR feature of SNAplus2. This verb returns pipe statistics (SSCP-PU and SSCP-LU session statistics); the QUERY_ISR_SESSION verb may be used to obtain PLU-SLU session statistics. This verb can be used to obtain information about a specific DLUS, or about multiple DLUSs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_DLUS AP_UINT16 PIPE_STATS } DLUS_DATA; num_active_pus; pipe_stats; typedef struct pipe_stats { AP_UINT32 reqactpu_sent; AP_UINT32 reqactpu_rsp_received; AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 } PIPE_STATS; actpu_received; actpu_rsp_sent; reqdactpu_sent; reqdactpu_rsp_received; dactpu_received; dactpu_rsp_sent; actlu_received; actlu_rsp_sent; dactlu_received; dactlu_rsp_se
NOF API Verbs (QUERY Verbs) QUERY_DLUS buf_size Size of the supplied data buffer. num_entries Maximum number of DLUSs for which data should be returned. To request data for a specific DLUS rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data.
NOF API Verbs (QUERY Verbs) QUERY_DLUS Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_DLUS as the default by a DEFINE_DLUR_DEFAULTS verb (AP_YES or AP_NO). dlus_data.is_backup_default Specifies whether the DLUS node has been designated as the backup default by a DEFINE_DLUR_DEFAULTS verb (AP_YES or AP_NO). dlus_data.pipe_state State of the pipe to the DLUS. Possible values are: AP_PENDING_ACTIVE The pipe is in the process of being activated. AP_ACTIVE The pipe is active. AP_PENDING_INACTIVE The pipe is in the process of being deactivated.
NOF API Verbs (QUERY Verbs) QUERY_DLUS Number of RSP(REQDACTPU)s received from DLUS over the pipe. dlus_data.pipe_stats.dactpu_received Number of DACTPUs received from DLUS over the pipe. dlus_data.pipe_stats.dactpu_rsp_sent Number of RSP(DACTPU)s sent to DLUS over the pipe. dlus_data.pipe_stats.actlu_received Number of ACTLUs received from DLUS over the pipe. dlus_data.pipe_stats.actlu_rsp_sent Number of RSP(ACTLU)s sent to DLUS over the pipe. dlus_data.pipe_stats.
NOF API Verbs (QUERY Verbs) QUERY_DLUS returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_DLUS_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the dlus_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_DOMAIN_CONFIG_FILE QUERY_DOMAIN_CONFIG_FILE QUERY_DOMAIN_CONFIG_FILE returns the header information included in the SNAplus2 domain configuration file (the SNAplus2 version number, the revision level of the file, and an optional comment string supplied on DEFINE_DOMAIN_CONFIG_FILE). This verb must be issued to the domain configuration file.
NOF API Verbs (QUERY Verbs) QUERY_DOMAIN_CONFIG_FILE primary_rc AP_OK hdr.major_version, hdr.minor_version, hdr.update_release The internal version identifier of the release of SNAplus2 that was used to create this file. hdr.revision_level The revision level of the file (stored internally by SNAplus2). hdr.comment An optional comment string containing information about the file. This is an ASCII string of 0-99 characters, followed by a null character.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU QUERY_DOWNSTREAM_LU QUERY_DOWNSTREAM_LU returns information about downstream LUs that use PU concentration or DLUR or both. This information is structured as determined data (data gathered dynamically during execution, returned only if the node is active) and defined data (data supplied on DEFINE_DOWNSTREAM_LU). For DLUR-supported LUs, implicitly defined data is put in place when the downstream LU is activated.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU unsigned char nau_address; unsigned char lu_sscp_sess_active; unsigned char plu_sess_active; } DOWNSTREAM_LU_SUMMARY; typedef struct downstream_lu_detail { AP_UINT16 overlay_size; unsigned char dslu_name[8]; unsigned char reserv1[2]; DOWNSTREAM_LU_DET_DATA det_data; DOWNSTREAM_LU_DEF_DATA def_data; } DOWNSTREAM_LU_DETAIL; typedef struct downstream_lu_det_data { unsigned char lu_sscp_sess_active; unsigned char plu_sess_active; unsigned char dspu_services; unsig
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 cur_rcv_pac_win; AP_UINT32 send_data_frames; AP_UINT32 send_fmd_data_frames; AP_UINT32 send_data_bytes; AP_UINT32 rcv_data_frames; AP_UINT32 rcv_fmd_data_frames; AP_UINT32 rcv_data_bytes; unsigned char sidh; unsigned char sidl; unsigned char odai; unsigned char ls_name[8]; unsigned char pacing_type; } SESSION_STA
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the combination of the dspu_name and dslu_name parameters. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of the dspu_name and dslu_name parameters. The list is ordered by dspu_name and then by dslu_name.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU AP_DLUR Return information only on downstream LUs served by DLUR. AP_NONE Return information about all downstream LUs. When the node is not running, this parameter is ignored; SNAplus2 returns information about all downstream LUs. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU next entry in the data buffer. downstream_lu_summary.dslu_name Name of the LU. The name is an 8-byte EBCDIC type-A string, padded on the right with EBCDIC spaces if the name is shorter than 8 characters. downstream_lu_summary.dspu_name Name of the PU associated with the LU. The name is an 8-byte EBCDIC type-A string, padded on the right with EBCDIC spaces if the name is shorter than 8 characters. downstream_lu_summary.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU Specifies whether the PLU-SLU session is active. Possible values are: AP_YES The session is active. AP_NO The session is not active. downstream_lu_detail.overlay_size The size of the returned downstream_lu_detail structure, and therefore the offset to the start of the next entry in the data buffer. downstream_lu_detail.dslu_name Name of the LU.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU A session_stats structure is included for each of the three sessions (LU-SSCP session, downstream PLU-SLU session, and upstream PLU-SLU session). The fields in this structure are as follows: rcv_ru_size Maximum receive RU size. (In the LU-SSCP session statistics, this parameter is reserved.) send_ru_size Maximum send RU size. (In the LU-SSCP session statistics, this parameter is reserved.) max_send_btu_size Maximum BTU size that can be sent.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU Number of normal flow FMD data frames sent. send_data_bytes Number of normal flow data bytes sent. rcv_data_frames Number of normal flow data frames received. rcv_fmd_data_frames Number of normal flow FMD data frames received. rcv_data_bytes Number of normal flow data bytes received. sidh Session ID high byte. (In the upstream PLU-SLU session statistics for an LU served by PU concentration, this parameter is reserved.) sidl Session ID low byte.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU Possible values are: AP_NONE AP_PACING_FIXED downstream_lu_detail.det_data.host_lu_name Name of the host LU to which the downstream LU is mapped, or to which it was mapped when the PLU-SLU session was last active. This parameter value may differ from def_data.host_lu_name because def_data.host_lu_name can be the name of a host LU pool. downstream_lu_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU downstream_lu_detail.allow_timeout Specifies whether this downstream LU allows its session with the upstream LU to timeout. Possible values are: AP_YES This downstream LU allows its session with the upstream LU to timeout. AP_NO This downstream LU does not allow its session with the upstream LU to timeout. downstream_lu_detail.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc AP_INVALID_PU_TYPE The PU specified by the dspu_name parameter is not a downstream PU.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU QUERY_DOWNSTREAM_PU QUERY_DOWNSTREAM_PU returns information about downstream PUs that use PU concentration or DLUR or both. This verb can be used to obtain information about a specific PU or about multiple PUs, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU { AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 rcv_ru_size; send_ru_size; max_send_btu_size; max_rcv_btu_size; max_send_pac_win; cur_send_pac_win; max_rcv_pac_win; AP_UINT16 cur_rcv_pac_win; AP_UINT32 send_data_frames; AP_UINT32 send_fmd_data_frames; AP_UINT32 send_data_bytes; AP_UINT32 rcv_data_frames; AP_UINT32 rcv_fmd_data_frames; AP_UINT32 rcv_data_bytes; unsigned char sidh; unsigned char sidl; unsigned char odai; unsigned char
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the dspu_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the dspu_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see List Options For QUERY_* Verbs.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU Specifies whether the PU-SSCP session to the downstream PU is active. Possible values are: AP_YES The session is active. AP_NO The session is not active. downstream_pu_data.dspu_services Specifies the type of services provided to the PU. Possible values are: AP_PU_CONCENTRATION Downstream PU is served by PU concentration. AP_DLUR Downstream PU is served by DLUR. downstream_pu_data.pu_sscp_stats.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU Reserved (always set to zero). downstream_pu_data.pu_sscp_stats.send_data_frames Number of normal flow data frames sent. downstream_pu_data.pu_sscp_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. downstream_pu_data.pu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. downstream_pu_data.pu_sscp_stats.rcv_data_frames Number of normal flow data frames received. downstream_pu_data.pu_sscp_stats.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_PU_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the dspu_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE QUERY_DSPU_TEMPLATE The QUERY_DSPU_TEMPLATE verb returns information about defined downstream PU templates used for PU concentration over implicit links. This verb can be used to obtain information about a specific downstream PU template, or about a number of downstream PU templates, depending on the options used. To obtain information about a specific downstream PU template or multiple downstream PU templates, set the template_name parameter.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE downstream LU templates; the number of the downstream LU templates is specified by the number_of_dslu_templates parameter.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE The position in the list from which SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the template_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the template_name parameter.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE entry may be incomplete; this is indicated by the last_user_incomplete parameter. total_num_entries Total number of entries that could have been returned. This may be higher than num_entries. dspu_template_data.overlay_size The number of bytes in this entry, including any downstream LU templates, and the offset to the next entry returned (if any). dspu_template_data.template_name Name of the DSPU template. dspu_template_data.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE Maximum NAU address in the range of DSLU templates. dslu_template_data.allow_timeout Indicates whether SNAplus2 is allowed to timeout host LUs used by this downstream LU if the session is left inactive for the timeout period specified on the host LU definition. Possible values are: AP_YES SNAplus2 is allowed to timeout host LUs used by this downstream LU. AP_NO SNAplus2 is not allowed to timeout host LUs used by this downstream LU. dslu_template_data.
NOF API Verbs (QUERY Verbs) QUERY_DSPU_TEMPLATE secondary_rc AP_INVALID_TEMPLATE_NAME The template specified in the template_name parameter was not valid. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF QUERY_EMULATOR_USER_DEF QUERY_EMULATOR_USER_DEF returns information about 3270 users or 5250 users defined in a SNAplus2 configuration file. It can return either summary or detailed information, about a single user or multiple users, depending on the options used. This verb returns information about the definition of this user in the configuration file, not about the user's current usage of the emulation program.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF typedef struct emulator_user_summary { unsigned char user_name[32]; } EMULATOR_USER_SUMMARY; /* user name typedef struct emulator_user_detail { unsigned char user_name[32]; /* user name AP_UINT32 num_filtered_sessions; /* total number of sessions /* of the requested type EMULATOR_USER_DEF_DATA def_data; /* user definition } EMULATOR_USER_DETAIL; typedef struct emulator_user_def_data { unsigned char description[32]; unsigned char reserv3[16]; unsigned cha
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF } session_variant; AP_UINT32 reserv4; } SESSION_DEF_DATA; /* reserved typedef struct session_3270_def_data { unsigned char lu_name[8]; unsigned char session_type; unsigned char model_override; } SESSION_3270_DEF_DATA; typedef struct session_5250_def_data { unsigned char local_lu_alias[8]; unsigned char plu_alias[8]; unsigned char fqplu_name[17]; unsigned char mode_name[8]; unsigned char session_type; } SESSION_5250_DEF_DATA; */ /* LU/pool name accessed
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF returned. If detailed information about user sessions is being returned, this number includes partial entries (for which a session name is specified, so that the returned data does not include the user definition or the user's first session). To request data for a specific user rather than a range, specify the value 1.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. user_name The name of the user for whom information is required, or the name to be used as an index into the list of users. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. The name is an ASCII string of 1-32 characters, padded on the right with spaces if the name is shorter than 32 characters.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF parameters: primary_rc AP_OK buf_size Length of the information returned in the buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. This may be higher than buf_size. total_num_entries Total number of entries that could have been returned. This may be higher than num_entries. num_entries The number of entries actually returned.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF incomplete. Possible values are: AP_YES The complete data for the last user was too large to fit in the data buffer. At least one session structure is included, but there are further session structures that are not included in the data buffer. The num_last_sessions parameter indicates how many session structures have been returned; the application can issue further verbs to obtain the remaining data. AP_NO The data for the last user is complete.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF • The num_sessions parameter in the def_data structure defines the total number of sessions (3270, 5250, or both) defined for the user. • If the session_name parameter was set to a nonzero value, the data for the first user will contain only the remaining session structures (starting from the requested entry), without the def_data structure.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT QUERY_FOCAL_POINT QUERY_FOCAL_POINT returns information about the focal point for a specific Management Services category, or about multiple focal points, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT unsigned char unsigned char unsigned char AP_UINT16 }FP_DATA; fp_routing; reserv1; reserva[20]; number_of_appls; /* /* /* /* type of MDS routing to use reserved reserved number of applications */ */ */ */ Each fp_data structure is followed by one or more application names; the number of these is specified by the number_of_appls parameter.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the ms_category parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the ms_category parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT Fully qualified control point name of the currently active focal point. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters. fp_data.bkup_appl_name Backup focal point application name.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT Type of focal point. Refer to the IBM Systems Network Architecture: Management Services Reference (see “Related Publications”) for further detail. This is one of the following: AP_EXPLICIT_PRIMARY_FP AP_IMPLICIT_PRIMARY_FP AP_BACKUP_FP AP_DEFAULT_PRIMARY_FP AP_DOMAIN_FP AP_HOST_FP AP_NO_FP fp_data.fp_status Status of the focal point. This is one of the following: AP_ACTIVE The focal point is currently active.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT AP_DIRECT The MDS_MU should be routed on a session directly to the focal point. fp_data.number_of_appls Number of applications registered for this focal point category. appl_name Name of application registered for focal point category.
NOF API Verbs (QUERY Verbs) QUERY_FOCAL_POINT configuration does not support it, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support MS network management functions; this is defined by the mds_supported parameter on the DEFINE_NODE verb. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE QUERY_GLOBAL_LOG_TYPE This verb allows a NOF application to determine the types of information that SNAplus2 records in log files. It specifies default values that are used on all servers (unless they are overridden on a particular server by SET_LOG_TYPE); QUERY_LOG_TYPE can be used to determine the values being used on a particular server.
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE unsigned char exception; unsigned char succinct_audits; unsigned char succinct_errors; } QUERY_GLOBAL_LOG_TYPE; /* exception logging on or off */ /* use succinct logging in audit file? */ /* use succinct logging in error file? */ Supplied Parameters The application supplies the following parameter: opcode AP_QUERY_GLOBAL_LOG_TYPE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: prima
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE Exception messages are not recorded. succinct_audits This parameter indicates whether succinct logging or full logging is used in the audit log file. Possible values are: AP_YES Succinct logging: each message in the log file contains a summary of the message header information (such as the message number, log type, and system name) and the message text string and parameters.
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE The verb was issued to a node that is not the central logger. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_KERNEL_MEMORY_LIMIT QUERY_KERNEL_MEMORY_LIMIT This verb returns information about the amount of kernel memory that SNAplus2 is currently using, the maximum amount it has used, and the configured limit. This allows you to check memory usage and set the limit appropriately, to ensure that sufficient memory is available for SNAplus2 components and for other programs on the HP-UX computer.
NOF API Verbs (QUERY Verbs) QUERY_KERNEL_MEMORY_LIMIT the maximum amount used since this verb, rather than the maximum amount used since the system was started (or since the max_used value was last reset). Possible values are: AP_YES Reset the max_used value to match the current memory allocation. AP_NO Do not reset the max_used value. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (QUERY Verbs) QUERY_KERNEL_MEMORY_LIMIT reset_max_used Specifies whether SNAplus2 resets the max_used value (after returning it on this command) to match the amount of memory currently allocated. This ensures that a subsequent QUERY_KERNEL_MEMORY_LIMIT verb will return the maximum amount used since this command was issued, rather than the maximum amount used since the system was started (or since the max_used value was last reset).
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU QUERY_LOCAL_LU QUERY_LOCAL_LU returns information about local LUs. This verb can be used to obtain either summary or detailed information, about a specific LU or about multiple LUs, depending on the options used. It can also obtain information about the LU associated with the CP (the default LU).
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU unsigned char LOCAL_LU_DEF_DATA LOCAL_LU_DET_DATA } LOCAL_LU_DETAIL; lu_name[8]; def_data; det_data; typedef struct local_lu_def_data { unsigned char description[32]; unsigned char reserv1; unsigned char security_list_name[14] unsigned char lu_alias[8]; unsigned char nau_address; unsigned char syncpt_support; AP_UINT16 lu_session_limit; unsigned char default_pool; unsigned char reserv2; unsigned char pu_name[8]; unsigned char lu_attributes; unsigned char sscp_id[
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU NB_COUNTER NB_COUNTER NB_COUNTER NB_COUNTER NB_COUNTER NB_COUNTER unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; send_data_frames; send_fmd_data_frames; send_data_bytes; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name; pacing_type; typedef struct routing_data { unsigned char sys_name[64]; signed long timeout; unsigned char back_level; unsigned char reserved[59]; } ROUTING_DATA; /* /* /* /* /
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only. AP_DETAIL Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the lu_name or lu_alias parameter.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU list of LUs. This value is ignored if list_options is set to AP_FIRST_IN_LIST. To identify the LU by its alias instead of its name, set this parameter to 8 binary zeros, and specify the alias in the lu_alias parameter; to identify the default LU, set both lu_name and lu_alias to 8 binary zeros. The name is an 8-byte EBCDIC string, padded on the right with EBCDIC spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU as specified in the definition of the LU. local_lu_detail.def_data.security_list_name Name of the security access list used by the local LU (defined using the DEFINE_SECURITY_ACCESS_LIST verb). If this parameter is set to 14 binary zeros, the LU is available for use by any user. local_lu_detail.def_data.lu_alias LU alias. This is an 8-byte ASCII character string. local_lu_detail.def_data.nau_address Network accessible unit address of the LU.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU AP_NO The LU is not in the pool. If the LU is an independent LU, this parameter is reserved. local_lu_detail.def_data.pu_name For dependent LUs, this parameter identifies the PU that this LU will use. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if necessary. For independent LUs, this field is not used; it is set to 8 binary zeros. local_lu_detail.def_data.lu_attributes Configured LU attributes.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU requests. A request will time out if the invoked TP has not issued a Receive_Allocate verb (APPC), or Accept_Conversation or Accept_Incoming (CPI-C), within this time. A value of -1 indicates no timeout (dynamic load requests will wait indefinitely). local_lu_detail.def_data.attach_routing_data.back_level Specifies whether the target computer specified by the sys_name parameter above is a back-level computer.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU AP_NO No application is using the LU. local_lu_detail.det_data.lu_sscp_stats.rcv_ru_size This parameter is always reserved. local_lu_detail.det_data.lu_sscp_stats.send_ru_size This parameter is always reserved. local_lu_detail.det_data.lu_sscp_stats.max_send_btu_size Maximum basic transmission unit (BTU) size that can be sent. local_lu_detail.det_data.lu_sscp_stats.max_rcv_btu_size Maximum BTU size that can be received. local_lu_detail.det_data.lu_sscp_stats.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU local_lu_detail.det_data.lu_sscp_stats.rcv_fmd_data_fra mes Number of normal flow FMD data frames received. local_lu_detail.det_data.lu_sscp_stats.rcv_data_bytes Number of normal flow data bytes received. local_lu_detail.det_data.lu_sscp_stats.sidh Session ID high byte. local_lu_detail.det_data.lu_sscp_stats.sidl Session ID low byte. local_lu_detail.det_data.lu_sscp_stats.odai Origin Destination Assignor Indicator.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_alias parameter was not valid.
NOF API Verbs (QUERY Verbs) QUERY_LOG_FILE QUERY_LOG_FILE This verb allows the application to determine the name of the file that SNAplus2 uses to record audit or error log messages, the name of the backup log file, and the file size at which log information is copied to the backup file.
NOF API Verbs (QUERY Verbs) QUERY_LOG_FILE AP_OK secondary_rc Not used. file_name Name of the log file. This parameter is an ASCII string of 1-80 characters, followed by a null (0x00) character. If no path is included, the file is stored in the default directory for diagnostics files, /var/opt/sna; if a path is included, this is either a full path (starting with a / character) or the path relative to the default directory. backup_file_name Name of the backup log file.
NOF API Verbs (QUERY Verbs) QUERY_LOG_FILE primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_FILE_TYPE The log_file_type parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_LOG_TYPE QUERY_LOG_TYPE This verb allows a NOF application to determine the types of information that SNAplus2 records in log files on a particular server, and whether these are the default settings specified on SET_GLOBAL_LOG_TYPE or local settings specified by a previous SET_LOG_TYPE verb. SNAplus2 logs messages for the following types of event: Problem An abnormal event that degrades the system in a way perceptible to a user (such as abnormal termination of a session).
NOF API Verbs (QUERY Verbs) QUERY_LOG_TYPE } QUERY_LOG_TYPE; Supplied Parameters The application supplies the following parameter: opcode AP_QUERY_LOG_TYPE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (QUERY Verbs) QUERY_LOG_TYPE AP_NO Audit messages are not recorded. exception This parameter indicates whether exception messages are recorded. Possible values are: AP_YES Exception messages are recorded. AP_NO Exception messages are not recorded. succinct_audits This parameter indicates whether succinct logging or full logging is used in the audit log file.
NOF API Verbs (QUERY Verbs) QUERY_LOG_TYPE full logging is used in the error log file; this applies to both exception logs and problem logs. The possible values and their meanings are the same as for the succinct_audits parameter. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_LS QUERY_LS QUERY_LS returns a list of information about the link stations defined at the node. This information is structured as “determined data” (data gathered dynamically during execution, returned only if the node is active) and “defined data” (data supplied on DEFINE_LS). This verb can be used to obtain either summary or detailed information, about a specific LS or about multiple LSs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_LS unsigned char unsigned char } LS_SUMMARY; adj_cp_name[17]; adj_cp_type; typedef struct ls_detail { AP_UINT16 overlay_size; unsigned char ls_name[8]; LS_DET_DATA det_data; LS_DEF_DATA def_data; } LS_DETAIL; typedef struct ls_det_data { AP_UINT16 act_sess_count; unsigned unsigned unsigned unsigned unsigned unsigned unsigned char char char char char char char unsigned char unsigned char LS_STATS AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigne
NOF API Verbs (QUERY Verbs) QUERY_LS unsigned char } LS_DET_DATA; reservb[66]; typedef struct ls_def_data { unsigned char description[32]; unsigned char initially_active; AP_UINT16 reserv2; AP_UINT16 react_timer; AP_UINT16 react_timer_retry; unsigned char reserv3[10]; unsigned char port_name[8]; unsigned char adj_cp_name[17]; unsigned char adj_cp_type; LINK_ADDRESS dest_address; unsigned char auto_act_supp; unsigned char tg_number; unsigned char limited_resource; unsigned char solicit_sscp_sessions; unsig
NOF API Verbs (QUERY Verbs) QUERY_LS unsigned char AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 } LS_DEF_DATA; max_ifrm_rcvd; dlus_retry_timeout; dlus_retry_limit; reserv4[30]; link_spec_data_len; /* /* /* /* /* typedef struct link_address { AP_UINT16 reserve1; AP_UINT16 length; unsigned char address[32]; } LINK_ADDRESS; no.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 } LS_STATS; out_xid_bytes; /* out_msg_bytes; /* out_xid_frames; /* out_msg_frames; /* in_invalid_sna_frames; number of XID bytes sent number of message bytes sent number of XID frames sent number of message frames sent /* number of invalid frames /* received in_session_control_frames; /* number of control frames /* received out_ses
NOF API Verbs (QUERY Verbs) QUERY_LS list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only. AP_DETAIL Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list.
NOF API Verbs (QUERY Verbs) QUERY_LS parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_SDLC SDLC AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI ls_summary.state State of this link station. This is one of the following: AP_ACTIVE The LS is active. AP_NOT_ACTIVE The LS is not active. AP_PENDING_ACTIVE The LS is being activated. AP_PENDING_INACTIVE The LS is being deactivated. AP_PENDING_ACTIVE_BY_LR The LS has failed (or an attempt to activate it has failed), and SNAplus2 is attempting to reactivate it. ls_summary.
NOF API Verbs (QUERY Verbs) QUERY_LS A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters. This name is normally determined during activation; it is null if the LS is inactive. However, for an LS to a back-level LEN node (specified by the adj_cp_type parameter on DEFINE_LS), this name is taken from the LS definition and is not determined during activation. ls_summary.det_adj_cp_type Type of the adjacent node.
NOF API Verbs (QUERY Verbs) QUERY_LS A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters. ls_summary.adj_cp_type Type of the adjacent node, determined during link activation. This is one of the following: AP_APPN_NODE Node type is unknown, or LS is inactive. AP_END_NODE End node, or up-level LEN node (one that includes the Network Name CV in its XID3). AP_NETWORK_NODE Network node.
NOF API Verbs (QUERY Verbs) QUERY_LS The size of the returned ls_detail structure, and therefore the offset to the start of the next entry in the data buffer. ls_detail.ls_name Link station name. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. ls_detail.det_data.act_sess_count The total number of active sessions using the link. ls_detail.det_data.dlc_type Type of DLC.
NOF API Verbs (QUERY Verbs) QUERY_LS The LS is being deactivated. AP_PENDING_ACTIVE_BY_LR The LS has failed (or an attempt to activate it has failed), and SNAplus2 is attempting to reactivate it. ls_detail.det_data.sub_state This field provides more detailed information about the state of this link station. Possible values are: AP_SENT_CONNECT_OUT AP_PENDING_XID_EXCHANGE AP_SENT_ACTIVATE_AS AP_SENT_SET_MODE AP_ACTIVE AP_SENT_DEACTIVATE_AS_ORDERLY AP_SENT_DISCONNECT AP_WAITING_STATS AP_RESET ls_detail.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_NETWORK_NODE Network node. AP_LEARN_NODE Node type is unknown. The node type is normally determined during activation; it is null if the LS is inactive. However, for an LS to a back-level LEN node (specified by the adj_cp_type parameter on DEFINE_LS), the node type is taken from the LS definition and is not determined during activation. ls_detail.det_data.dlc_name Name of the DLC.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_UNKNOWN The adjacent node level is unknown. ls_detail.det_data.tg_num Number associated with the TG. ls_detail.det_data.ls_stats.in_xid_bytes Total number of XID (Exchange Identification) bytes received on this link station. ls_detail.det_data.ls_stats.in_msg_bytes Total number of data bytes received on this link station. ls_detail.det_data.ls_stats.in_xid_frames Total number of XID (Exchange Identification) frames received on this link station. ls_detail.
NOF API Verbs (QUERY Verbs) QUERY_LS link station. ls_detail.det_data.ls_stats.out_session_control_frames Total number of session control frames sent on this link station. ls_detail.det_data.ls_stats.good_xids Total number of successful XID exchanges that have occurred on this link station since it was started. ls_detail.det_data.ls_stats.bad_xids Total number of unsuccessful XID exchanges that have occurred on this link station since it was started. ls_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_LS The link station was deactivated as a result of an immediate STOP command from an operator. AP_DEACT_AUTOMATIC The link station was deactivated automatically, for example because there were no more sessions using the link station. AP_DEACT_FAILURE The link station was deactivated because of a failure. ls_detail.det_data.hpr_support This parameter is reserved. ls_detail.det_data.anr_label This parameter is reserved. ls_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_LS role. Possible values are: AP_LS_PRI Primary. AP_LS_SEC Secondary. AP_LS_NEG Negotiable. ls_detail.det_data.node_id Node ID received from adjacent node during XID exchange. This is a 4-byte hexadecimal string. ls_detail.det_data.active_isr_count Number of active intermediate sessions using the link. ls_detail.det_data.active_lu_sess_count The count of active LU-LU sessions using this link. ls_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_NO The LS is not automatically started; it must be started manually. ls_detail.def_data.react_timer Reactivation timer for reactivating a failed LS. If the react_timer_retry parameter below is nonzero, to specify that SNAplus2 should retry activating the LS if it fails, this parameter specifies the time in seconds between retries. When the LS fails, or when an attempt to reactivate it fails, SNAplus2 waits for the specified time before retrying the activation.
NOF API Verbs (QUERY Verbs) QUERY_LS spaces if the name is shorter than 8 characters. If the link is to a VRN, this field specifies the name of the actual port used to connect to the VRN (as specified in the DEFINE_CN verb). ls_detail.def_data.adj_cp_name Fully qualified name of the adjacent control point. This parameter is used only if adj_cp_type specifies that the adjacent node is an APPN node or a back-level LEN node. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_DSPU_XID Downstream PU; SNAplus2 includes XID exchange in link activation. AP_DSPU_NOXID Downstream PU; SNAplus2 does not include XID exchange in link activation. For SDLC: ls_detail.def_data.dest_address Address of the secondary link station. The value of this parameter depends on how the port that owns this LS is configured, as follows: • If the port is used only for incoming calls (out_link_act_lim on DEFINE_SDLC_PORT is 0), this parameter is reserved.
NOF API Verbs (QUERY Verbs) QUERY_LS parameters on DEFINE_PORT); it is ignored for incoming calls or for PVC. For Token Ring, Ethernet, FDDI: ls_detail.def_data.dest_address.mac_address MAC address of link station on adjacent node. If the local and adjacent nodes are on LANs of different types (one Token Ring or FDDI, the other Ethernet) connected by a bridge, you will probably need to reverse the bit order of the bytes in the MAC address. For more information, see “Bit Ordering in MAC Addresses”.
NOF API Verbs (QUERY Verbs) QUERY_LS when there are no sessions using the link. Possible values are: AP_NO The link is not a limited resource and will not be deactivated automatically. AP_NO_SESSIONS The link is a limited resource and will be deactivated automatically when no active sessions are using it.
NOF API Verbs (QUERY Verbs) QUERY_LS on the right with EBCDIC spaces. ls_detail.def_data.disable_remote_act Specifies whether the LS can be activated by a remote node. Possible values are: AP_YES The LS can only be activated by the local node; if the remote node attempts to activate it, SNAplus2 will reject the attempt. AP_NO The LS can be activated by the remote node. ls_detail.def_data.dspu_services Specifies the services which the local node will provide to the downstream PU across this link.
NOF API Verbs (QUERY Verbs) QUERY_LS Name of the DLUS node from which DLUR solicits SSCP services when the link to the downstream node is activated. This field is reserved if dspu_services is not set to AP_DLUR. 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.
NOF API Verbs (QUERY Verbs) QUERY_LS value of zero indicates no timeout (the link is not deactivated, as though limited_resource were set to AP_NO), and that values in the range 1-4 are interpreted as 5. ls_detail.def_data.default_nn_server End node: Specifies whether this is a link supporting CP-CP sessions to a network node that can act as the local node's network node server.
NOF API Verbs (QUERY Verbs) QUERY_LS Fujitsu Network Architecture (VTAM-F) host. AP_HNA Hitachi Network Architecture host. ls_detail.def_data.ls_attributes[1] Network Name CV suppression for a link to a back-level LEN node. If adj_cp_type is set to AP_BACK_LEVEL_LEN_NODE, this parameter specifies whether to suppress inclusion of the Network Name CV in the format 3 XID sent to the LEN node. Possible values are: AP_NO Include the Network Name CV in the XID.
NOF API Verbs (QUERY Verbs) QUERY_LS CP-CP sessions are not supported. ls_detail.def_data.use_default_tg_chars Specifies whether the default TG characteristics supplied on the DEFINE_PORT verb are used. Possible values are: AP_YES Use the default TG characteristics; ignore the tg_chars structure on this verb. AP_NO Use the tg_chars structure on this verb. ls_detail.def_data.tg_chars.effect_cap Actual bits per second rate (line speed).
NOF API Verbs (QUERY Verbs) QUERY_LS AP_SEC_SECURE_CONDUIT Data is transmitted over a line in a secure conduit that is not guarded. AP_SEC_GUARDED_CONDUIT Data is transmitted over a line in a conduit that is protected against physical tapping. AP_SEC_ENCRYPTED Data is encrypted before transmission over the line. AP_SEC_GUARDED_RADIATION Data is transmitted over a line that is protected against physical and radiation tapping. AP_SEC_MAXIMUM Maximum security. ls_detail.def_data.tg_chars.
NOF API Verbs (QUERY Verbs) QUERY_LS Maximum propagation delay. ls_detail.def_data.tg_chars.user_def_parm_1 through def_data.tg_chars.user_def_parm_3 User-defined parameters, which include other TG characteristics not covered by the above parameters. Each of these parameters is set to a value in the range 0-255. ls_detail.def_data.target_pacing_count Numeric value between 1 and 32,767 inclusive indicating the desired pacing window size. (The current version of SNAplus2 does not make use of this value.
NOF API Verbs (QUERY Verbs) QUERY_LS The interval between the initial attempt and the first retry is always one second. If zero is returned, the default value configured with DEFINE_DLUR_DEFAULTS is used. This parameter is ignored if ls_detail.def_data.dspu_services is not set to AP_DLUR. ls_detail.def_data.dlus_retry_limit Maximum number of retries after an initial failure to contact the DLUS specified in the ls_detail.def_data.dlus_name and ls_detail.def_data.bkup_dlus_name parameters.
NOF API Verbs (QUERY Verbs) QUERY_LS The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 QUERY_LU_0_TO_3 QUERY_LU_0_TO_3 returns information about local LUs of type 0, 1, 2, or 3. This information is structured as “determined data” (data gathered dynamically during execution, returned only if the node is active) and “defined data” (the data supplied by the application on DEFINE_LU_0_TO_3). This verb can be used to obtain either summary or detailed information, about a specific LU or about multiple LUs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 unsigned char plu_sess_active; unsigned char host_attachment; } LU_0_TO_3_SUMMARY; typedef struct lu_0_to_3_detail { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char reserv1[2]; LU_0_TO_3_DET_DATA det_data; LU_0_TO_3_DEF_DATA def_data; } LU_0_TO_3_DETAIL; typedef struct lu_0_to_3_det_data { unsigned char lu_sscp_sess_active; unsigned char appl_conn_active; unsigned char plu_sess_active; unsigned char host_attachment; SESSION_STATS lu_sscp_stats; SES
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; pacing_type; typedef struct lu_0_to_3_def_data { unsigned char description[32]; unsigned char reserv1[16]; unsigned char nau_address; unsigned char pool_name[8]; unsigned char pu_name[8]; unsigned char priority; unsigned char lu_model; unsigned char sscp_id[6]; AP_
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 parameter is replaced by a workstation_name parameter. If the app_type parameter in the lu_0_to_3_det_data structure is set to AP_PU_CONCENTRATION, the app_spec_det_data field contains the same structure as the 3270 structure above except that the app_type parameter is set to AP_PU_CONCENTRATION and the user_name through user_gname parameters are replaced by a pu_conc_downstream_lu parameter.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 AP_QUERY_LU_0_TO_3 overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of LUs for which data should be returned.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the lu_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. pu_name PU name for which LU information is required. To list only information about LUs associated with a specific PU, specify the PU name. To obtain a complete list for all PUs, set this field to binary zeros.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 EBCDIC spaces if the name is shorter than 8 characters. lu_0_to_3_summary.description A null-terminated text string describing the LU, as specified in the definition of the LU. lu_0_to_3_summary.nau_address Network accessible unit address of the LU. This is in the range 1-255. lu_0_to_3_summary.lu_sscp_sess_active Specifies whether the LU-SSCP session is active. Possible values are: AP_YES The session is active. AP_NO The session is inactive.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 LU host attachment type. When the verb is issued to a running node, this parameter takes one of the following values: AP_DIRECT_ATTACHED LU is directly attached to the host system. AP_DLUR_ATTACHED LU is supported by DLUR. lu_0_to_3_detail.overlay_size The size of the returned lu_0_to_3_detail structure, and therefore the offset to the start of the next entry in the data buffer. lu_0_to_3_detail.lu_name Name of the local LU.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 Specifies whether the PLU-SLU session is active. Possible values are: AP_YES The session is active. AP_NO The session is inactive. lu_0_to_3_detail.det_data.host_attachment LU host attachment type. When the verb is issued to a running node, this parameter takes one of the following values: AP_DIRECT_ATTACHED LU is directly attached to the host system. AP_DLUR_ATTACHED LU is supported by DLUR.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 Current size of the send pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) max_rcv_pac_win Maximum size of the receive pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) cur_rcv_pac_win Current size of the receive pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) send_data_frames Number of normal flow data frames sent.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 and sets it to one if the BIND sender is the node containing the secondary link station. ls_name Link station name associated with statistics. This is an 8-byte ASCII character string, right-padded with spaces if the name is shorter than 8 characters. pacing_type Receive pacing type in use on the PLU-SLU session. Possible values are: AP_NONE AP_PACING_FIXED lu_0_to_3_detail.det_data.plu_name Name of the primary LU.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 user_name If the user_type parameter below is set to AP_RJE_WKSTN, this parameter specifies the name of the RJE workstation program that is using the LU. This is an ASCII string of 1-4 characters; the remaining characters are filled with spaces. For other values of user_type, this parameter specifies the HP-UX user name with which the 3270 emulation program is running. This is an ASCII string of 1-32 characters.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 user_gname The HP-UX group name with which the program is running. This is an ASCII string of 1-32 characters. If app_type is set to AP_TN_SERVER, this field is replaced by the tn_server_session_user_info structure, containing information about the TN3270 program that is using this LU. The structure consists of the following fields: user_ip_address The dotted-decimal IP address of the computer where the TN3270 program is running.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 newbox.this.co.uk), or as an alias (such as newbox); the format is indicated by the cfg_format parameter. cfg_format Specifies the format of the cfg_address parameter. Possible values are: AP_ADDRESS_IP IP address AP_ADDRESS_FQN Alias or fully qualified name tn3270_level Level of TN3270 support. Possible values are: AP_LEVEL_TN3270 TN3270E protocols are disabled. AP_LEVEL_TN3270E TN3270E protocols are enabled. lu_select Method of LU selection.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. lu_0_to_3_detail.det_data.app_type The type of application, if any, that is using the LU. Possible values are: AP_NONE The LU is not in use. AP_LUA_APPLICATION The LU is being used by an LUA application. AP_PU_CONCENTRATION The LU is being used by a downstream LU using PU concentration.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 Name of the LU pool to which this LU belongs. This is an 8-byte EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. If the LU does not belong to a pool, this field is set to 8 binary zeros. lu_0_to_3_detail.def_data.pu_name Name of the PU (as specified on the DEFINE_LS verb) which this LU will use. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 supplied and the user of the LU specified allow_timeout on the OPEN_LU_SSCP_SEC_RQ (or, in the case of PU concentration, on the downstream LU definition), then the LU will be deactivated after the PLU-SLU session is left inactive for this period and one of the following conditions applies: • The session passes over a limited resource link. • Another application wishes to use the LU before the session is used again.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD QUERY_LU_LU_PASSWORD QUERY_LU_LU_PASSWORD returns information about passwords used for session-level security verification between a local LU and a partner LU. It can be used to obtain information about the password for a specific partner LU or about passwords for multiple partner LUs, depending on the options used. This verb returns password information in clear text.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD unsigned char } PASSWORD_INFO; protocol_in_use; /* protocol in use */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_LU_LU_PASSWORD overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD Start at the entry specified by the plu_alias or fqplu_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the plu_alias or fqplu_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. lu_name LU name. This name is an 8-byte type-A EBCDIC character string.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD 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. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD password_info.fqplu_name Fully qualified network name for the partner LU. 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. password_info.description A null-terminated text string describing the LU-LU password, as specified in the definition of the password. password_info.
NOF API Verbs (QUERY Verbs) QUERY_LU_LU_PASSWORD returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The supplied lu_alias parameter did not match the alias of any configured LU. AP_INVALID_LU_NAME The supplied lu_name parameter did not match the name of any configured LU. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL QUERY_LU_POOL QUERY_LU_POOL returns information about LU pools and the LUs that belong to them. This verb can be used to obtain information about a specific LU or pool, or about multiple LUs or pools, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL unsigned char unsigned char unsigned char unsigned char unsigned char } LU_POOL_DETAIL; reserv1[16]; lu_name[8]; lu_sscp_sess_active; appl_conn_active; plu_sess_active; /* /* /* /* /* reserved LU name Is LU-SSCP session active Is appl connection open Is PLU-SLU session active */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_LU_POOL overlay_size For compatability with future releases of SNAplus2, your applic
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only (list LU pools). AP_DETAIL Detailed information (list individual LUs in LU pools). Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL 0, and set lu_name to 8 binary zeros. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL as specified in the definition of the pool. lu_pool_summary.num_active_lus Number of LUs in the pool that are active. lu_pool_detail.overlay_size The size of the returned lu_pool_data structure, and therefore the offset to the start of the next entry in the data buffer. lu_pool_detail.pool_name Name of LU pool to which the LU belongs. This is an 8-byte EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. lu_pool_detail.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL An application is using the LU. AP_NO No application is using the LU. lu_pool_detail.plu_sess_active Specifies whether the PLU-SLU session is active. Possible values are: AP_YES The session is active. AP_NO The session is inactive.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT QUERY_LU62_TIMEOUT The QUERY_LU62_TIMEOUT verb returns information about the definition of an LU type 6.2 session timeout that was defined previously with a DEFINE_LU62_TIMEOUT verb. The information is returned as a list. To obtain information about a specific timeout, or about several timeout values, specify values for the resource_type and resource_name parameters.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char resource_type; unsigned char resource_name[17]; } QUERY_LU62_TIMEOUT; typedef struct lu62_timeout_data { AP_UINT16 overlay_size; unsigned char resource_type; unsigned char resource_name[17]; AP_UINT16 timeout; } LU62_TIMEOUT_DATA; /* /* /* /* /* total number of entries list options reserved resource type resource name */ */ */ */ */ /* /* /* /* overlay size resour
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT list_options The position in the list of entries from which SNAplus2 begins to return data. The list is ordered by resource_type in the order AP_GLOBAL_TIMEOUT, AP_LOCAL_LU_TIMEOUT, AP_PARTNER_LU_TIMEOUT, AP_MODE_TIMEOUT, then by resource_name in order of the name length, then by ASCII lexicographical ordering for names of the same length.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT Timeout applies to all LU 6.2 sessions to the partner LU specified in the resource_name parameter. AP_MODE_TIMEOUT Timeout applies to all LU 6.2 sessions using the mode specified in the resource_name parameter. resource_name Name of the resource being queried. This value can be one of the following: • If resource_type is set to AP_GLOBAL_TIMEOUT, do not specify this parameter.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT AP_MODE_TIMEOUT Timeout applies to all LU 6.2 sessions using the mode indicated by the resource_name parameter. resource_name Name of the resource. This name is a local LU, a partner LU, or a mode, depending on the value of the resource_type parameter. This parameter is set to zeros if resource_type is set to AP_GLOBAL_TIMEOUT. timeout Timeout period in seconds. A value of 0 (zero) indicates that the session times out immediately after it becomes free.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION QUERY_MDS_APPLICATION QUERY_MDS_APPLICATION returns a list of applications that have registered for MDS-level messages by issuing the MS verb REGISTER_MS_APPLICATION. For more information about this verb, see the HP-UX SNAplus2 MS Programmers Guide. This verb can be used to obtain information about a specific application or about multiple applications, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION opcode AP_QUERY_MDS_APPLICATION overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. application Application name for which information is required, or the name to be used as an index into the list. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION next entry in the data buffer. mds_application_data.application Name of registered application. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. mds_application_data.max_rcv_size The maximum number of bytes that the application can receive in one message (this is specified when an application registers with MDS).
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION The local node does not support MS network management functions; this is defined by the mds_supported parameter on the DEFINE_NODE verb. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_MDS_STATISTICS QUERY_MDS_STATISTICS QUERY_MDS_STATISTICS returns Management Services statistics. This verb can be used to gauge the level of MDS routing traffic. The information can also be used to determine the required size of the send alert queue, which is configured using the DEFINE_NODE verb. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_MDS_STATISTICS Supplied Parameters The application supplies the following parameter: opcode AP_QUERY_MDS_STATISTICS Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK alerts_sent Number of locally originated alerts sent using the MDS transport system. alert_errors_rcvd Number of error messages received by MDS indicating a delivery failure for a message containing an alert.
NOF API Verbs (QUERY Verbs) QUERY_MDS_STATISTICS uncorrelated_errors_rcvd increases over time, this indicates that the send alert queue size is too small. mds_mus_rcvd_local Number of MDS_MUs received from local applications. mds_mus_rcvd_remote Number of MDS_MUs received from remote nodes using the MDS_RECEIVE and MSU_HANDLER transaction programs. mds_mus_delivered_local Number of MDS_MUs successfully delivered to local applications.
NOF API Verbs (QUERY Verbs) QUERY_MDS_STATISTICS Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node configuration does not support it, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support MS network management functions; this is defined by the mds_supported parameter on the DEFINE_NODE verb.
NOF API Verbs (QUERY Verbs) QUERY_MODE QUERY_MODE QUERY_MODE returns information about modes that a local LU is using, or has used, with partner LUs. This verb can be used to obtain information about a specific partner LU-mode combination or about multiple modes, and about modes for which sessions are currently active or about all modes that have been used, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_MODE unsigned char unsigned char AP_UINT16 AP_UINT16 unsigned char unsigned char } MODE_SUMMARY; description[32]; reserv2[16]; sess_limit; act_sess_count; fqplu_name[17]; reserv1[3]; /* /* /* /* /* /* typedef struct mode_detail { AP_UINT16 overlay_size; unsigned char mode_name[8]; unsigned char description[32]; unsigned char reserv2[16]; AP_UINT16 sess_limit; AP_UINT16 act_sess_count; unsigned char fqplu_name[17]; unsigned char reserv1[3]; AP_UINT16 min_conwinners_source
NOF API Verbs (QUERY Verbs) QUERY_MODE overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of modes for which data should be returned.
NOF API Verbs (QUERY Verbs) QUERY_MODE name and mode name. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the supplied partner LU name and mode name. For AP_FIRST_IN_LIST, the entry used as the index into the list is defined by the combination of lu_name (or lu_alias) and fqplu_name (or plu_alias). If fqplu_name or plu_alias is not specified, the entry used as the index is lu_name (or lu_alias).
NOF API Verbs (QUERY Verbs) QUERY_MODE fully qualified LU name for the partner LU. To specify that the LU is identified by its LU name rather than its alias, set this parameter to 8 binary zeros and specify the LU name in the following parameter. fqplu_name Fully qualified network name for the partner LU. If list_options is set to AP_FIRST_IN_LIST, this parameter is ignored; otherwise you must specify either the LU alias or the fully qualified LU name for the partner LU.
NOF API Verbs (QUERY Verbs) QUERY_MODE parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_MODE mode_summary.act_sess_count Total number of active sessions between the specified local LU and partner LU using the mode. mode_summary.fqplu_name Fully qualified name of the partner LU. 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. mode_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE mode_detail.min_conwinners_target Specifies the minimum number of sessions on which the local LU is the contention loser. mode_detail.drain_source Specifies whether the local LU satisfies waiting session requests before deactivating a session when session limits are changed or reset. Possible values are: AP_YES Waiting session requests will be satisfied before sessions are deactivated. AP_NO Waiting session requests will not be satisfied. mode_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE mode_detail.sync_level Specifies the synchronization level supported by the mode. Possible values are: AP_CONFIRM The mode supports synchronization using the CONFIRM and CONFIRMED verbs. AP_SYNCPT The mode supports Syncpoint functions. AP_NONE The mode does not support synchronization. mode_detail.default_ru_size Specifies whether the default upper bound for the maximum RU size will be used.
NOF API Verbs (QUERY Verbs) QUERY_MODE If a previous CNOS verb has set the mode session limit to zero, but sessions are still active because conversations were using them or waiting to use them, this parameter specifies the number of sessions that have not yet been deactivated. mode_detail.implicit Specifies whether the entry was created by an implicit or explicit definition. Possible values are: AP_YES The entry is an implicit entry. AP_NO The entry is an explicit entry.
NOF API Verbs (QUERY Verbs) QUERY_MODE AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the mode_name parameter was not valid. AP_INVALID_PLU_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but one of the following conditions applies: • The fqplu_name parameter does not match the name of any of this local LU's partners.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION QUERY_MODE_DEFINITION QUERY_MODE_DEFINITIONreturns information about modes defined using DEFINE_MODE, or about SNA-defined modes. This verb can be used to obtain either summary or detailed information, about a specific mode or about multiple modes, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION typedef struct mode_def_detail { AP_UINT16 overlay_size; unsigned char mode_name[8]; MODE_CHARS mode_chars; } MODE_DEF_DETAIL; typedef struct mode_chars { unsigned char description[32]; unsigned char reserv2[16]; AP_UINT16 max_ru_size_upp; unsigned char receive_pacing_win; unsigned char default_ru_size; AP_UINT16 max_neg_sess_lim; AP_UINT16 AP_UINT16 plu_mode_session_limit; min_conwin_src; unsigned char unsigned char unsigned char AP_UINT16 cos_name[8];
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of modes for which data should be returned. To request data for a specific mode rather than a range, specify the value 1.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION For more information about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”. This verb differs from other QUERY_* verbs in that the modes are listed in the order they are created. mode_name Mode name which designates the network properties for a group of sessions. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION The size of the returned mode_def_summary structure, and therefore the offset to the start of the next entry in the data buffer. mode_def_summary.mode_name Mode name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. mode_def_summary.description A null-terminated text string describing the mode, as specified in the definition of the mode. mode_def_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION SNAplus2 always uses adaptive pacing unless the adjacent node specifies that it is not supported. Range is 1-63, or zero to specify no pacing window (that is, an unlimited number of frames can be received, and no response is required). mode_def_detail.mode_chars.default_ru_size Specifies whether a default upper bound for the maximum RU size will be used.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION Name of the class of service to request when activating sessions on this mode. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. mode_def_detail.mode_chars.auto_act Specifies how many sessions will be activated automatically for this mode. This value is used when CNOS (Change Number of Sessions) exchange is initiated implicitly. This value is in the range 0-32,767. mode_def_detail.mode_chars.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION AP_INVALID_MODE_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the mode_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_MODE_TO_COS_MAPPING QUERY_MODE_TO_COS_MAPPING QUERY_MODE_TO_COS_MAPPING returns information about the COS (class of service) associated with a particular mode. This verb can be used to obtain information about a specific mode or about multiple modes, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_MODE_TO_COS_MAPPING AP_QUERY_MODE_TO_COS_MAPPING overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_MODE_TO_COS_MAPPING Mode name for which information is required, or the name to be used as an index into the list. This value is ignored if list_options is set to AP_FIRST_IN_LIST. The mode name is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. To return information about the default COS that is used for any unrecognized mode names, set this parameter to 8 binary zeros.
NOF API Verbs (QUERY Verbs) QUERY_MODE_TO_COS_MAPPING mode_to_cos_mapping_data.mode_name Mode name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. mode_to_cos_mapping_data.cos_name Class of service name associated with the mode name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_NMVT_APPLICATION QUERY_NMVT_APPLICATION QUERY_NMVT_APPLICATION returns a list of applications that have registered for NMVT-level messages by issuing the MS verb REGISTER_NMVT_APPLICATION. For more information about this verb, see the HP-UX SNAplus2 MS Programmers Guide. This verb can be used to obtain information about a specific application or about multiple applications, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_NMVT_APPLICATION Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_NMVT_APPLICATION overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information.
NOF API Verbs (QUERY Verbs) QUERY_NMVT_APPLICATION Start at the entry immediately following the entry specified by the application parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. application Application name. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. The name is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_NMVT_APPLICATION The size of the returned nmvt_application_data structure, and therefore the offset to the start of the next entry in the data buffer. nmvt_application_data.application Name of the registered application. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. nmvt_application_data.ms_vector_key_type MS vector key accepted by the application.
NOF API Verbs (QUERY Verbs) QUERY_NMVT_APPLICATION not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_NODE QUERY_NODE QUERY_NODE returns information about the definition of a SNAplus2 node, and on its status if it is active.
NOF API Verbs (QUERY Verbs) QUERY_NODE { AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 crt_parms_len; description[32]; reserv1[16]; node_type; fqcp_name[17]; cp_alias[8]; mode_to_cos_map_supp; mds_supported; node_id[4]; max_locates; dir_cache_size; max_dir_entries; /* length of CP_CREATE_PARMS */ /* resource description */ /* reserved */ /* node type */ /* fully qualified CP name */ /* CP alias */ /*
NOF API Verbs (QUERY Verbs) QUERY_NODE } CP_CREATE_PARMS; Supplied Parameters The application supplies the following parameter: opcode AP_QUERY_NODE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK cp_create_parms.crt_parms_len Length of create parameters structure. cp_create_parms.description A null-terminated text string describing the node, as specified in the definition of the node. cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE Specifies whether mode-to-COS mapping is supported by the node. For a LEN node, mode-to-COS mapping is not supported. Possible values are: AP_YES Mode-to-COS mapping is supported. AP_NO Mode-to-COS mapping is not supported. cp_create_parms.mds_supported Specifies whether Management Services supports Multiple Domain Support and MS Capabilities. Possible values are: AP_YES MDS is supported. AP_NO MDS is not supported. cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE is started. Possible values are: AP_YES Register resources with the NN. The end node's network node server will only forward directed locates to it. AP_NO Do not register resources. The network node server will forward all broadcast searches to the end node. cp_create_parms.reg_with_cds End node: Specifies whether the network node server is allowed to register end node resources with a Central Directory server. This field is ignored if reg_with_nn is set to AP_NO.
NOF API Verbs (QUERY Verbs) QUERY_NODE This parameter is reserved. cp_create_parms.max_isr_sessions This parameter is reserved. cp_create_parms.isr_sessions_upper_threshold and cp_create_parms.isr_sessions_lower_threshold This parameter is reserved. cp_create_parms.isr_max_ru_size This parameter is reserved. cp_create_parms.isr_rcv_pac_window This parameter is reserved. cp_create_parms.store_endpt_rscvs Specifies whether RSCVs should be stored for diagnostic purposes.
NOF API Verbs (QUERY Verbs) QUERY_NODE cp_create_parms.dlur_support Specifies whether DLUR is supported. For a LEN node, this parameter is reserved. Possible values are: AP_YES AP_NO cp_create_parms.pu_conc_support Specifies whether PU concentration is supported (AP_YES or AP_NO). cp_create_parms.nn_rar Reserved. cp_create_parms.hpr_support This parameter is reserved. cp_create_parms.max_ls_exception_events The maximum number of LS exception events recorded by the node. cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE value is combined with one or both of the following values, using a logical OR operation: AP_REQDISCONT_TYPE Use type “immediate” on REQDISCONT; if this value is not specified, SNAplus2 uses type “normal”. AP_REQDISCONT_RECONTACT Use type “immediate recontact” on REQDISCONT; if this value is not specified, SNAplus2 uses type “no immediate recontact”. cp_create_parms.ptf[1] ERP support.
NOF API Verbs (QUERY Verbs) QUERY_NODE Time (in hundredths of a second) since the node was started (or restarted). A value of zero indicates that the node is not running. nn_functions_supported Reserved. functions_supported Specifies the functions supported. This may be one or more of the following, combined using a logical OR.
NOF API Verbs (QUERY Verbs) QUERY_NODE be supported. nn_status Reserved. nn_frsn Reserved. nn_rsn Reserved. def_ls_good_xids Total number of successful XID exchanges that have occurred on all defined link stations since the node was last started. def_ls_bad_xids Total number of unsuccessful XID exchanges that have occurred on all defined link stations since the node was last started.
NOF API Verbs (QUERY Verbs) QUERY_NODE This parameter is reserved. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL QUERY_NODE_ALL QUERY_NODE_ALL returns information about nodes on the SNAplus2 LAN. This verb returns only each node's name and configuration file role, and does not provide detailed information about the node's configuration. The application can use QUERY_NODE for a particular node name to obtain detailed information about that node. This verb must be issued with a null target handle.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL AP_QUERY_NODE_ALL overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of nodes for which data should be returned.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”. node_name Name of the node to be used as an index into the list. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. This is an ASCII string of 1-64 characters, padded on the right with spaces if the name is shorter than 64 characters.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL therefore the offset to the start of the next entry in the data buffer. node_summary.node_name The name of the SNAplus2 node. node_summary.config_role The configuration file role of the server where the node is running. For more information about configuration file roles, refer to the HP-UX SNAplus2 Administration Guide. Possible values are: AP_ROLE_MASTER The server holds the master configuration file. AP_ROLE_BACKUP The server holds a backup configuration file.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS QUERY_NODE_LIMITS QUERY_NODE_LIMITS returns information about the functions that your SNAplus2 license allows you to use on a particular node. These are divided into two categories: • Node options, which specify the SNAplus2 features that you can use • Node limits, which specify the maximum numbers of LUs, sessions, and users that can use the node at any time. The verb also returns information about the current usage of the parameters controlled by node limits.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS typedef struct node_options { unsigned char network_node; unsigned char end_node; unsigned char len_node; unsigned char dlur_support; unsigned char pu_conc_support; unsigned char tn_server_support; unsigned char hpr_support; unsigned char back_level_client; } NODE_OPTIONS; /* /* /* /* /* /* /* /* is Network Node supported? */ is End Node supported? */ is LEN Node supported? */ is DLUR supported? */ is PU Conc supported? */ is TN Server supported? */ level of H
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS -1 indicates no limit. max_limits.num_appc_sessions The maximum number of APPC sessions that your license allows you to have active at any one time. A value of zero indicates that you cannot activate any APPC sessions; a value of -1 indicates no limit. max_limits.num_intermediate_sessions This parameter is reserved. max_limits.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS The number of APPC sessions currently using this node. curr_usage.num_intermediate_sessions This parameter is reserved. curr_usage.num_user_sessions The total number of sessions (type 0-3 and APPC) currently using this node. curr_usage.num_sna_users The number of users (3270 and 5250 emulation programs, RJE workstations, and APPC, CPI-C, and LUA applications) currently using this node. A value of -1 indicates no limit. curr_usage.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS max_usage.num_sna_users The highest number of users (3270 and 5250 emulation programs, RJE workstations, and APPC, CPI-C, and LUA applications) that have been active at any one time. max_usage.num_total_sessions The highest total number of sessions of all types that have been active at any one time. node_options.network_node This parameter is reserved. node_options.end_node Specifies whether your license allows you to define this node as an end node.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS AP_NO DLUR is not supported. node_options.pu_conc_support Specifies whether your license allows you to use PU concentration on this node. Possible values are: AP_YES PU concentration is supported. AP_NO PU concentration is not supported. node_options.tn_server_support Specifies whether your license allows you to use TN server on this node. Possible values are: AP_YES TN server is supported. AP_NO TN server is not supported. node_options.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS The back-level client support software is running. AP_NO The back-level client support software is not running. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU QUERY_PARTNER_LU QUERY_PARTNER_LU returns information about partner LUs that a local LU is currently using, or has used. This verb returns information about usage of the partner LUs, not about their definition; use QUERY_PARTNER_LU_DEFINITION to obtain the definition of the partner LUs. This verb can be used to obtain either summary or detailed information, about a specific LU or about multiple LUs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU unsigned char unsigned char AP_UINT16 unsigned char unsigned char } PLU_SUMMARY; description[32]; reserv2[16]; act_sess_count; partner_cp_name[17]; partner_lu_located; /* /* /* /* /* resource description */ reserved */ currently active sessions count */ partner LU CP name */ CP name resolved? */ implicit; security_details; duplex_support; preference; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* size of returned entry partner LU alias fully qualifie
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of LUs for which data should be returned. To request data for a specific LU rather than a range, specify the value 1.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU names. AP_LIST_BY_ALIAS The list is returned in order of LU alias rather than LU name. This option is only valid if AP_FIRST_IN_LIST is also specified. (For AP_LIST_FROM_NEXT or AP_LIST_INCLUSIVE, the list is in order of LU alias or LU name, depending on which was specified as the index into the list.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU otherwise you must specify either the LU alias or the fully qualified LU name for the partner LU. To indicate that the LU is identified by its fully qualified name instead of its alias, set this parameter to 8 binary zeros and specify the LU name in the following parameter. fqplu_name 17-byte fully qualified network name for the partner LU.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU Total number of active sessions between the local LU and the partner LU. plu_summary.partner_cp_name 17-byte fully qualified network name for the CP associated with the partner LU. This parameter is not used if partner_lu_located below is set to AP_NO. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU characters. plu_detail.description A null-terminated text string describing the partner LU, as specified in the definition of the partner LU. plu_detail.act_sess_count Total number of active sessions between the local LU and the partner LU. plu_detail.partner_cp_name 17-byte fully qualified network name for the CP associated with the partner LU. This parameter is not used if partner_lu_located below is set to AP_NO.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU Parallel sessions are supported. AP_NO Parallel sessions are not supported. plu_detail.conv_security Specifies whether conversation security information can be sent to this partner LU. Possible values are: AP_YES Conversation security information supplied by a local TP is sent to the partner LU. AP_NO Conversation security information supplied by a local TP is not sent to the partner LU. plu_detail.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU conversation. The specific types of conversation security support are described by the following values. AP_ALREADY_VERIFIED Both the local and partner LU agree to accept Already Verified requests to allocate a conversation. An Already Verified request needs to carry only a user ID. It does not need to carry a password. AP_PERSISTENT_VERIFICATION Persistent Verification is supported on the session between the local and partner LUs.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU This parameter is reserved. Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_alias parameter was not valid.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION QUERY_PARTNER_LU_DEFINITION QUERY_PARTNER_LU_DEFINITION returns information about partner LUs for a local LU. This verb returns information about the definition of the LUs, not about their current usage; use QUERY_PARTNER_LU to obtain the usage information. This verb can be used to obtain either summary or detailed information, about a specific LU or about multiple LUs, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION AP_UINT16 overlay_size; unsigned char plu_alias[8]; unsigned char fqplu_name[17]; unsigned char reserv1; PLU_CHARS plu_chars; } PARTNER_LU_DEF_DETAIL; typedef struct plu_chars { unsigned char fqplu_name[17]; unsigned char plu_alias[8]; unsigned char description[32]; unsigned char reserv2[16]; unsigned char plu_un_name[8]; unsigned char preference; AP_UINT16 max_mc_ll_send_size; unsigned char conv_security_ver; unsigned char unsigned char } PLU_CHARS;
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION Maximum number of LUs for which data should be returned. To request data for a specific LU rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION index into the list.) For more information about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”. plu_alias Partner LU alias. The name is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. If list_options is set to AP_FIRST_IN_LIST, this parameter is ignored; otherwise you must specify either the LU alias or the fully qualified LU name for the partner LU.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION next entry in the data buffer. partner_lu_def_detail.plu_alias Partner LU alias. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. partner_lu_def_detail.fqplu_name Fully qualified network name for the partner LU. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION maximum is 32,767). Data records that are larger than this are broken down into several LL records before being sent to the partner LU. partner_lu_def_detail.plu_chars.conv_security_ver Specifies whether the partner LU is authorized to validate user IDs on behalf of local LUs; that is, whether the partner LU may set the already-verified indicator in an Attach request. Possible values are: AP_YES The partner LU is authorized to validate user IDs.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_PORT QUERY_PORT QUERY_PORT returns a list of information about a node's ports. This information is structured as “determined data” (data gathered dynamically during execution) and “defined data” (the data supplied by the application on DEFINE_PORT). This verb can be used to obtain either summary or detailed information, about a specific port or about multiple ports, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_PORT typedef struct port_detail { AP_UINT16 overlay_size; unsigned char port_name[8]; unsigned char reserv1[2]; PORT_DET_DATA det_data; PORT_DEF_DATA def_data; } PORT_DETAIL; typedef struct port_det_data { unsigned char port_state; unsigned char dlc_type; unsigned char port_sim_rim; unsigned char reserv1; AP_UINT16 def_ls_good_xids; AP_UINT16 def_ls_bad_xids; AP_UINT16 dyn_ls_good_xids; AP_UINT16 AP_UINT16 unsigned char unsigned char } PORT_DET_DATA; dyn_ls_bad_xids; num_i
NOF API Verbs (QUERY Verbs) QUERY_PORT unsigned char unsigned char AP_UINT16 AP_UINT16 implicit_dspu_services; /* reserved */ implicit_deact_timer; /* deact timer for implicit LSs */ act_xid_exchange_limit; /* activation XID exchange limit */ nonact_xid_exchange_limit; /* non-act.
NOF API Verbs (QUERY Verbs) QUERY_PORT should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of ports for which data should be returned. To request data for a specific port rather than a range, specify the value 1.
NOF API Verbs (QUERY Verbs) QUERY_PORT For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. port_name Name of port being queried. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. dlc_name DLC name filter.
NOF API Verbs (QUERY Verbs) QUERY_PORT entries were returned. Each entry in the data buffer consists of the following parameters: port_summary.overlay_size The size of the returned port_summary structure, and therefore the offset to the start of the next entry in the data buffer. port_summary.port_name Name of the port. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. port_summary.
NOF API Verbs (QUERY Verbs) QUERY_PORT data buffer. port_detail.port_name Name of the port. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. port_detail.det_data.port_state Specifies the current state of the port. Possible values are: AP_ACTIVE The port is active. AP_NOT_ACTIVE The port is not active. AP_PENDING_ACTIVE START_PORT is in progress. AP_PENDING_INACTIVE STOP_PORT is in progress. port_detail.det_data.dlc_type DLC type for the port.
NOF API Verbs (QUERY Verbs) QUERY_PORT Specifies whether Set Initialization Mode (SIM) and Receive Initialization Mode (RIM) are supported. Possible values are: AP_YES SIM and RIM are supported. AP_NO SIM and RIM are not supported. port_detail.det_data.def_ls_good_xids Total number of successful XID exchanges that have occurred on all defined link stations on this port since the last time this port was started. port_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_PORT Link stations can be negotiated. AP_NO Link stations can not be negotiated. port_detail.def_data.description A null-terminated text string describing the port, as specified in the definition of the port. port_detail.def_data.dlc_name Name of the DLC associated with this port. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. port_detail.def_data.port_type The type of line used by the port.
NOF API Verbs (QUERY Verbs) QUERY_PORT port_detail.def_data.max_rcv_btu_size Maximum BTU size that can be received. port_detail.def_data.tot_link_act_lim Total link activation limit. port_detail.def_data.inb_link_act_lim Inbound link activation limit. port_detail.def_data.out_link_act_lim Outbound link activation limit. port_detail.def_data.ls_role Link station role.
NOF API Verbs (QUERY Verbs) QUERY_PORT reserved. port_detail.def_data.implicit_ls_limit The maximum number of implicit link stations which can be active on this port simultaneously, including dynamic links and links activated for Discovery. A value of zero indicates that there is no limit; a value of AP_NO_IMPLICIT_LINKS indicates that no implicit links are allowed. port_detail.def_data.implicit_deact_timer Limited resource link deactivation timer, in seconds.
NOF API Verbs (QUERY Verbs) QUERY_PORT port_detail.def_data.max_send_btu_size Maximum BTU size that can be sent. port_detail.def_data.dlc_data Port address. For more information, see “DEFINE_PORT”. def_data.implicit_cp_cp_sess_support Specifies whether CP-CP sessions are permitted for implicit link stations using this port. Possible values are: AP_YES CP-CP sessions are permitted for implicit LSs. AP_NO CP-CP sessions are not permitted for implicit LSs. def_data.
NOF API Verbs (QUERY Verbs) QUERY_PORT def_data.default_tg_chars Default TG characteristics. These are used for implicit link stations using this port, and as the default TG characteristics for defined link stations that do not have TG characteristics explicitly defined. For details of these parameters, see “DEFINE_LS”. port_detail.def_data.port_spec_data_len Unpadded length, in bytes, of the port-specific data.
NOF API Verbs (QUERY Verbs) QUERY_PORT NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_PU QUERY_PU QUERY_PU returns information about local PUs and the links associated with them. This verb can be used to obtain information about a specific PU or about multiple PUs, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_PU typedef struct session_stats { AP_UINT16 rcv_ru_size; AP_UINT16 send_ru_size; AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 cur_rcv_pac_win; AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char send_data_frames; send_fmd_data_frames; send_data_bytes; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; unsigned char unsigned char unsigne
NOF API Verbs (QUERY Verbs) QUERY_PU Size of the supplied data buffer. num_entries Maximum number of PUs for which data should be returned. To request data for a specific PU rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data.
NOF API Verbs (QUERY Verbs) QUERY_PU Return information only on PUs directly attached to the host system. AP_DLUR_ATTACHED Return information only on PUs supported by DLUR. AP_NONE Return information about all PUs regardless of host attachment. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer.
NOF API Verbs (QUERY Verbs) QUERY_PU pu_data.pu_name PU Name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. pu_data.description A null-terminated text string describing the PU, as specified in the definition of the LS or of the internal PU. pu_data.ls_name Name of the link station associated with this PU. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. pu_data.
NOF API Verbs (QUERY Verbs) QUERY_PU Maximum BTU size that can be sent. pu_data.pu_sscp_stats.max_rcv_btu_size Maximum BTU size that can be received. pu_data.pu_sscp_stats.max_send_pac_win Reserved (always set to zero). pu_data.pu_sscp_stats.cur_send_pac_win Reserved (always set to zero). pu_data.pu_sscp_stats.max_rcv_pac_win Reserved (always set to zero). pu_data.pu_sscp_stats.cur_rcv_pac_win Reserved (always set to zero). pu_data.pu_sscp_stats.send_data_frames Number of normal flow data frames sent.
NOF API Verbs (QUERY Verbs) QUERY_PU Origin Destination Assignor Indicator. When bringing up a session, the sender of the BIND sets this field to zero if the local node contains the primary link station, and sets it to one if the BIND sender is the node containing the secondary link station. pu_data.pu_sscp_stats.ls_name Link station name associated with statistics. This is an 8-byte ASCII character string, right-padded with spaces if the name is shorter than 8 characters. pu_data.pu_sscp_stats.
NOF API Verbs (QUERY Verbs) QUERY_PU Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc AP_INVALID_PU_TYPE The PU specified by the pu_name parameter is a remote PU and not a local PU. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_RCF_ACCESS QUERY_RCF_ACCESS QUERY_RCF_ACCESS returns information about the permitted access to the SNAplus2 Remote Command Facility (RCF): the user ID used to run HP-UX Command Facility (UCF) commands, and the restrictions on which administration commands can be issued using the Service Point Command Facility (SPCF). This information was previously set up using DEFINE_RCF_ACCESS. For more information about SPCF and UCF, see the HP-UX SNAplus2 Administration Guide.
NOF API Verbs (QUERY Verbs) QUERY_RCF_ACCESS parameter is a null-terminated ASCII string. All UCF commands will be run using this user's user ID, using the default shell and access permissions defined for this user. If this parameter is set to a null string, this indicates that UCF access is prohibited. spcf_permissions Specifies the types of SNAplus2 administration commands that can be accessed using SPCF.
NOF API Verbs (QUERY Verbs) QUERY_RCF_ACCESS INITIALIZE_SESSION_LIMIT, CHANGE_SESSION_LIMIT, and RESET_SESSION_LIMIT verbs are allowed to provide access to a remote SNAplus2 node. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN QUERY_RJE_WKSTN QUERY_RJE_WKSTN returns information about usage of SNAplus2 RJE workstations. It can return either summary or detailed information, about a single workstation or multiple workstations, depending on the options used. This verb returns information about the current usage of the workstation, not about its definition; use QUERY_RJE_WKSTN_DEF to obtain information about the configuration file definition. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN AP_UINT16 unsigned char unsigned char AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char AP_UINT32 AP_UINT32 } RJE_WKSTN_DETAIL; overlay_size; workstation_name[4]; system_name[64]; wkstn_pid; reserv1; wkstn_uid; wkstn_gid; wkstn_uname[32]; wkstn_gname[32]; wkstn_session_count; wkstn_start_time; /* /* /* /* /* /* /* /* /* /* /* size of returned entry workstation name computer name process ID reserved user ID group ID user name group name count o
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only. AP_DETAIL Detailed information. Combine this value using a logical OR operation with one of the following values: AP_FIRST_IN_LIST Start at the first entry in the list.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. This may be higher than buf_size. total_num_entries Total number of entries that could have been returned.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN and therefore the offset to the start of the next entry in the data buffer. rje_wkstn_detail.workstation_name The name of the RJE workstation. rje_wkstn_detail.system_name The computer name on which the workstation is running. This is an ASCII string, padded on the right with spaces. rje_wkstn_detail.wkstn_pid The process ID of the workstation. rje_wkstn_detail.wkstn_uid The HP-UX user ID with which the workstation is running. rje_wkstn_detail.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_WORKSTATION The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the specified name, but the workstation_name or system_name parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF QUERY_RJE_WKSTN_DEF QUERY_RJE_WKSTN_DEF returns information about RJE workstations. It can return either summary or detailed information, about a single workstation or multiple workstations, depending on the options used. This verb returns information about the definition of the workstation, not about its current usage; use QUERY_RJE_WKSTN to obtain information about current usage. This verb must be issued to the domain configuration file.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF RJE_WKSTN_DEF_DATA def_data; } RJE_WKSTN_DEF_DETAIL; typedef struct rje_wkstn_def_data { unsigned char description[32]; unsigned char reserv1[16]; unsigned char primary_user[32]; unsigned char group_name[32]; unsigned char system_name[64]; AP_UINT16 num_lus; unsigned char unsigned char reserv4[18]; lu_name[5][8]; /* /* /* /* /* /* /* /* /* /* /* Description - null terminated*/ reserved */ primary user name */ user's group name */ computer where workstatio
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only. AP_DETAIL Detailed information.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK buf_size Length of the information returned in the buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. This may be higher than buf_size. num_entries The number of entries actually returned.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF configuration. The format of this information is the same as for the DEFINE_RJE_WKSTN verb.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST QUERY_SECURITY_ACCESS_LIST QUERY_SECURITY_ACCESS_LIST returns information about security access lists defined in a SNAplus2 configuration file.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST } SECURITY_ACCESS_DETAIL; typedef struct security_list_def { unsigned char description[32]; unsigned char reserv3[16]; AP_UINT32 num_users; unsigned char reserv2[16]; } SECURITY_LIST_DEF; typedef struct security_user_data { AP_UINT16 sub_overlay_size; unsigned char user_name[10]; } SECURITY_USER_DATA; /* /* /* /* description reserved number of users in list reserved /* reserved /* user name */ */ */ */ */ */ Supplied Parameters The application s
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST Start at the first user name for the first security access list. AP_LIST_INCLUSIVE Start at the entry specified by the supplied security access list name and user name, or start at the first user name for the specified security access list if no user name is specified. AP_LIST_FROM_NEXT If a user name is specified, start at the user immediately following the specified user.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST Length of the information returned in the buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. This may be higher than buf_size. total_num_entries Total number of entries that could have been returned. This may be higher than num_entries. num_entries The number of entries actually returned. The last entry may be incomplete.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST name structure is included, but there are further user name structures that are not included in the data buffer. The num_last_users parameter indicates how many user name structures have been returned. The application can issue further verbs to obtain the remaining data. AP_NO The data for the last list is complete. Each entry in the data buffer consists of the following. security_access_detail.list_name The name of the security access list.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LIST_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, but the list_name parameter did not match the names of any defined security access list. AP_INVALID_USER_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, but the user_name parameter did not match a user name defined for the specified security access list.
NOF API Verbs (QUERY Verbs) QUERY_SESSION QUERY_SESSION QUERY_SESSION returns list information about sessions for a particular local LU. This verb can be used to obtain either summary or detailed information, about a specific session or a range of sessions, depending on the options used. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_SESSION FQPCID fqpcid; /* fully qualified procedure /* correlator ID */ */ cos_name[8]; trans_pri; ltd_res; polarity; contention; sess_stats; duplex_support sscp_id reserva; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* size of returned entry partner LU alias fully qualified partner LU name reserved mode name session ID fully qualified procedure correlator ID Class of Service name Transmission priority: Session spans a limited resource Session polarity Session co
NOF API Verbs (QUERY Verbs) QUERY_SESSION ; typedef struct session_stats { AP_UINT16 rcv_ru_size; AP_UINT16 send_ru_size; AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; /* /* /* /* /* /* /* /* cur_rcv_pac_win; /* /* send_data_frames; /* send_fmd_data_frames; /*
NOF API Verbs (QUERY Verbs) QUERY_SESSION buf_size Size of the supplied data buffer. num_entries Maximum number of sessions for which data should be returned. To request data for a specific session rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_SESSION For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. lu_name LU name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. To specify that the LU is identified by its alias rather than its LU name, set this parameter to 8 binary zeros and specify the LU alias in the following parameter.
NOF API Verbs (QUERY Verbs) QUERY_SESSION 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. mode_name Mode name filter. To return information only about sessions associated with a specific mode, specify the mode name; the partner LU must also be specified (using one of the two preceding parameters).
NOF API Verbs (QUERY Verbs) QUERY_SESSION total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: session_summary.overlay_size The size of the returned session_summary structure, and therefore the offset to the start of the next entry in the data buffer. session_summary.plu_alias Partner LU alias.
NOF API Verbs (QUERY Verbs) QUERY_SESSION session_detail.overlay_size The size of the returned session_detail structure, and therefore the offset to the start of the next entry in the data buffer. session_detail.plu_alias Partner LU alias. This is an 8-byte ASCII character string, right-padded with ASCII spaces. session_detail.fqplu_name Fully qualified network name for the partner LU. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_SESSION AP_LOW AP_MEDIUM AP_HIGH AP_NETWORK session_detail.ltd_res Specifies whether the session uses a limited resource link. Possible values are: AP_YES Session uses a limited resource link. AP_NO Session does not use a limited resource link. session_detail.polarity Specifies the polarity of the session. Possible values are: AP_PRIMARY AP_SECONDARY session_detail.
NOF API Verbs (QUERY Verbs) QUERY_SESSION session_detail.sess_stats.max_rcv_btu_size Maximum BTU size that can be received. session_detail.sess_stats.max_send_pac_win Maximum size of the send pacing window on this session. session_detail.sess_stats.cur_send_pac_win Current size of the send pacing window on this session. session_detail.sess_stats.max_rcv_pac_win Maximum size of the receive pacing window on this session. session_detail.sess_stats.
NOF API Verbs (QUERY Verbs) QUERY_SESSION session_detail.sess_stats.odai Origin Destination Assignor Indicator. When bringing up a session, the sender of the BIND sets this field to zero if the local node contains the primary link station. It sets it to one if the BIND sender is the node containing the secondary link station. session_detail.sess_stats.ls_name Link station name associated with statistics. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes.
NOF API Verbs (QUERY Verbs) QUERY_SESSION second. If the session is not fully active when the query is processed, this parameter is set to 0 (zero). session_detail.session_timeout The timeout associated with this session This timeout is derived from: • The LU 6.2 timeout associated with the local LU • The LU 6.2 timeout associated with the remote LU • The mode timeout • The global timeout • The limited resource timeout (if this session is running over a limited resource link) session_detail.
NOF API Verbs (QUERY Verbs) QUERY_SESSION Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The specified lu_alias parameter was not valid. AP_INVALID_LU_NAME The specified lu_name parameter was not valid.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET QUERY_SNA_NET QUERY_SNA_NET returns information about servers that can act as backup master servers, as defined in the sna.net file. It can be used to obtain information about a specific server or about multiple servers, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET unsigned char unsigned char } BACKUP_SUMMARY; server_name[64]; reserv2[4]; /* master or backup server name */ /* reserved */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_SNA_NET overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET Start at the entry specified by the server_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the server_name parameter. For more information about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”. The server names are listed in the same order as in the file, not in order of name length and/or lexicographical order as for other QUERY_* verbs.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET num_entries indicates that not all the available entries were returned. security The level of security for Windows clients accessing SNAplus2 servers. This is specified during installation, or can be modified later using the snapwinsec program; for more information about security for Windows clients, refer to the HP-UX SNAplus2 Administration Guide. Possible values are: AP_SECURITY_OFF No security restrictions.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS QUERY_STATISTICS QUERY_STATISTICS returns statistics on the usage of an LS or port. The type of information returned depends on the DLC type. The QLLC software does not support link statistics; do not issue this verb for a QLLC port or LS. For SDLC, the verb returns either statistics (counts of events such as particular frame types sent or received) or operational information (details of parameters currently being used), for either an LS or a port.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_UINT32 AP_UINT32 blus_out; octets_in; AP_UINT32 AP_UINT32 AP_UINT32 octets_out; polls_out; poll_rsps_out; AP_UINT32 local_busies; AP_UINT32 remote_busies; AP_UINT32 iframes_in; AP_UINT32 AP_UINT32 iframes_out; retransmits_in; AP_UINT32 retransmits_out; AP_UINT32 ioctets_in; AP_UINT32 ioctets_out; AP_UINT32 uiframes_in; AP_UINT32 uiframes_out; AP_UINT32 xids_in; AP_UINT32 xids_out; AP_UINT32 tests_in; AP_UINT32 tests_out; AP_UINT32 rejs_in; AP_UIN
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS typedef struct sdl_ls_oper_table { V0_MUX_INFO mux_info; AP_UINT32 index; unsigned char address; unsigned char reserve; AP_UINT16 role; unsigned char name[8]; AP_UINT16 state; AP_UINT16 maxdata; AP_UINT32 replyto; AP_UINT32 maxin; AP_UINT32 maxout; unsigned char modulo; unsigned char reserv2[3]; AP_UINT32 retries_m; AP_UINT32 retries_t; AP_UINT32 retries_n; AP_UINT32 rnrlimit; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* streams config info */ index
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_UINT32 local_busies; /* /* AP_UINT32 remote_busies; /* /* AP_UINT32 iframes_in; /* /* AP_UINT32 iframes_out; /* AP_UINT32 octets_in; /* /* AP_UINT32 octets_out; /* AP_UINT32 protocol_errs; /* /* AP_UINT32 activity_to_s; /* AP_UINT32 rnrlimit_s; /* AP_UINT32 retries_exps; /* AP_UINT32 retransmits_in; /* /* AP_UINT32 retransmits_out; /* } SDL_PORT_STATS_TABLE; number of times local link station */ has entered busy state (RNR) */ number of times remote link st
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS V0_MUX_INFO AP_UINT32 AP_UINT32 mux_info; ls_st_mus_sent; ls_st_mus_received; /* /* /* /* AP_UINT32 ls_st_bytes_sent; /* AP_UINT32 ls_st_bytes_received; /* } VDL_LS_STATISTICS; streams config info */ Frames sent from this Link Station */ Frames received at this Link */ Station */ Bytes sent from this Link Station */ Bytes received at this Link Station*/ typedef struct v0_mux_info { AP_UINT16 dlc_type; unsigned char need_vrfy_fixup; unsigned char num_mux_ids;
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS Return port statistics. For Token Ring / Ethernet / FDDI, this must be set to AP_LS. table_type The type of statistics information requested. Allowed values for SDLC: AP_STATS_TBL Statistical information. AP_OPER_TBL Operational information. For Token Ring / Ethernet / FDDI , this must be set to AP_STATS_TBL. reset_stats Specifies whether to reset the statistics when this verb completes.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_ETHERNET Ethernet AP_FDDI Fiber distributed data interface AP_X25 X.25 packet switching Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK dlc_type Type of DLC for which statistics information is being returned. Possible values are: AP_SDLC SDLC AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI AP_X25 X.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_DLSW Data link switching AP_TWINAX Twinaxial cable AP_ISDN Integrated services digital network AP_ATM Asynchronous transfer mode AP_ASYNC Asynchronous statistics Current statistics for the link station or port. This string is replaced by the appropriate structure for the DLC type. The parameters in the structure are described below. dlc_type, card_type, adapter_number Streams configuration information for the DLC.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.octets_in The total number of bytes (not including FCSs) received from the adjacent link station. sdl_ls_stats_table.octets_out The total number of bytes (not including FCSs) transmitted to the adjacent link station. sdl_ls_stats_table.polls_out Total number of polls sent to the adjacent link station. sdl_ls_stats_table.poll_rsps_out Total number of polls responded to by the adjacent link station. sdl_ls_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS The total number of bytes in I-frames received from the adjacent link station. sdl_ls_stats_table.ioctets_out The total number of bytes in I-frames transmitted to the adjacent link station. sdl_ls_stats_table.xids_in The total number of XID frames received from the adjacent link station. sdl_ls_stats_table.xids_out The total number of XID frames transmitted to the adjacent link station. sdl_ls_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.sims_out The total number of Set Initialization Mode frames transmitted to the adjacent link station. sdl_ls_stats_table.rims_in The total number of Request Initialization Mode frames received from the adjacent link station. sdl_ls_stats_table.rims_out The total number of Request Initialization Mode frames transmitted to the adjacent link station. sdl_ls_stats_table.snrm_in The total number of SNRM frames received. sdl_ls_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.maxdata The current maximum PDU size allowed for the logical link (the size includes the TH and RH). For a switched line, this value may be negotiated during XID exchange. sdl_ls_stats_table.replyto The current reply timeout, in hundredths of a second. This parameter applies only if the LS role is primary; its value is undefined if the LS role is secondary. sdl_ls_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.rnrlimit The maximum length of time that the adjacent LS can remain in RNR state before the local LS considers it to be inoperative. sdl_ls_stats_table.datmode The communications mode with the adjacent LS. Possible values are: SDL_MIB_HALF Two-way alternate (half-duplex) SDL_MIB_FULL Two-way simultaneous (full-duplex) sdl_ls_stats_table.last_fail_ctrl_in The control field from the last frame received before the last failure.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS Specifies whether the LS supports transmission of SIM and RIM control frames. Possible values are: SDL_MIB_YES LS supports SIM and RIM. SDL_MIB_NOLS does not support SIM and RIM. sdl_ls_stats_table.xmit_rcv_cap Specifies the LS's transmit / receive capability. Possible values are: SDL_MIB_HALF Half-duplex SDL_MIB_FULL Full-duplex Port statistics for SDLC: sdl_port_stats_table.index The index value used internally by SNAplus2 to identify the port.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_port_stats_table.iframes_in The total number of I-frames received from adjacent link stations (including retries and out-of-order frames). sdl_port_stats_table.iframes_out The total number of I-frames transmitted to adjacent link stations (including retries and out-of-order frames). sdl_port_stats_table.octets_in The total number of bytes (not including FCSs) received from adjacent link stations. sdl_port_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_port_stats_table.retransmits_out The total number of retransmissions of I-frames to adjacent link stations. Port operational information for SDLC: sdl_port_oper_table.index The index value used internally by SNAplus2 to identify the port. sdl_port_oper_table.role The link role of the port. Possible values are: SDL_MIB_PRIMARY Primary SDL_MIB_SECONDARY Secondary SDL_MIB_NEGOTIABLE Negotiable sdl_port_oper_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS port allows a switched line to remain inactive (no I-frames being transferred) before disconnecting. A value of zero indicates no timeout; the line remains connected regardless of inactivity. This parameter applies only for a switched link; its value is undefined for a leased link. sdl_port_oper_table.pause The length of time that the primary station waits between successive cycles of polling secondary stations.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LINK_NAME The supplied name parameter was not a valid LS name. AP_INVALID_PORT_NAME The supplied name parameter was not a valid port name. AP_INVALID_STATS_TYPE The stats_type parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS The specified link is not currently active. AP_PORT_DEACTIVATED The specified port is not currently active. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_TN_SERVER_TRACE QUERY_TN_SERVER_TRACE This verb returns information about the current tracing options for the SNAplus2 TN server feature. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_TN_SERVER_TRACE this is one of the following values: AP_TN_SERVER_NO_TRACE No tracing. AP_TN_SERVER_ALL_TRACE Tracing of all types. If tracing is being used on specific interfaces, this parameter is set to one or more values from the list below, combined using a logical OR operation.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF QUERY_TN3270_ACCESS_DEF QUERY_TN3270_ACCESS_DEF returns information about TN3270 users on other computers that can use the TN server feature of SNAplus2 to access a host for 3270 emulation. It can return either summary or detailed information, about a single user or multiple users, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF typedef struct tn3270_access_detail { AP_UINT16 default_record; /* unsigned char client_address[68]; /* AP_UINT32 num_filtered_sessions;/* TN3270_ACCESS_DEF_DATA def_data; /* } TN3270_ACCESS_DETAIL; typedef struct tn3270_access_def_data { unsigned char description[32]; unsigned char reserv1[16]; AP_UINT16 address_format; AP_UINT32 num_sessions; } TN3270_ACCESS_DEF_DATA; /* /* /* /* is this the DEFAULT record?*/ address of TN3270 user */ num sess returne
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF opcode AP_QUERY_TN3270_ACCESS_DEF sub_overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF one of the following values: AP_FIRST_IN_LIST Start at the first session for the first user in the list. AP_LIST_INCLUSIVE Start at the entry specified by the supplied client address and port number, or start at the first session for the specified client address if no port number is specified. AP_LIST_FROM_NEXT If a port number is specified, start at the session immediately following the session with the specified port number.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF (such as newbox). port_number To return information starting with a specific session for the specified user, set this parameter to the TCP/IP port number defined for that session. To return information starting at the first session for the specified user, set this parameter to zero.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF If the last_user_incomplete parameter indicates that the data for the last user is incomplete, this parameter indicates the number of session structures for this user that are included in the returned data. Otherwise, this parameter is not used. last_user_incomplete Specifies whether the information for the last user is incomplete. Possible values are: AP_YES The complete data for the last user was too large to fit in the data buffer.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF AP_ADDRESS_IP IP address AP_ADDRESS_FQN Alias or fully qualified name tn3270_access_detail.default_record Specifies whether this entry is the default record. Possible values are: AP_YES This is the default record. The client_address parameter is reserved. AP_NO This is a normal TN3270 user record. tn3270_access_detail.client_address The TCP/IP address of the TN3270 user. This is a null-terminated ASCII string. tn3270_access_detail.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF returned for the last user will be as specified by the num_last_sessions parameter; this will be less than num_sessions.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION QUERY_TN3270_ASSOCIATION QUERY_TN3270_ASSOCIATION returns information about associations between display LUs and printer LUs. Associations are queried by display LU name and are returned in order of display LU name. This verb can be used to obtain information about a specific association or about multiple associations, depending on the options used.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION unsigned char reserv2[8]; } TN3270_ASSOCIATION_DEF_DATA; /* reserved */ Data is returned in the form of tn3270_association structures.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION AP_LIST_INCLUSIVE Start at the entry specified by the display_lu_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the display_lu_name parameter. display_lu_name Name of the display LU for which association information is required or the name to be used as an index into the list of associations. The display LU name is an EBCDIC string padded on the right with EBCDIC spaces.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION tn3270_association.overlay_size The size of the returned tn3270_association structure (and therefore the offset to the start of the next entry in the data buffer). tn3270_association.display_lu_name Name of the display LU associated with the printer LU specified by the association.printer_lu_name parameter. This is an EBCDIC string padded on the right with EBCDIC spaces. tn3270_association_def_data.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION was not a valid EBCDIC string. • The list_options parameter was set to AP_LIST_INCLUSIVE, but the display LU name either was not a valid EBCDIC string or did not correspond to an existing association record. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_DEFAULTS QUERY_TN3270_DEFAULTS QUERY_TN3270_DEFAULTS returns information about TN3270 parameters used on all client sessions.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_DEFAULTS def_data.force_responses Controls client responses on printer sessions. Possible values are: AP_YES Requests definite responses. AP_NO Request responses matching SNA traffic. def_data.keepalive_method Method for sending keep-alive messages. Possible values are: AP_NONE Do not send keep-alive messages. This value is the default value. AP_TN3270_NOP Send Telnet NOP messages. AP_TN3270_TM Send Telnet DO TIMING-MARK messages. def_data.
NOF API Verbs (QUERY Verbs) QUERY_TP QUERY_TP QUERY_TP returns information about TPs that are currently using a local LU. This verb can be used to obtain information about a specific TP or about multiple TPs, depending on the options used. This verb returns information about current usage of the TPs, not about their definition; use QUERY_TP_DEFINITION to obtain the definition of the TPs. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_TP unsigned char } TP_DATA; reserva[20]; /* reserved */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_TP overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay structure returned, and should not rely on the use of the sizeof() function. buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information.
NOF API Verbs (QUERY Verbs) QUERY_TP AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of LU name and TP name. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. lu_name LU name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters.
NOF API Verbs (QUERY Verbs) QUERY_TP Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_TP locally (by the TP issuing a TP_STARTED verb). tp_data.remotely_started_count Number of instances of the TP that have been started remotely (by a received Attach request). Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION QUERY_TP_DEFINITION QUERY_TP_DEFINITION returns information about TPs defined on the SNAplus2 system. This verb can be used to obtain information about a specific TP or about multiple TPs, depending on the options used. It returns information about the definition of the TPs, not about their current usage; use QUERY_TP to obtain the usage information.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION typedef struct tp_chars { unsigned char description[32]; unsigned char security_list_name[14] unsigned char reserv1[2]; unsigned char conv_type; unsigned char security_rqd; unsigned char sync_level; unsigned char dynamic_load; unsigned char enabled; unsigned char pip_allowed; unsigned char unsigned char AP_UINT16 AP_UINT16 unsigned char } TP_CHARS; duplex_support; reserv3[10]; tp_instance_limit; tp_data_len; tp_data[120]; /* /* /* /* /* /* /* /* /* /* /* /*
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry. Specify the level of information with one of the following values: AP_SUMMARY Summary information only.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION parameters: primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION parameter restricts the TP so that only the users named in the specified list can allocate conversations with it. If this parameter is set to 14 binary zeros, the TP is available for use by any user. tp_def_detail.overlay_size The size of the returned tp_def_detail structure, and therefore the offset to the start of the next entry in the data buffer. tp_def_detail.tp_name TP name.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION tp_def_detail.tp_chars.sync_level Specifies the values of synchronization level supported by the TP. Possible values are: AP_NONE The TP supports only sync_level NONE. AP_CONFIRM_SYNC_LEVEL The TP supports only sync_level CONFIRM. AP_EITHER The TP supports either sync_level NONE or CONFIRM. AP_SYNCPT_REQUIRED The TP supports only sync_level SYNCPT (syncpoint is required).
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION AP_NO TP cannot receive PIP. tp_def_detail.tp_chars.duplex_support Specifies which conversation duplex types are supported by the TP. Possible values are: AP_HALF_DUPLEX The TP supports half-duplex conversations only. AP_FULL_DUPLEX The TP supports full-duplex conversations. AP_EITHER_DUPLEX The TP supports both half-duplex and full-duplex conversations. tp_def_detail.tp_chars.tp_instance_limit Limit on the number of concurrently active TP instances.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION the supplied name, but the tp_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO QUERY_TP_LOAD_INFO QUERY_TP_LOAD_INFO returns information about TP load information entries. The buffer contains a number of the variably sized tp_load_info structures. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO unsigned shor timeout; unsigned char type; unsigned char reserv2; AP_UINT16 reserv3; AP_UINT16 ltv_length; } TP_LOAD_INFO_DEF_DATA; /* /* /* /* /* Timeout value TP type reserved reserved Length of LTV data */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_TP_LOAD_INFO overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO AP_LIST_INCLUSIVE Start at the entry specified by the combination of TP name and LU alias. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of TP name and LU alias. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. tp_name TP name to query.
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: tp_load_info.overlay_size The size of this overlay, including the LTV data. This size includes padding to ensure that the next overlay falls on a properly aligned memory location.
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO AP_TP_QUEUED_BROADCAST AP_TP_NON_QUEUED def_data.ltv_length Length of the LTV data buffer appended to this structure. Each LTV structure is specified in “TP_LOAD_INFO_LTV” under “DEFINE_TP_LOAD_INFO”.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_FILE QUERY_TRACE_FILE This verb returns information about the files that SNAplus2 uses to record trace data. This verb may be issued to a running node, or (for client-server trace files only) to a HP-UX client computer on which the SNAplus2 software is running. To obtain a target handle for the client in order to issue this verb, use the CONNECT_NODE verb without specifying a node name; the NOF application must be running on the client.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_FILE File contains tracing on data transferred across the SNAplus2 LAN between the specified computer and other nodes (activated by the SET_CS_TRACE verb). AP_BCK_CS_TRACE File contains tracing on data transferred across the SNAplus2 LAN between a current-level server and back-level computers (activated by the SET_BCK_CS_TRACE verb). AP_TN_SERVER_TRACE File contains tracing on the SNAplus2 TN server component.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_FILE space; the maximum space required is approximately twice the value of trace_file_size. AP_NO Tracing is to one file. trace_file_size The maximum size of the trace file. If dual_files is set to AP_YES, tracing will switch between the two files when the current file reaches this size. If dual_files is set to AP_NO, this parameter is ignored; the file size is not limited. file_name Name of the trace file, or of the first trace file if dual_files is set to AP_YES.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_FILE AP_INVALID_FILE_TYPE The trace_file_type parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_TYPE QUERY_TRACE_TYPE This verb returns information about the current tracing options for SNAplus2 kernel components. For more information about tracing options, see the HP-UX SNAplus2 Administration Guide. This verb does not return information about DLC line tracing. To do this, use the QUERY_DLC_TRACE verb. This verb must be issued to a running node.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_TYPE secondary_rc Not used. trace_flags The types of tracing currently active. For more information about these trace types, see “SET_TRACE_TYPE”. If no tracing is active, or if tracing of all types is active, this is one of the following values: AP_NO_TRACE No tracing. AP_ALL_TRACE Tracing of all types. If tracing is being used on specific interfaces, this parameter is set to one or more values from the list below, combined using a logical OR operation.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_TYPE SDLC messages AP_NLI_MSG NLI messages AP_DLC_MSG Node to DLC messages AP_NODE_MSG Node messages AP_SLIM_MSG Messages sent between master and backup servers in a client-server system AP_DATAGRAM Datagram messages truncation_length The maximum length, in bytes, of the information written to the trace file for each message.
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD QUERY_USERID_PASSWORD QUERY_USERID_PASSWORD returns information about user ID / password pairs for use with APPC and CPI-C conversation security, or about profiles for a defined user ID and password. It can be used to obtain information about a specific user ID / password pair or about multiple pairs, depending on the options used. This verb returns password information in clear text.
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD AP_UINT16 AP_UINT16 unsigned char unsigned char } USERID_PASSWORD_CHARS; profile_count; reserv1; password[10]; profiles[10][10]; /* /* /* /* number of profiles reserved password profiles */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_USERID_PASSWORD overlay_size For compatability with future releases of SNAplus2, your application must use this field to determine the exact length of the overlay struct
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD AP_LIST_INCLUSIVE Start at the entry specified by the user_id parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the user_id parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see “List Options For QUERY_* Verbs”. user_id User ID. This is a 10-byte type-AE EBCDIC string, padded on the right with spaces if the name is shorter than 10 characters.
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD Each entry in the data buffer consists of the following parameters: userid_info.overlay_size The size of the returned userid_info structure, and therefore the offset to the start of the next entry in the data buffer. userid_info.user_id User identifier. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces. userid_info.password_chars.
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD AP_INVALID_USERID The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied user ID, but the user_id parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
5 NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) Chapter 5 991
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REGISTER_INDICATION_SINK REGISTER_INDICATION_SINK REGISTER_INDICATION_SINK registers the NOF application to receive indications of a particular type; for details of the SNAplus2 NOF indications, see Chapter 6, “NOF Indications.” The application specifies the required type of indication by its opcode parameter; an application can register more than once to accept multiple indication types.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REGISTER_INDICATION_SINK AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; AP_UINT32 proc_id; AP_UINT16 queue_id; AP_UINT16 indication_opcode; } REGISTER_INDICATION_SINK; /* /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code reserved reserved opcode of indication to be sunk */ */ */ */ */ */ */ */ Supplied Parameters The appli
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REGISTER_INDICATION_SINK Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REGISTER_INDICATION_SINK codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node does not support the function associated with the specified indication, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support the specified indication.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE REMOVE_DLC_TRACE This verb removes DLC line tracing that was previously specified using ADD_DLC_TRACE. It can be used to remove all tracing on a resource that is currently being traced, to remove the tracing of certain messages from a resource currently being traced, or to remove all DLC line tracing.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE Supplied Parameters The application supplies the following parameters: opcode AP_REMOVE_DLC_TRACE resource_type The resource type of the trace entry to remove or modify. Possible values are: AP_ALL_DLC_TRACES Remove all DLC tracing options, so that no resources are traced. If this option is specified, the remaining parameters on this verb (resource_name through message_type) are reserved.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE if resource_type is set to AP_ALL_DLC_TRACES or AP_ALL_RESOURCES. lfsid The Local Form Session Identifier for a session on the specified LS. This is only valid for resource_type AP_LS, and indicates that only messages on this session are to be removed. The structure contains the following three values, which are returned in the SESSION_STATS section of a QUERY_SESSION verb: lfsid.uu.s.sidh Session ID high byte. lfsid.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns one of the following.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE that is not currently being traced for the specified resource. AP_ALL_RESOURCES_NOT_DEFINED The resource_type parameter was set to AP_ALL_RESOURCES, but there is no DLC_TRACE entry defined for tracing options on all resources. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT RESET_SESSION_LIMIT The RESET_SESSION_LIMIT verb requests SNAplus2 to reset the session limits for a particular LU-LU-mode combination. Sessions may be deactivated as a result of processing this verb.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is defined by its LU alias instead of its LU name, set this parameter to 8 binary zeros. lu_alias LU alias of the local LU, as defined to SNAplus2.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT (starting with a letter), padded on the right with EBCDIC spaces if the name is shorter than 8 bytes. mode_name_select Selects whether session limits should be reset on a single specified mode, or on all modes between the local and partner LUs. Possible values are: AP_ONE Reset session limits on the mode specified by mode_name. AP_ALL Reset session limits on all modes.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT The partner LU is responsible for deactivating sessions. drain_source Specifies whether the source LU satisfies waiting session requests before deactivating a session. Possible values are: AP_YES Waiting session requests are satisfied. AP_NO Waiting session requests are not satisfied. drain_target Specifies whether the target LU satisfies waiting session requests before deactivating a session.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT secondary_rc Possible values are: AP_FORCED The session limits were set to zero even though CNOS negotiation failed. AP_AS_NEGOTIATED The session limits were changed, but one or more values were negotiated by the partner LU. AP_AS_SPECIFIED The session limits were changed as requested, without being negotiated by the partner LU.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT The mode_name_select parameter was not set to a valid value. AP_INVALID_DRAIN_SOURCE The drain_source parameter was not set to a valid value. AP_INVALID_DRAIN_TARGET The drain_target parameter was not set to a valid value. AP_INVALID_FORCE The force parameter was not set to a valid value. AP_INVALID_RESPONSIBLE The responsible parameter was not set to a valid value.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT Returned Parameters: Session Allocation Error If the verb does not execute because of a session allocation error, SNAplus2 returns the following parameters: primary_rc AP_ALLOCATION_ERROR secondary_rc AP_ALLOCATION_FAILURE_NO_RETRY A session could not be allocated because of a condition that requires corrective action.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_BCK_CS_TRACE SET_BCK_CS_TRACE This verb specifies options for back-level client-server tracing (tracing of data sent between a current-level SNAplus2 server and a back-level server or client).
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_BCK_CS_TRACE AP_BCK_ALL_TRACE Tracing of all types. To activate tracing on specific message types, select one or more values from the list below, combined using a logical OR operation.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_BCK_CS_TRACE requested interfaces. Possible values are: AP_YES Tracing is to be activated at the interfaces specified by the trace_flags parameter. AP_NO Tracing is to be deactivated at the interfaces specified by the trace_flags parameter. If init_flags is set to AP_YES, this parameter is ignored.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_BUFFER_AVAILABILITY SET_BUFFER_AVAILABILITY This verb specifies the amount of STREAMS buffers that SNAplus2 can use at any one time. This allows the node to make efficient use of the buffers available, and allows you to ensure that buffers are available for other processes on the HP-UX computer.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CENTRAL_LOGGING SET_CENTRAL_LOGGING This verb specifies whether SNAplus2 log messages are sent to a central file from all servers, or to a separate file on each server. For more information, see “SET_LOG_FILE”. This verb must be issued to the node that is currently acting as the central logger; for information about accessing this node, see “CONNECT_NODE”.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CENTRAL_LOGGING Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CS_TRACE SET_CS_TRACE This verb specifies tracing options for data sent between computers on the SNAplus2 LAN. For more information about tracing options, see the HP-UX SNAplus2 Administration Guide. This verb may be issued to a running node, or to a HP-UX client computer on which the SNAplus2 software is running.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CS_TRACE target_handle parameter on the NOF API call) and one other server on the LAN, specify the name of the other server here. Tracing on messages flowing to and from other computers on the LAN will be unchanged; in particular, you can issue two SET_CS_TRACE verbs to activate tracing between the same target computer and two different destination servers.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CS_TRACE Trace messages flowing from the target computer to the computer defined by dest_sys. AP_CS_RECEIVE Trace messages flowing from the computer defined by dest_sys to the target computer. AP_CS_BOTH Trace messages flowing in both directions. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_CS_TRACE Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_GLOBAL_LOG_TYPE SET_GLOBAL_LOG_TYPE This verb specifies the types of information that SNAplus2 records in log files. It specifies default values that are used on all servers; SET_LOG_TYPE can then be used to override these defaults on a particular server. For more information about log file, see “SET_LOG_FILE”.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_GLOBAL_LOG_TYPE AP_UINT32 secondary_rc; unsigned char audit; unsigned char exception; unsigned char succinct_audits; unsigned char succinct_errors; } SET_GLOBAL_LOG_TYPE; /* /* /* /* /* secondary return code */ audit logging on or off */ exception logging on or off */ use succinct logging in audit file?*/ use succinct logging in error file?*/ Supplied Parameters The application supplies the following parameters: opcode AP_SET_GLO
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_GLOBAL_LOG_TYPE definition. (The initial default, when the SNAplus2 software is started, is that exception messages are recorded.) succinct_audits Specifies whether to use succinct logging or full logging in the audit log file.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_GLOBAL_LOG_TYPE Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_KERNEL_MEMORY_LIMIT SET_KERNEL_MEMORY_LIMIT This verb specifies a limit on the amount of kernel memory that SNAplus2 can use at any one time. This allows you to ensure that memory is available for other processes on the HP-UX computer. You can also specify the kernel memory limit when starting the SNAplus2 software (for more information, see the HP-UX SNAplus2 Administration Guide).
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_KERNEL_MEMORY_LIMIT parameters: primary_rc AP_OK secondary_rc Not used. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE SET_LOG_FILE This verb manages a file that SNAplus2 uses to record log messages. It allows you to do the following: • Specify the file used to record log messages, and the backup file (to which log information is copied). • Specify the maximum log file size (when the log file reaches this size, SNAplus2 copies log information to the backup file and resets the log file).
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE The type of log file being managed. Possible values are: AP_AUDIT_FILE Audit log file (audit messages only). AP_ERROR_FILE Error log file (problem and exception messages). To record both types of messages in the same file, issue two SET_LOG_FILE verbs for the same file name, specifying AP_AUDIT_FILE on one verb and AP_ERROR_FILE on the other. action The action to be taken on the log file.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE issued. This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero). To continue logging to the file specified on a previous SET_LOG_FILE verb, specify a null string. backup_file_name Name of the backup log file. When the log file reaches the size specified by file_size below, SNAplus2 copies the current contents to the backup file and then clears the log file.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE according to the size of the SNAplus2 client-server network, to allow for the volume of log information generated in larger systems.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE SET_LOG_TYPE This verb specifies the types of information that SNAplus2 records in log files on a particular server. It can be used to override the default settings specified on SET_GLOBAL_LOG_TYPE, or to remove the override so that this server reverts to using the default settings. For more information about log files, see “SET_LOG_FILE”.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE unsigned char unsigned char unsigned char } SET_LOG_TYPE; exception; succinct_audits; succinct_errors; /* exception logging on or off */ /* use succinct logging in audit file?*/ /* use succinct logging in error file?*/ Supplied Parameters The application supplies the following parameters: opcode AP_SET_LOG_TYPE override Specifies whether this verb is being used to override the global log types specified on SET_GLOBAL_LO
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE Leave audit logging unchanged from the existing definition. exception Specify whether exception messages are recorded on this server. Possible values are: AP_YES Exception messages are recorded. AP_NO Exception messages are not recorded. AP_LEAVE_UNCHANGED Leave exception logging unchanged from the existing definition.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE either be from the SET_GLOBAL_LOG_TYPE verb, or from a SET_LOG_TYPE verb issued to that server to override the default. succinct_errors Specifies whether to use succinct logging or full logging in the error log file on this server; this applies to both exception logs and problem logs. The allowed values and their meanings are the same as for the succinct_audits parameter.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_PROCESSING_MODE SET_PROCESSING_MODE This verb specifies how the NOF application interacts with the target node, configuration file, or SNA network data file: whether the application has read-only access or read/write access, and whether the application has exclusive access to the domain configuration file so that other applications cannot access it.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_PROCESSING_MODE QUERY_* verbs, which do not modify the configuration. This option can be used with either a file or a node as the target. AP_MODE_READ_WRITE Read / write mode: the application may use any NOF API verbs. This option can be used with either a file or a node as the target.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_PROCESSING_MODE AP_INVALID_TARGET_MODE The mode parameter was not valid for the selected target. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_PROCESSING_MODE master server. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TN_SERVER_TRACE SET_TN_SERVER_TRACE This verb specifies tracing options for the SNAplus2 TN server component. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TN_SERVER_TRACE AP_TN_SERVER_TRC_FM Node interface tracing: internal control messages, and messages between TN server and TN3270 clients (in internal format) AP_TN_SERVER_TRC_CFG Configuration message tracing: messages relating to the configuration of TN server AP_TN_SERVER_TRC_NOF Internal node operator function (NOF) tracing: trace NOF requests made by TN server.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE SET_TRACE_FILE This verb specifies the name of a file that SNAplus2 uses to record trace data. If you issue a second SET_TRACE_FILE verb specifying a new file for the same file type, all subsequent trace information will be written to the new file; the existing file is not removed, but further information will not be written to it.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE opcode AP_SET_TRACE_FILE trace_file_type The type of trace file. Possible values are: AP_CS_TRACE File contains tracing on data transferred across the SNAplus2 LAN between the specified computer and other nodes (activated by the SET_CS_TRACE verb). AP_BCK_CS_TRACE File contains tracing on data transferred across the SNAplus2 LAN between a current-level server and back-level computers.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE existing definition. (The initial default, when the SNAplus2 software is started, is to use two files.) trace_file_size The maximum size of the trace file, in bytes. To continue using the existing file size definition, specify zero. If dual_files is set to AP_YES, tracing will switch between the two files when the current file reaches this size.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE (either relative to the application's working directory or a full path) on any computer to which this verb is issued. This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero). Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE SET_TRACE_TYPE This verb specifies tracing options for SNAplus2 kernel components. You can use this verb to specify the state of tracing (on or off) at all interfaces, or to turn tracing on or off at specific interfaces (leaving tracing at other interfaces unchanged). For more information about tracing options, see the HP-UX SNAplus2 Administration Guide. This verb does not control DLC line tracing.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE following values: AP_NO_TRACE No tracing. AP_ALL_TRACE Tracing of all types. To control tracing on specific interfaces, select one or more values from the list below, combined using a logical OR operation. For more information about these trace types, see “Trace Types”.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE truncation_length Specify the maximum length, in bytes, of the information to be written to the trace file for each message. This value must be at least 256. If a trace message is longer than the length specified in this parameter, SNAplus2 writes only the start of the message to the trace file, and discards the data beyond truncation_length.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE by the trace_flags parameter. If init_flags is set to AP_YES, this parameter is ignored. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE Figure 5-1 Overall Structure of SNAplus2 Figure 5-1, “Overall Structure of SNAplus2,” shows the following types of tracing, each of which can be controlled separately: APPC messages Messages between the APPC library and the node FM messages Messages between the 3270 emulation program and the node LUA messages Messages between the LUA library and the node NOF messages Messages between the NOF library and the node MS messa
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_TYPE SNA data sent on a DLC (tracing on these messages is controlled by the ADD_DLC_TRACE verb, not by SET_TRACE_TYPE) Node to DLC messages Messages between the APPN node and the DLC component In addition, the following message types (internal to SNAplus2) can be traced: Node messages Messages between components within the APPN protocol code SLIM messages Messages sent between master and backup servers in a client-server system
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_DLC START_DLC START_DLC requests the activation of a DLC. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_DLC Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_DLC The dlc_name parameter was not the name of a defined DLC. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_INTERNAL_PU START_INTERNAL_PU START_INTERNAL_PU requests DLUR to initiate SSCP-PU session activation for a previously defined local PU which is served by DLUR. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_INTERNAL_PU A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters. To use the DLUS specified in the DEFINE_INTERNAL_PU verb, or the global default specified in DEFINE_DLUR_DEFAULTS if none was specified in DEFINE_INTERNAL_PU, set this parameter to 17 binary zeros. bkup_dlus_name Name of DLUS node which DLUR will store as the backup DLUS for the given PU.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_INTERNAL_PU The bkup_dlus_name parameter contained a character that was not valid or was not in the correct format. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_INTERNAL_PU The local node rejected a message from the DLUS. This may be caused by an internal error, a resource shortage, or a problem with the received message; check the SNAplus2 log files for messages providing more information.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS START_LS START_LS normally starts an inactive LS. Alternatively, it can be used to leave the LS inactive but specify that it can be activated automatically by SNAplus2 when required or activated by the remote system. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS The LS can be activated automatically by SNAplus2 when required for a session. This value should be used only when the LS is defined to be auto-activatable (auto_act_supp in the LS definition is set to AP_YES); it re-enables auto-activation after the LS has been manually stopped using STOP_LS. AP_REMOTE_ACT The LS can be activated by the remote system.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_ACTIVATION_LIMITS_REACHED The activation limits have been reached. AP_LINK_DEACT_IN_PROGRESS The specified LS is currently being deactivated. You cannot start it until the deactivation process has finished. AP_ALREADY_STARTING The specified LS is already starting. AP_PARALLEL_TGS_NOT_SUPPORTED A link to the remote system is already active.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS primary_rc AP_CANCELLED secondary_rc Possible values are: AP_NO_SECONDARY_RC A STOP_LS verb was issued before the START_LS verb had completed. The START_LS verb was cancelled. AP_LINK_DEACTIVATED The DLC or port used by the LS was stopped before the START_LS verb had completed. The START_LS verb was cancelled.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_PORT START_PORT START_PORT requests the activation of a port. The DLC specified for the port must be active before this verb is issued. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_PORT primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_PORT The port_name parameter was not the name of a defined port. Appendix A, “Common Return Codes,” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_PORT Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_DLC STOP_DLC STOP_DLC requests SNAplus2 to stop a DLC; this also stops any active ports and LSs that use the DLC. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_DLC Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_DLC The dlc_name parameter did not match the name of a defined DLC.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_DLC returns the following parameters: primary_rc AP_CANCELLED The stop_type parameter specified an orderly stop, but the DLC was then stopped by a second command specifying an immediate stop or by a failure condition. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_INTERNAL_PU STOP_INTERNAL_PU STOP_INTERNAL_PU requests DLUR to initiate SSCP-PU session deactivation for a previously defined local PU which is served by DLUR. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_INTERNAL_PU parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc AP_INVALID_STOP_TYPE The stop_type parameter was not set to a valid value. Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_INTERNAL_PU Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_LS STOP_LS STOP_LS stops an active LS. Alternatively, it can be issued for an inactive LS, to specify that the LS cannot be activated automatically by SNAplus2 when required or activated by the remote system; if both of these are disabled, the LS can be activated only by issuing START_LS. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_LS defined by a DEFINE_LS verb. disable Specifies the action to be taken for the LS. To stop an active LS and return to the default settings for auto-activation and remote activation, set this parameter to AP_NO.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_LS Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_LINK_NOT_DEFD The ls_name parameter did not match the name of a defined LS. AP_UNRECOGNIZED_DEACT_TYPE The stop_type parameter was not set to a valid value.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_PORT STOP_PORT STOP_PORT allows the application to stop a port. This also stops any active LSs that are using the port. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_PORT parameters: primary_rc AP_OK Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_PORT_NAME The port_name parameter did not match the name of a defined port. AP_UNRECOGNIZED_DEACT_TYPE The stop_type parameter was not set to a valid value.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_PORT The stop_type parameter specified an orderly stop, but the port was then stopped by a second verb specifying an immediate stop or by a failure condition. Returned Parameters: Other Conditions Appendix A, “Common Return Codes,” lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) TERM_NODE TERM_NODE TERM_NODE allows the application to stop the node with a specified urgency. This also stops all connectivity resources associated with the node. If an RJE workstation is using LUs owned by the node, it will not automatically stop when the node is stopped (unless it was started with the “stop after inactivity” option); it must be stopped manually. This verb must be issued to a running node.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) TERM_NODE AP_QUIESCE Indicate to the network that the node is quiesced, reset session limits on all modes, unbind all endpoint sessions for the node's LUs, and then stop as for AP_SHUTDOWN.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) UNREGISTER_INDICATION_SINK UNREGISTER_INDICATION_SINK UNREGISTER_INDICATION_SINK unregisters the NOF application so that it no longer receives indications of a particular type (previously specified using REGISTER_INDICATION_SINK). If the application has registered more than once to accept multiple indication types, it must unregister separately for each indication that it no longer wants to receive.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) UNREGISTER_INDICATION_SINK indication_opcode The opcode parameter of the indication that is no longer required.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) UNREGISTER_INDICATION_SINK primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) UNREGISTER_INDICATION_SINK 1080 Chapter 5
6 NOF Indications Chapter 6 1081
NOF Indications Overview Overview This chapter provides the following information for each NOF indication: • Description of the indication's purpose and usage • Verb control block (VCB) structure, as defined in the NOF API header file nof_c.h • Explanations of the parameters returned to the application in the VCB For information about how the application registers to receive NOF indications, see “REGISTER_INDICATION_SINK”.
NOF Indications CONFIG_INDICATION CONFIG_INDICATION This indication is generated when another NOF application or a SNAplus2 administration tool makes a change to the target configuration, when the target node is stopped or started, or when a DLC, port, or LS owned by the target node is stopped or started. The target can be the domain configuration file, a running node, or an inactive node on a server where the SNAplus2 software is running.
NOF Indications CONFIG_INDICATION The range of VCBs that can be returned as configuration indications depends on the type of target handle specified on REGISTER_INDICATION_SINK: Domain configuration file The application can receive VCBs for any verbs that modify domain resources but not node resources (verbs that can be issued to the domain configuration file). Node configuration file The application can receive VCBs for any verbs that modify node resources.
NOF Indications DIRECTORY_INDICATION DIRECTORY_INDICATION This indication is generated when an entry is added to or removed from the local directory database.
NOF Indications DIRECTORY_INDICATION Later fields in this VCB may be set to zeros. AP_NO No previous directory indications were lost. removed Specifies whether the indicated resource has been removed from the directory or added to it. Possible values are: AP_YES The entry has been removed. AP_NO The entry has been added. resource_name Fully qualified name of the resource. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF Indications DIRECTORY_INDICATION Local resource. AP_CACHE Cached entry. parent_type Specifies the parent type of the resource being registered. If resource_type is AP_NNCP_RESOURCE, this parameter is not used. Possible values are: AP_NNCP_RESOURCE Network node. AP_ENCP_RESOURCE End node. description Chapter 6 A null-terminated text string describing the resource, as specified in the definition of the resource.
NOF Indications DLC_INDICATION DLC_INDICATION This indication is generated when a DLC changes state between active and inactive.
NOF Indications DLC_INDICATION deactivated Specifies whether the DLC has become inactive or become active. Possible values are: AP_YES The DLC has become inactive. AP_NO The DLC has become active. dlc_name Name of DLC. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. description A null-terminated text string describing the DLC, as specified in the definition of the DLC.
NOF Indications DLUR_LU_INDICATION DLUR_LU_INDICATION This indication is generated when a DLUR LU is activated or deactivated. This indication can be used by a registered application to maintain a list of currently active DLUR LUs.
NOF Indications DLUR_LU_INDICATION No previous directory indications were lost. reason Reason for this indication. Possible values are: AP_ADDED The DLUR has just been activated by the DLUS. AP_REMOVED The DLUR has been deactivated, either explicitly by the DLUS or implicitly by a link failure or the deactivation of the PU. lu_name Name of the logical unit (LU). This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces.
NOF Indications DLUR_PU_INDICATION DLUR_PU_INDICATION This indication is generated when a physical unit (PU) for the node that supports the dependent LU requester (DLUR) function is attempting to activate, fails to activate, activates, or is deactivated. This indication can be used to maintain a list of currently active DLUR PUs.
NOF Indications DLUR_PU_INDICATION the data_lost parameter on the next indication after the condition has cleared. Possible values are: AP_YES One or more previous directory indications were lost. Later fields in this VCB may be set to zeros. AP_NO No previous directory indications were lost. reason Cause of the indication. Possible values are: Possible values are: AP_ACTIVATION_STARTED The PU is activating. AP_ACTIVATING The PU has become active. AP_DEACTIVATING The PU has become inactive.
NOF Indications DLUR_PU_INDICATION Location of the PU. Possible values are: AP_INTERNAL The PU has been defined by a DEFINE_INTERNAL_PU verb. AP_DOWNSTREAM The PU is located at a downstream computer. dlur_pu_detail.pu_status Status of the PU, as seen by the DLUR. Possible values are: AP_RESET_NO_RETRY The PU is in reset state and will not be retried. AP_RESET_RETRY The PU is in reset state and will be retried. AP_PEND_ACTPU The PU is waiting for an ACTPU from the host.
NOF Indications DLUR_PU_INDICATION to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters. If the reason parameter is set to AP_FAILED, the dlus_name parameter is set to all zeros. dlur_pu_detail.dlus_session_status Status of the DLUS pipe currently being used by the PU. Possible values are: AP_PENDING_ACTIVE The DLUS pipe is currently being activated. AP_ACTIVE The DLUS pipe is active. AP_PENDING_INACTIVE The DLUS pipe is currently being deactivated.
NOF Indications DLUS_INDICATION DLUS_INDICATION This indication is generated when a pipe to a DLUS node changes state between active and inactive. When the pipe becomes inactive, the indication also includes pipe statistics.
NOF Indications DLUS_INDICATION Parameters opcode AP_DLUS_INDICATION primary_rc AP_OK data_lost Specifies whether any previous DLUS indications have been lost. If SNAplus2 detects a condition that prevents it from sending an indication (for example an internal resource shortage), it indicates this by setting the data_lost parameter on the next indication after the condition has cleared. Possible values are: AP_YES One or more previous downstream LU indications were lost.
NOF Indications DLUS_INDICATION over the pipe. pipe_stats.actpu_received Number of ACTPUs received from DLUS over the pipe. pipe_stats.actpu_rsp_sent Number of RSP(ACTPU)s sent to DLUS over the pipe. pipe_stats.reqdactpu_sent Number of REQDACTPUs sent to DLUS over the pipe. pipe_stats.reqdactpu_rsp_received Number of RSP(REQDACTPU)s received from DLUS over the pipe. pipe_stats.dactpu_received Number of DACTPUs received from DLUS over the pipe. pipe_stats.
NOF Indications DLUS_INDICATION Number of SSCP-PU MUs sent to DLUS over the pipe. pipe_stats.sscp_lu_mus_rcvd Number of SSCP-LU MUs received from DLUS over the pipe. pipe_stats.sscp_lu_mus_sent Number of SSCP-LU MUs sent to DLUS over the pipe.
NOF Indications DOWNSTREAM_LU_INDICATION DOWNSTREAM_LU_INDICATION This indication is generated when either the LU-SSCP session or the PLU-SLU session between the downstream LU and the host changes state between active and inactive. When one of these sessions becomes inactive, the indication also includes session statistics for that session.
NOF Indications DOWNSTREAM_LU_INDICATION unsigned long unsigned long unsigned long unsigned long unsigned long unsigned long unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; send_data_frames; send_fmd_data_frames; send_data_bytes; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; reserve; /* /* /* /* /* /* /* /* /* /* /* number of data frames sent num fmd data frames sent number of data bytes sent number of data frames received num f
NOF Indications DOWNSTREAM_LU_INDICATION ls_name Name of the link station associated with the downstream LU. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. dslu_name Name of the downstream LU. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. description A null-terminated text string describing the downstream LU, as specified in the definition of the LU.
NOF Indications DOWNSTREAM_LU_INDICATION Possible values are: AP_PU_CONCENTRATION Downstream LU is served by PU concentration. AP_DLUR Downstream LU is served by DLUR. If the LU-SSCP session was deactivated, a session_stats structure is included for this session; if the PLU-SLU session was deactivated, session_stats structures are included for the downstream and upstream PLU-SLU sessions. The fields in this structure are as follows: rcv_ru_size Maximum receive RU size.
NOF Indications DOWNSTREAM_LU_INDICATION Current size of the receive pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) send_data_frames Number of normal flow data frames sent. send_fmd_data_frames Number of normal flow FMD data frames sent. send_data_bytes Number of normal flow data bytes sent. rcv_data_frames Number of normal flow data frames received. rcv_fmd_data_frames Number of normal flow FMD data frames received.
NOF Indications DOWNSTREAM_LU_INDICATION spaces if the name is shorter than 8 characters. (In the upstream PLU-SLU session statistics, this parameter is reserved if dspu_services is set to AP_PU_CONCENTRATION.
NOF Indications DOWNSTREAM_PU_INDICATION DOWNSTREAM_PU_INDICATION This indication is generated when the PU-SSCP session between the downstream PU and the host changes state between active and inactive. When the session becomes inactive, the indication also includes PU-SSCP session statistics.
NOF Indications DOWNSTREAM_PU_INDICATION unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; sidh; sidl; odai; ls_name[8]; reserve; /* /* /* /* /* session ID high byte (from LFSID) session ID low byte (from LFSID) ODAI bit set Link station name reserved */ */ */ */ */ Parameters opcode AP_DOWNSTREAM_PU_INDICATION primary_rc AP_OK data_lost Specifies whether any previous downstream PU indications have been lost.
NOF Indications DOWNSTREAM_PU_INDICATION Name of the link station associated with the downstream PU. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. pu_sscp_sess_active Specifies whether the PU-SSCP session to the downstream PU is active. Possible values are: AP_YES The session is active. AP_NO The session is not active. dspu_services Specifies the services provided by the local node to the downstream PU.
NOF Indications DOWNSTREAM_PU_INDICATION Reserved (always set to zero). pu_sscp_stats.max_rcv_pac_win Reserved (always set to zero). pu_sscp_stats.cur_rcv_pac_win Reserved (always set to zero). pu_sscp_stats.send_data_frames Number of normal flow data frames sent. pu_sscp_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. pu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. pu_sscp_stats.rcv_data_frames Number of normal flow data frames received. pu_sscp_stats.
NOF Indications DOWNSTREAM_PU_INDICATION spaces if the name is shorter than 8 characters.
NOF Indications FOCAL_POINT_INDICATION FOCAL_POINT_INDICATION This indication is generated whenever a focal point is acquired, changed or revoked.
NOF Indications FOCAL_POINT_INDICATION No previous focal point indications were lost. ms_category Management Services category for which the focal point has changed. This can be either one of the category names specified in the MS Discipline-Specific Application Programs table contained in the SNA Management Services Reference, padded on the right with spaces if the name is shorter than 8 bytes, or a user-defined category.
NOF Indications FOCAL_POINT_INDICATION AP_DEFAULT_PRIMARY_FP AP_DOMAIN_FP AP_HOST_FP AP_NO_FP fp_status Status of the focal point. Possible values are: AP_NOT_ACTIVE The focal point has gone from active to inactive. AP_ACTIVE The focal point has gone from inactive or pending active to active. fp_routing Type of routing that applications should specify when sending data to the focal point. This parameter is used only if the focal point status is AP_ACTIVE.
NOF Indications LOCAL_LU_INDICATION LOCAL_LU_INDICATION This indication is generated when a local LU is defined or deleted. This indication can be used by a registered application to maintain a list of all local LUs currently defined.
NOF Indications LOCAL_LU_INDICATION NB_COUNTER NB_COUNTER unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; pacing_type /* num of fmd data frames received */ /* number of data bytes received */ /* session ID high byte */ /* session ID low byte */ /*origin-destination assignor bit set*/ /* link station name */ /* type of pacing in use */ The LU-SSCP statistics contained in the session_stats structure ar
NOF Indications LOCAL_LU_INDICATION AP_REMOVED The LU has been deleted, either explicitly using DELETE_LOCAL_LU, or implicitly, using DELETE_LS, DELETE_PORT, or DELETE_DLC. AP_SSCP_ACTIVE The LU-SSCP session has become active after the node has successfully processed an ACTLU. AP_SSCP_INACTIVE The LU-SSCP session has become inactive after a normal DACTLU or a link failure. lu_name Name of the local logical unit (LU) whose state has changed.
NOF Indications LOCAL_LU_INDICATION lu_sscp_sess_active Specifies whether the LU-SSCP session is active. If the nau_address parameter is set to 0 (zero), this parameter is reserved. Possible values are: AP_YES The LU-SSCP session is active. AP_NO The LU-SSCP session is not active. lu_sscp_stats.rcv_ru_size This parameter is always reserved. lu_sscp_stats.send_ru_size This parameter is always reserved. lu_sscp_stats.max_send_btu_size Maximum basic transmission unit (BTU) that can be sent. lu_sscp_stats.
NOF Indications LOCAL_LU_INDICATION (FMD) frames sent. lu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. lu_sscp_stats.rcv_data_frames Number of normal flow data frames received. lu_sscp_stats.rcv_fmd_data_frames Number of normal flow function management data (FMD) frames received. lu_sscp_stats.rcv_data_bytes Number of normal flow data bytes received. lu_sscp_stats.sidh Session ID high byte. lu_sscp_stats.sidl Session ID low byte. lu_sscp_stats.
NOF Indications LOCAL_LU_INDICATION and is used only by dependent LUs. This parameter is set to all zeros for independent LUs or if the lu_sscp_sess_active parameter is not set to AP_YES.
NOF Indications LOCAL_TOPOLOGY_INDICATION LOCAL_TOPOLOGY_INDICATION This indication is generated when a transmission group (TG) entry in a node's local topology database is activated or deactivated.
NOF Indications LOCAL_TOPOLOGY_INDICATION No previous local topology indications were lost. status Specifies the status of the TG. This can be AP_NONE or one or more of the following values (combined using a logical OR): AP_TG_OPERATIVE AP_TG_CP_CP_SESSIONS AP_TG_QUIESCING dest Fully qualified destination node name for the TG. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF Indications LS_INDICATION LS_INDICATION This indication is generated when a link station is activated or deactivated. When the link station is deactivated, the returned data includes statistics on the link station's usage.
NOF Indications LS_INDICATION AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 } LS_STATS; /* frames received /* number of control /* frames sent reserved reserved reserved reserved reserved successful XID on LS count unsuccessful XID on LS count out_session_control_frames; echo_rsps; current_delay; max_delay; min_delay; max_delay_time; good_xids; bad_xids; /* /* /* /* /* /* /* */ */ */ */ */ */ */ */ */ */ Parameters opcode AP_LS_INDICATION primary_rc AP_OK data_lost
NOF Indications LS_INDICATION AP_NO The LS has been activated. ls_name Name of the link station. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. description A null-terminated text string describing the LS, as specified in the definition of the LS. adj_cp_name Fully qualified CP name of the adjacent node. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF Indications LS_INDICATION AP_ACTIVATING The LS has been activated. AP_DEACTIVATING The LS has been deactivated. AP_SESS_COUNT_CHANGING The number of active sessions using the LS has changed. AP_CP_NAME_CHANGING The adjacent node's CP name has changed. AP_DATA_LOST A previous indication could not be sent. AP_FAILED The LS has failed. AP_ACTIVATION_STARTED The LS supports auto-activation, and has been started automatically when required for a session.
NOF Indications LS_INDICATION Total number of XID (Exchange Identification) frames received on this link station. ls_stats.in_msg_frames Total number of data frames received on this link station. ls_stats.out_xid_bytes Total number of XID (Exchange Identification) bytes sent on this link station. ls_stats.out_msg_bytes Total number of data bytes sent on this link station. ls_stats.out_xid_frames Total number of XID (Exchange Identification) frames sent on this link station. ls_stats.
NOF Indications LS_INDICATION Transmission group number associated with the LS. sense_data If the LS has failed because of an XID protocol error, this parameter contains the sense data associated with the error. If indication_cause is set to any value other than AP_FAILED, this parameter is reserved.
NOF Indications LU_0_TO_3_INDICATION LU_0_TO_3_INDICATION This indication is generated when the session status of a type 0-3 LU changes.
NOF Indications LU_0_TO_3_INDICATION AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; reserve; /* /* /* /* /* /* /* /* number of data frames received */ num fmd data frames received */ number of data bytes received */ session ID high byte (from LFSID)*/ session ID low byte (from LFSID) */ ODAI bit set */ Link station name */ reserved */ Parameters opcode
NOF Indications LU_0_TO_3_INDICATION This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. description A null-terminated text string describing the LU, as specified in the definition of the LU. nau_address Network accessible unit address of the LU. lu_sscp_sess_active Specifies whether the SSCP session is active-that is, whether the ACTLU has been successfully processed. Possible values are: AP_YES The session is active.
NOF Indications LU_0_TO_3_INDICATION LU host attachment type. Possible values are: AP_DIRECT_ATTACHED LU is directly attached to the host system. AP_DLUR_ATTACHED LU is attached to the host system using DLUR A session_stats structure is included for each of the two sessions (LU-SSCP session and PLU-SLU session). If the session goes from active to inactive, the structure contains the following parameters; otherwise these parameters are reserved. rcv_ru_size Maximum receive RU size.
NOF Indications LU_0_TO_3_INDICATION cur_rcv_pac_win Current size of the receive pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) send_data_frames Number of normal flow data frames sent. send_fmd_data_frames Number of normal flow FMD data frames sent. send_data_bytes Number of normal flow data bytes sent. rcv_data_frames Number of normal flow data frames received. rcv_fmd_data_frames Number of normal flow FMD data frames received.
NOF Indications MODE_INDICATION MODE_INDICATION This indication is sent when a local LU and partner LU start to communicate using a particular mode, or when the active session count for the LU-LU-mode combination changes.
NOF Indications MODE_INDICATION the data_lost parameter on the next indication after the condition has cleared. Possible values are: AP_YES One or more previous mode indications were lost. AP_NO No previous mode indications were lost. removed This parameter is currently not used; a mode indication is generated only when the LUs start to use the mode, and not when they stop using it. lu_alias Locally defined LU alias.
NOF Indications MODE_INDICATION The number of sessions currently active for this LU-LU-mode combination.
NOF Indications NOF_STATUS_INDICATION NOF_STATUS_INDICATION This indication is generated when the application can no longer access its connected target (because the SNAplus2 software on the target computer has been stopped, or because the communications path to the target computer has failed). If the target is the domain configuration file, it is also generated if another server takes over as master (and therefore the connected target file is no longer the master copy of the file).
NOF Indications NOF_STATUS_INDICATION AP_NOF_STATUS_INDICATION primary_rc AP_OK status Specifies the status change being reported. Possible values are: AP_LOCAL_ABENDED The SNAplus2 software on the local computer has stopped. The application should not attempt to issue any more NOF verbs until the software has been restarted. AP_TARGET_ABENDED The SNAplus2 software on the target computer has stopped or the communications path to it has failed.
NOF Indications PLU_INDICATION PLU_INDICATION This indication is generated when a local LU begins to communicate with a partner LU. This occurs either when the first ALLOCATE to this PLU is processed or when the first BIND is received from this PLU. The indication is also generated if the partner LU's CP name changes.
NOF Indications PLU_INDICATION been lost. If SNAplus2 detects a condition that prevents it from sending an indication (for example an internal resource shortage), it indicates this by setting the data_lost parameter on the next indication after the condition has cleared. Possible values are: AP_YES One or more previous PLU indications were lost. Later fields in this VCB may be set to zeros. AP_NO No previous PLU indications were lost.
NOF Indications PLU_INDICATION associated with the partner LU. This parameter is not used if partner_lu_located below is set to AP_NO. The name is a 17-byte EBCDIC string, padded on the right 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. partner_lu_located Specifies whether the local node has located the CP where the partner LU is located.
NOF Indications PORT_INDICATION PORT_INDICATION This indication is generated when a port is activated or deactivated.
NOF Indications PORT_INDICATION AP_NO No previous port indications were lost. deactivated Specifies whether the port has been deactivated or activated. Possible values are: AP_YES The port has been deactivated. AP_NO The port has been activated. port_name Name of port. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. description A null-terminated text string describing the port, as specified in the definition of the port.
NOF Indications PU_INDICATION PU_INDICATION This indication is generated when the PU-SSCP session status of a local PU changes.
NOF Indications PU_INDICATION unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; /* /* /* /* /* sidl; odai; ls_name[8]; reserve; (from LFSID) */ session ID low byte (from LFSID)*/ ODAI bit set */ Link station name */ reserved */ Parameters opcode AP_PU_INDICATION primary_rc AP_OK data_lost Specifies whether any previous PU indications have been lost.
NOF Indications PU_INDICATION Specifies whether the PU-SSCP session is active (whether the ACTPU has been successfully processed). Possible values are: AP_YES The PU-SSCP session is active. AP_NO The PU-SSCP session is inactive. host_attachment Local PU host attachment type. Possible values are: AP_DIRECT_ATTACHED PU is directly attached to the host system. AP_DLUR_ATTACHED PU is supported by DLUR.
NOF Indications PU_INDICATION Reserved (always set to zero). pu_sscp_stats.cur_rcv_pac_win Reserved (always set to zero). pu_sscp_stats.send_data_frames Number of normal flow data frames sent. pu_sscp_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. pu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. pu_sscp_stats.rcv_data_frames Number of normal flow data frames received. pu_sscp_stats.rcv_fmd_data_frames Number of normal flow FMD data frames received.
NOF Indications REGISTRATION_FAILURE REGISTRATION_FAILURE REGISTRATION_FAILURE indicates that an attempt to register resources with the network node server failed.
NOF Indications REGISTRATION_FAILURE AP_NO No previous registration failure indications were lost. resource_name Name of resource that failed to register. 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. resource_type Resource type of resource that failed to register. One of the following. AP_NNCP_RESOURCE Network node.
NOF Indications SERVER_INDICATION SERVER_INDICATION This indication is generated when the SNAplus2 software is started or stopped on another computer on the LAN or when a server's role as master or backup server changes. A NOF application can use these indications to keep track of which servers are currently active or to determine when a new server has successfully taken over as master.
NOF Indications SERVER_INDICATION internal resource shortage), it indicates this by setting the data_lost parameter on the next indication after the condition has cleared. Possible values are: AP_YES One or more previous server indications were lost. Later fields in this VCB may be set to zeros. AP_NO No previous server indications were lost. status Specifies the status of the SNA software on the indicated server. Possible values are: AP_ACTIVE The SNA software has been started.
NOF Indications SESSION_INDICATION SESSION_INDICATION This indication is generated when a session is activated or deactivated. When a session is deactivated, the verb returns statistics on the usage of the session.
NOF Indications SESSION_INDICATION AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 rcv_ru_size; send_ru_size; max_send_btu_size; max_rcv_btu_size; max_send_pac_win; cur_send_pac_win; max_rcv_pac_win; AP_UINT16 cur_rcv_pac_win; AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char send_data_frames; send_fmd_data_frames; send_data_bytes; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; unsigned char unsigned char unsigned char unsigned char } SESSION_
NOF Indications SESSION_INDICATION AP_NO No previous session indications were lost. deactivated Specifies whether the session has been deactivated or activated. Possible values are: AP_YES The session has been deactivated. AP_NO The session has been activated. lu_name LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. lu_alias LU alias of the local LU, as defined to SNAplus2.
NOF Indications SESSION_INDICATION name is shorter than 8 bytes. session_id 8-byte identifier of the session. fqpcid.pcid Procedure Correlator ID. This is an 8-byte hexadecimal string. fqpcid.fqcp_name Fully qualified CP name. The name is a 17-byte EBCDIC string, padded on the right 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.
NOF Indications SESSION_INDICATION sess_stats.max_send_btu_size Maximum BTU size that can be sent. sess_stats.max_rcv_btu_size Maximum BTU size that can be received. sess_stats.max_send_pac_win Maximum size of the send pacing window on this session. sess_stats.cur_send_pac_win Current size of the send pacing window on this session. sess_stats.max_rcv_pac_win Maximum size of the receive pacing window on this session. sess_stats.cur_rcv_pac_win Current size of the receive pacing window on this session.
NOF Indications SESSION_INDICATION sess_stats.sidl Session ID low byte. sess_stats.odai Origin Destination Assignor Indicator. When bringing up a session, the sender of the BIND sets this field to zero if the local node contains the primary link station, and sets it to one if the BIND sender is the node containing the secondary link station. sess_stats.ls_name Link station name associated with statistics. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant.
NOF Indications SNA_NET_INDICATION SNA_NET_INDICATION This indication is generated when another NOF application or a SNAplus2 administration tool makes a change to the SNA network file sna.net. The target for this verb, identified by the target_handle parameter on the REGISTER_INDICATION_SINK verb that registers to receive this indication, must be the sna.net file. VCB Structure No specific VCB structure is associated with this indication.
NOF Indications SNA_NET_INDICATION 1158 Chapter 6
A Common Return Codes Appendix A 1159
Common Return Codes Overview Overview This appendix describes the primary and secondary return codes that are common to all NOF verbs. Return codes that are specific to a particular verb, or a group of verbs, are described in the individual verb descriptions in Chapter 6, “NOF Indications.” To translate the hexadecimal return codes (for example, 0x58100000) that a program returns into the names provided in this guide (for example, AP_INVALID_SYM_DEST_NAME), refer to the header file values_c.
Common Return Codes Communications Subsystem Not Active Communications Subsystem Not Active If the verb does not execute because a required component is not active, SNAplus2 returns the following parameters: primary_rc AP_COMM_SUBSYSTEM_ABENDED secondary_rc One of the following: AP_LOCAL_ABENDED The SNAplus2 software has stopped. AP_TARGET_ABENDED The target node has stopped or the communication path to it has failed. primary_rc AP_COMM_SUBSYSTEM_NOT_LOADED The SNAplus2 software is not active.
Common Return Codes Indication Indication This return code does not signify an error. If the application has registered using REGISTER_INDICATION_SINK to receive configuration indications or SNA network file indications, SNAplus2 sends an indication each time another NOF API application or a SNAplus2 component modifies the target file or the target node's configuration. The format of this indication is the same as the returned VCB for the NOF verb that modified the configuration.
Common Return Codes Invalid Function Invalid Function If the verb does not execute because the node does not recognize it as a valid verb, SNAplus2 returns the following parameters: primary_rc AP_INVALID_VERB The opcode parameter was not set to the operation code of any NOF verb or the verb identified by this parameter cannot be used because this version of SNAplus2 does not support it. secondary_rc Not used.
Common Return Codes Parameter Check Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc One of the following: AP_INVALID_FORMAT The reserved parameter format was not set to zero. AP_INVALID_TARGET_HANDLE The supplied target handle is not valid. AP_INVALID_TARGET The verb cannot be issued to the specified target.
Common Return Codes State Check State Check If the verb does not execute because of a state check, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc One of the following: AP_CANT_MODIFY_VISIBILITY You have attempted to define a resource with a name that is reserved for use internally by SNAplus2. Please choose a different name.
Common Return Codes State Check The target file is a copy of the domain configuration file, or of the sna.net file, on a server that is not the master server. Verbs that modify these files must be issued to the master server's copy of the files. AP_SYNC_PENDING This verb was issued using the synchronous NOF API entry point, but another synchronous verb was in progress. Only one synchronous verb can be in progress at any time.
Common Return Codes System Error System Error If the verb does not execute because of an operating system error, SNAplus2 returns the following parameters: primary_rc AP_UNEXPECTED_SYSTEM_ERROR An operating system call failed during processing of the verb. secondary_rc The secondary return code in this case is the return code from the operating system call. For the meaning of this return code, check the returned value in the file errno.h on the computer where the error occurred.
Common Return Codes System Error 1168 Appendix A
Index Numerics 3270 emulation program diagnostics parameters, 160 user, 227, 493, 500, 672 3270 LU for TN server, 61 A access list, conversation security, 366 ACTIVATE_SESSION, 117 activating a session, 117 ADD_BACKUP, 122 ADD_DLC_TRACE, 124 APING, 129 application scheduled mode, 99 APPN node, 56 asynchronous entry point, 91 callback routine, 97 overview, 94 audit log file, 708, 1025 B back-level support tracing, 518, 1009 backup server, 64, 919 adding, 122 deleting, 399 C callback routine, 95, 97 requireme
Index DELETE_ADJACENT_LEN_NODE, 396 DELETE_BACKUP, 399 DELETE_CN, 401 DELETE_COS, 403 DELETE_CPIC_SIDE_INFO, 405 DELETE_DIRECTORY_ENTRY, 407 DELETE_DLC, 409 DELETE_DOWNSTREAM_LU, 411 DELETE_DOWNSTREAM_LU_RANGE, 413 DELETE_DSPU_TEMPLATE, 416 DELETE_EMULATOR_USER, 419 DELETE_FOCAL_POINT, 422 DELETE_INTERNAL_PU, 425 DELETE_LOCAL_LU, 427 DELETE_LS, 429 DELETE_LU_0_TO_3, 434 DELETE_LU_0_TO_3_RANGE, 436 DELETE_LU_LU_PASSWORD, 439 DELETE_LU_POOL, 441 DELETE_LU62_TIMEOUT, 431 DELETE_MODE, 443 DELETE_PARTNER_LU, 44
Index list options for QUERY_* verbs, 112 local LU defining, 247 querying, 696 sessions, 906 LOCAL_LU_INDICATION, 1114 LOCAL_TOPOLOGY_INDICATION, 1120 log file, 708, 1025 log message type, 689, 711, 1019, 1030 log messages, central logging, 524, 526, 1013 LS defining, 255 querying, 715 starting, 1056 statistics, 925 stopping, 1069 LS_INDICATION, 1122 LU pool defining, 310 for TN server users, 62 querying, 770 LU type 0 - 3, 296, 301 LU type 6.
Index PORT_INDICATION, 1141 prerequisite knowledge, 42 processing mode, 107, 1034 PU, 878 PU concentration, 59 PU concentration support, 111 PU_INDICATION, 1143 Q QUERY_* verbs detailed information, 114 list options, 112 returning information about multiple resources, 112 summary information, 114 QUERY_3270_DIAG, 488 QUERY_3270_USER, 493 QUERY_3270_USER_SESSIONS, 500 QUERY_ACTIVE_TRANSACTION, 506 QUERY_AVAILABLE_TP, 513 QUERY_BCK_CS_TRACE, 518 QUERY_BUFFER_AVAILABILITY, 520 QUERY_CENTRAL_LOGGER, 524 QUERY_C
Index SERVER_INDICATION, 1149 session limits initializing, 474 resetting, 1001 SESSION_INDICATION, 1151 SET_BCK_CS_TRACE, 1009 SET_BUFFER_AVAILABILITY, 1012 SET_CENTRAL_LOGGING, 1013 SET_CS_TRACE, 1015 SET_GLOBAL_LOG_TYPE, 1019 SET_KERNEL_MEMORY_LIMIT, 1023 SET_LOG_FILE, 1025 SET_LOG_TYPE, 1030 SET_PROCESSING_MODE, 107, 1034 SET_TN_SERVER_TRACE, 1038 SET_TRACE_FILE, 1040 SET_TRACE_TYPE, 1044 side information, CPI-C, 185, 568 signal-based scheduling mode, 100 signals (HP-UX), 101 sigpoll signal, 101 single-t
