HP-UX SNAplus2 NOF Programmers Guide HP-UX 11i Manufacturing Part Number: J2744-90022 E0603 United States © Copyright 2003 © Hewlett-Packard Company, 2003. 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.
Trademark Notices ActivePerl is a registered trademark of ActiveState Tool Corporation Apple and Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. AppleShare is a registered trademark of Apple Computer, Inc. CHAMELEON is a trademark of NetManage, Inc. DIGITAL and PATHWORKS are trademarks of Digital Equipment Corporation. DiskAccess is a registered trademark of Intergraph. EXCURSION is a trademark of Digital Equipment Corporation.
SunForum is a registered trademark of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark in the United States and other countries, licensed exclusively through The Open Group. VERITAS is a registered trademark of VERITAS Software Corporation. VERITAS File System is a trademark of VERITAS Software Corporation. WinDD is a trademark of Tektronix, Inc. X Window System is a trademark of the Massachusetts Institute of Technology.
Contents Preface 1. Introduction to the NOF API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purpose of the NOF API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Node Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Domain Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Managing Configuration File Header Information . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing HP-UX Resource Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NOF Indications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration Indications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SNA Network File Indications . . . . . . . . .
Contents Linking Motif Applications and Applications That Use Application Scheduled Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Linking Multithreaded Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Target For NOF Verbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents APING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents DEACTIVATE_LU_0_TO_3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_CPIC_SIDE_INFO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Function Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Partner LUs . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bit Ordering in MAC Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_LU62_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_SECURITY_ACCESS_LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEFINE_USERID_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_DIRECTORY_ENTRY . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_EMULATOR_USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_LU62_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_PARTNER_LU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE_TN3270_ASSOCIATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . .
Contents Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_COS_TG_ROW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_DIRECTORY_LU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Function Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_DLUR_PU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . .
Contents QUERY_DSPU_TEMPLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . .
Contents QUERY_LOG_FILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . .
Contents QUERY_NMVT_APPLICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_PU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QUERY_SNA_NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents QUERY_TN3270_DEFAULTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978 VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978 Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978 Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007 1008 1009 1010 5.
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET_CENTRAL_LOGGING . . . . . . . . . . . . . . . . . . . . . .
Contents Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET_PROCESSING_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Successful Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . .
Contents Returned Parameters: Parameter Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: State Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Function Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters: Other Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . STOP_LS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DIRECTORY_INDICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DLC_INDICATION . . . . . . .
Contents Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MODE_INDICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 38
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.2 of SNAplus2.
Prerequisite Knowledge Before reading this manual, you should have a knowledge of the following subjects: 40 • SNA and APPN concepts (see “Related Publications”) • The C compiler cc • HP-UX version 11i or later
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 42 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 (Continued) Special Element Sample of Typography Function, call, or entry point ioctl Data structure NOF_CALLBACK Hexadecimal value 0x20 43
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.
Contains the information you need to write application programs using Common Programming Interface for 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.
48
1 Chapter 1 Introduction to the NOF API 49
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 you can use it again when you need to restart the system, but it is not necessary to define the entire domain configuration before starting the 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.
Introduction to the NOF API SNAplus2 Resources 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. DLUR on the SNAplus2 node works in conjunction with Dependent LU Server (DLUS) at the host to route sessions from dependent LUs on the SNAplus2 node across the network to the DLUS 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 include the SNAplus2 computer and its host communications link; the LUs at the downstream computers are configured as part of the resources of the SNAplus2 computer. The host computer is not aware that PU concentration is being used. TN Server SNAplus2 TN server provides access to 3270 host computers for TN3270 users on other computers.
Introduction to the NOF API SNAplus2 Resources The SNAplus2 TN server feature provides an association between a TN3270 user and SNAplus2 3270 LU. All data from the TN3270 user is routed to the LU. This means that the configuration for both the host and the TN3270 user is as though they were connected directly; neither needs to be aware that data is being routed through TN server.
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 configuration file is copied to backup servers (either when they are started or when the master copy is changed) so that all backup servers 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.
Introduction to the NOF API Client-Server Operation SNAplus2 stores information about the master server and backup servers in the file sna.net, known as the SNA network data file. The master copy of this file is stored on the master server; any changes made 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.
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
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
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 • A DLC, port, and LS from SNAplus2 to the downstream computer. For information about defining these components, see “Getting Started”.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • QUERY_PU 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 To delete TN3270 users so that they can no longer use TN server for 3270 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 Managing Access to the SNAplus2 System from the Host NetView Program If you want to enable operators at the host NetView console to issue commands on the SNAplus2 computer using either the Service Point Command Facility (SPCF) or the HP-UX Command Facility (UCF), you need to define the access permissions for these operators.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions The verbs to manage central logging and global logging options apply to Windows clients as well as to HP-UX computers. However, other diagnostics settings on Windows clients are controlled by options in the Windows client initialization file, sna.ini and not by NOF verbs. For more information, refer to the HP-UX SNAplus2 Administration Guide.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • SET_TRACE_TYPE If you want to activate tracing to diagnose problems with communications between clients and servers across the SNAplus2 LAN or to deactivate it after collecting the required data, use the following verb: • SET_CS_TRACE If you want to activate tracing to diagnose problems with communications between current-level and back-level computers (in a client-server system where you are in the process of migrating to a n
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions The verbs relating to client-server tracing can be issued on HP-UX client computers as well as on a server. For more information,see “SET_CS_TRACE”, “QUERY_CS_TRACE”, “SET_TRACE_FILE”, and “QUERY_TRACE_FILE”. Managing Directory Entries If the local node is a LEN node, you need to set up entries in the local node's directory to identify the adjacent nodes that SNAplus2 will communicate with and the LUs associated with these nodes.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions However, you may want to set up entries for particular nodes or LUs so that the local node can communicate with these resources without having to search for them. Because setting up entries for particular nodes or LUs overrides the normal APPN resource location process, you can have problems at this node or at other nodes in the network if the definitions are not correct.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To obtain detailed information about a particular node, use the following verb: • QUERY_NODE To find out which servers are acting as the master configuration file server and backup master servers, use the following verb: • QUERY_SNA_NET To add new backup master servers to the list or to remove existing servers from the list so that they can no longer act as master servers, use the following verbs: • ADD_BACKUP, DELETE_BACKUP M
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 86 Chapter 1
2 Chapter 2 Writing NOF Applications 87
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: 88 • 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 Ch
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 • nofvcb For all other NOF verbs, the application supplies the value that was returned on the CONNECT_NODE or OPEN_FILE verb. 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 processing at a later time. In some cases, verb processing is complete 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 — CONNECT_NODE (to access a running node, or to access the node on a server where the SNAplus2 software is started but the node is not 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 r
Writing NOF Applications Description of the NOF API Entry Points The verb has already completed. The application can examine the parameters in the VCB to determine whether the verb completed successfully. SNAplus2 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.
Writing NOF Applications Description of the NOF API Entry Points The Callback Routine Specified on the nof_async Entry Point 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 indications. (The REGISTER_INDICATION_SINK verb is also issued as an asynchronous verb that specifies a callback routine; the callback is called each time the indication is received.
Writing NOF Applications Description of the NOF API Entry Points • corr For completion of verbs, a pointer to the VCB supplied by the application. The VCB now includes the returned parameters set by SNAplus2. The correlator value supplied by the application. This value enables the application to correlate the returned information with its other processing. The callback routine need not use all of these parameters (except as described in “Using the Callback Routine for Indications”).
Writing NOF Applications Description of the NOF API Entry Points In particular, if the application that issued CONNECT_NODE later forks to create a child process, the child process cannot issue any NOF verbs that use the target handle obtained by the parent process. However, the child process can issue another CONNECT_NODE to obtain its own target handle.
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 Asynchronous verbs are implemented by making callbacks to the 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 Add the following lines to your code before the first call into any SNA library: #include int app_context; ... XtAppInitialize(app_context...) ... SNA_USE_XT_SCHED(app_context); The SNA_USE_XT_SCHED call has no return values. It calls the XtAppAddInput function to register the SNA work sources.
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 • For HP-UX 10.20 (only DCE threads are supported), link with the 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 This is the default mode when the target handle is first assigned; it enables the application to check the configuration or status of a resource but not to change 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 the index value to the name of the last entry received; this second verb then returns the 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.
Writing NOF Applications List Options For QUERY_* Verbs 114 Chapter 2
3 Chapter 3 NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) 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 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). plu_alias LU alias of the partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION 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 session_id The 8-byte identifier of the activated 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) ACTIVATE_SESSION Returned Parameters: Activation Failure If the verb does not execute because of other errors, SNAplus2 returns one of the following parameters. primary_rc Possible values are: AP_ACTIVATION_FAIL_NO_RETRY The session could not be activated because of a condition that requires action (such as a configuration mismatch or a session protocol error).
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 } DLC_TRACE_FILTER; 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_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_XID XID messages 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:
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 unsigned char unsigned char AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 PARTNER_VER_DATA } APING; 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; /* /* /* /* /* /* /* /* fully qualified partner LU name */ data echo flag */ number of iterations */ time taken for ALLOCATE */ minimum send/receive ti
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 pwd Password required to access the partner TP; this parameter is required only if the security parameter is set to AP_PGM. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces if the password is shorter than 10 bytes. user_id User ID required to access the partner TP; this parameter is required only if the security parameter is set to AP_SAME or AP_PGM.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING Specifies whether the APING TP requests data from the partner LU after sending data to it. Possible values 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING The time in milliseconds to allocate a conversation to the partner (the time taken for the MC_ALLOCATE verb issued by the APING TP to complete). min_time 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING 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. 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 AP_ALLOCATION_FAILURE_RETRY The conversation could not be allocated because of a temporary condition, such as a link failure. Check the error log file for more information. Retry the APING verb, preferably after a timeout to allow the condition to clear. AP_SECURITY_NOT_VALID 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) APING sense_data If the secondary_rc parameter is AP_ALLOCATION_FAILURE_NO_RETRY, this parameter contains the SNA sense data associated with the error. For all other secondary_rc values, this parameter is reserved.
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 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 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. 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.
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 primary_rc AP_PARAMETER_CHECK 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT 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_MODE_RESET No sessions are currently active for this LU-LU-mode combination.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CHANGE_SESSION_LIMIT Returned Parameters: CNOS Processing Errors If the verb does not execute because of an error, SNAplus2 returns the following parameters. primary_rc AP_CONV_FAILURE_NO_RETRY The session limits could not be changed because of a 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.
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 To connect to the node currently acting as the central logger, set this parameter to AP_CENTRAL_LOGGER. This value is required if the application will be issuing the following verbs: node_name • 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) Name of the SNAplus2 node to connect to.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) CONNECT_NODE AP_NDE_STARTED The node is active. 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 application is running and the computer where the target node is defined. If you are in the process of upgrading the network, so that different computers are running different levels of the SNAplus2 software, nodes running on the back-level software can be managed only by applications running on the back-level software.
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 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. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_CONV_GROUP The conv_group_id parameter did not match any valid conversation group ID. AP_INVALID_CLEANUP_TYPE 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.
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 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. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_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. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEACTIVATE_SESSION 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_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 unsigned char unsigned char unsigned char unsigned char } ALERT_3270_DATA; description[53]; parameter1[33]; parameter2[33]; parameter3[33]; /* /* /* /* 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 SNAplus2, your application must use this field to determine the exact length
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG 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. The response time is defined as the interval between the user pressing ENTER or an AID key to send data to the host, and one of the following events: AP_RTM_SCREEN The first data from the host reaches the user's screen.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_3270_DIAG order (rtm_thresh2 must be higher than rtm_thresh1, rtm_thresh3 must be higher than rtm_thresh2, and so on). 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 specify a null string for any parameters that are not required. The user will only be prompted for a parameter if you specify a description for it.
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 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 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 “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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_ADJACENT_LEN_NODE The wildcard_lus parameter was set to AP_YES, but one or more of the specified LU names was already defined on a different parent 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.
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 } TG_DEFINED_CHARS; security; prop_delay; modem_class; user_def_parm_1; user_def_parm_2; user_def_parm_3; /* /* /* /* /* /* security propagation delay reserved user-defined parameter 1 user-defined parameter 2 user-defined parameter 3 */ */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_CN fqcn_name Fully quali
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN 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. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN AP_SEC_GUARDED_RADIATION Data is transmitted over a line that is protected against physical and radiation tapping. 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).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN port_name Array of up to eight port names defined on the connection network. Each port name is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes, and must already have been defined by a DEFINE_PORT verb. Additional ports may be defined on the Connection Network by issuing another DEFINE_CN specifying the new port names.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CN AP_INVALID_PORT_NAME One or more of the port names specified did not match the name of a defined port. AP_INVALID_PORT_TYPE One or more of the specified ports cannot be on a CN because its DLC type is a point-to-point type (such as SDLC) rather than a network type. 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_CN 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_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 } 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; typedef struct cos_node_row { COS_NODE_STATUS minimum; COS_NODE_STATUS maximum; unsigned char unsigned char } COS_NODE_ROW; weight; reserv1; typedef struct cos_node_status { unsigned c
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS 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. num_of_tg_rows Number of TG rows which follow the DEFINE_COS VCB. The maximum is 8. Each TG row contains a set of minimum TG characteristics, a set of maximum TG characteristics, and a weight.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS 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. 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 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 Maximum 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.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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS Maximum limits for 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_COS and maximum characteristics defined for each node row. The node is then assigned the weight of the first node row which bounds all the node's characteristics within the limits specified. If the node characteristics do not satisfy any of the listed node rows, the node is considered unsuitable for this COS, and is assigned an infinite weight. The node rows must be listed in ascending order of weight. cos_node_row.minimum.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS The number of ISR sessions exceeds the threshold value. cos_node_row.weight Weight associated with this node row.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_COS 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_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 unsigned char AP_UINT32 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]; /* /* /* /* /* /* /* TP name Mode name Conversation security type User ID Password LU alias */ */ */ */ */ */ */ } CPIC_SIDE_INFO; Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_CPIC_SIDE_INFO sym_des
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO 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.tp_name TP name of the target TP. This is a 64-byte ASCII character string, padded on the right with ASCII spaces.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO 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 (ACTIVATE_SESSION to OPEN_FILE) DEFINE_CPIC_SIDE_INFO 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_SYM_DEST_NAME The sym_dest_name parameter contained a character that was not valid.
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 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 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 Specifies the timeout after which free limited-resource conwinner sessions are deactivated. Specify a value in the range 0-65,535 seconds.
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 unsigned char reserv4[8]; } DEFINE_DIRECTORY_ENTRY; /* 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 primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: 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 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_DATA; /* streams config info */ DLC-specific data for Token Ring, Ethernet, FDDI: typede
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC 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. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_DLC verb, but SNAplus2 does not make any other use of it.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC 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.dlc_spec_data_len Length, in bytes, of data specific to the type of the DLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DLC 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 vdl_dlc_cfg.mux_info.dlc_type 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 primary_rc AP_PARAMETER_CHECK 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 A null-terminated text string (0-31 characters followed 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 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_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 information only; SNAplus2 returns it on the QUERY_DOMAIN_CONFIG_FILE verb, but does not make any other use of it. 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_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 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 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 dslu_name parameter contained a character that was not valid. AP_INVALID_NAU_ADDRESS 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU An LU with the specified name has already been defined, and cannot be modified using this verb. AP_LU_NAU_ADDR_ALREADY_DEFD An LU with the specified NAU address has already been defined. AP_INVALID_HOST_LU_NAME The specified host LU name was not valid. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU Returned Parameters: Function Not Supported If the verb does not execute successfully because the local node's configuration does not support it, SNAplus2 returns the following parameters: primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support PU concentration; this is defined by the pu_conc_supported parameter on the DEFINE_NODE verb.
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 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 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 The supplied dslu_base_name parameter contained a 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_DOWNSTREAM_LU_RANGE An LU has already been defined with a name that matches one of the names in the range. The existing LU cannot be modified using this verb. AP_LU_NAU_ADDR_ALREADY_DEFD 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.
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 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 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 The value specified for the delayed_logon parameter was not valid. AP_INVALID_MODIFY_TEMPLATE The value specified for the modify_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. 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_DSPU_TEMPLATE 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_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 user_is_group; unsigned char status; unsigned char reserv2; } EMULATOR_USER_DEF_DATA; /* 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 unsigned char reserv1; /* reserved unsigned char description[32]; /* Session descripti
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER 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 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). 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER 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. AP_NO The user cannot view RTM data; the LTTI is not displayed. def_data.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER def_data.change_style 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 The user is restricted to the default style file specified by the style_file parameter, and cannot create or modify style files. def_data.user_is_group Specifies whether the user_name parameter identifies a user name or a group name. Possible values are: AP_YES The user_name parameter identifies a group name. Any user in this group will use this emulator user record unless there is an explicit record for the user's user name.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER 3270 sessions that are available for the user to remap to must be given names that are not in the range above. The user will be able to access these sessions only if the change_lu parameter (see above) allows the user to remap sessions. session_def_data.emulator_type Type of the emulation program that uses this session.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER AP_3270_DISPLAY_MODEL_3 Display model 3 (80 x 32) AP_3270_DISPLAY_MODEL_4 Display model 4 (80 x 43) AP_3270_DISPLAY_MODEL_5 Display model 5 (132 x 27) AP_PRINTER Printer LU. (This value is not valid if lu_name specifies an LU pool.) session_def_data.session_variant.def_data_3270.model_overri de Specifies whether the user has permission to change the session to use a different screen model from the one specified.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_EMULATOR_USER alias of an APPC partner LU that has already been defined. For more information, see “Defining Partner LUs”. To indicate that the partner LU is identified by its fully qualified name instead of its LU alias, set this parameter to 8 binary zeros, and specify the fully qualified name in the fqplu_name parameter. session_def_data.session_variant.def_data_5250.fqplu_name Fully qualified name of the partner LU that this session uses.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_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 AP_INVALID_SESSION_TYPE The emulator_type or session_type parameter for one or more sessions was not set to a valid value.
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 Another DEFINE_FOCAL_POINT was issued to the same node while this verb was outstanding, specifying a different focal point for the same MS category. This verb was abandoned; the node will attempt to contact the focal point specified by the second verb.
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 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. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_INTERNAL_PU primary_rc AP_PARAMETER_CHECK 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_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 (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 unsigned char } ROUTING_DATA; back_level; reserved[59]; /* 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. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU 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. Set this to AP_YES only if you have a Sync Point Manager (SPM) and Conversation Protected Resource Manager (C-PRM) in addition to the standard SNAplus2 product. Possible values are: AP_YES Syncpoint is supported.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU 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 AP_NO 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 The lu_name or lu_alias parameter contained a character that was not valid. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LOCAL_LU attempts to start a conversation without specifying a local LU name, SNAplus2 will select an unused LU from the pool of LUs defined as default LUs. Chapter 3 • You can define LUs on more than one node as default LUs. An application requesting a default LU may be assigned to any of these LUs as available; there is no requirement for the LU to be on the same computer as the application.
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 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_default_tg_chars; TG_DEFINED_CHARS tg_chars; AP_UINT16 target_paci
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS DLC-specific data for SDLC: typedef struct sdl_link_spec_data { V0_MUX_INFO mux_info; AP_UINT16 reserve8; AP_UINT16 reserve9; AP_UINT32 contact_timer; AP_UINT16 AP_UINT16 AP_UINT32 contact_timer_retry; reserve1; contact_timer2; AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT16 AP_UINT32 contact_timer_retry2; reserve2; disc_timer; disc_timer_retry; reserve3; nve_poll_timer; nve_poll_timer_re
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_UINT32 AP_UINT16 linesp; rcv_pool_size; AP_UINT16 poll_wait; AP_UINT16 unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 unsigned char unsigned char } STUB_SPEC_DATA; hmod_data_len; hmod_data[64]; x21_sequence[255]; x21_retry_count; x21_retry_delay; v25_tx_delay; cdstl; reserve1[3]; /* /* /* /* /* /* /* /* /* /* /* /* /* line speed in bps initial number of buffers for rcv pool seconds between polling HMOD for errors length of dial
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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_LS_SPEC_DATA; /* /* /* /* /* /* reserved reserved reserved reserved reserved reserved */ */ */ */ */ */ DLC-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;
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_LS ls_name Name of link station. This is an 8-byte ASCII string, 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 LS.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Retry count for reactivating a failed LS. This parameter is used to specify whether SNAplus2 should attempt to reactivate the LS if it fails while in use (or if an attempt to start the LS fails). Specify zero to indicate that SNAplus2 should not attempt to reactivate the LS, or specify the number of retries to be made. A value of 65,535 indicates that SNAplus2 should retry indefinitely until the LS is activated.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS If adj_cp_type is set to any other value, or if preassigned TG numbers are not being used, there is no need to specify this parameter; SNAplus2 will check the CP name only if one is specified. 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. def_data.adj_cp_type Adjacent node type.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Back-level LEN node (one that does not include the Network Name CV in its XID3). AP_HOST_XID3 Host node; SNAplus2 should respond to a polling XID from the node with a format 3 XID. AP_HOST_XID0 Host node; SNAplus2 should respond to a polling XID from the node with a format 0 XID. AP_DSPU_XID Downstream PU; SNAplus2 should include XID exchange in link activation. The dspu_name and dspu_services fields must also be set.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_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 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. For all link types: def_data.auto_act_supp Specifies whether the link can be activated automatically when required by a session. Possible values are: AP_YES The link can be activated automatically.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Preassigned TG number. This parameter is used only if 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS no data has flowed on the link for the time period specified by the link_deact_timer field. A limited resource link station may be configured for 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS def_data.disable_remote_act Specifies whether to prevent activation of the LS by the 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. def_data.dspu_services Specifies the services which the local node will provide to the downstream PU across this link.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS This parameter is required when both of the following conditions are true; otherwise, it is reserved: • The solicit_sscp_sessions parameter is set to AP_NO • The dspu_services parameter is set to AP_PU_CONCENTRATION def_data.dlus_name 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS def_data.hpr_link_lvl_error This parameter is reserved. def_data.link_deact_timer Limited resource link deactivation timer, in seconds. A limited resource link is automatically deactivated if no data flows over the link for the time specified by this parameter. This parameter is not used if limited_resource is set to any value other than INACTIVITY. 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_LS This link should not be automatically activated in an attempt to contact a network node server. If the local node is not an end node, this parameter is ignored. def_data.ls_attributes This array contains further information about the adjacent node, as described in the following parameters: def_data.ls_attributes[0] Host type. Set this to AP_SNA unless you are communicating with a host of one of the other types listed below.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Node ID of adjacent node. This is a 4-byte hexadecimal string, consisting of a block number (three hexadecimal digits) and a node number (five hexadecimal digits). Set it to zeros to disable node ID checking. If this link station is defined on a switched port, the node_id must be unique, and there may only be one null node_id on each switched port. def_data.local_node_id Node ID sent in XIDs on this LS.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Use the default TG characteristics; ignore the tg_chars structure on this verb. AP_NO Use the tg_chars structure on this verb. def_data.tg_chars.effect_cap 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. def_data.tg_chars.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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. def_data.tg_chars.prop_delay Propagation delay: the time that a signal takes to travel the length of the link.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Maximum propagation delay. def_data.tg_chars.user_def_parm_1 through def_data.tg_chars.user_def_parm_3 User-defined parameters, which you can use to include other TG characteristics not covered by the above parameters. Each of these parameters must be set to a value in the range 1-255. def_data.target_pacing_count Numeric value between 1 and 32,767 inclusive indicating the desired pacing window size.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS def_data.dlus_retry_timeout Reactivation timer for contacting a DLUS. If SNAplus2 fails to contact the DLUS, this parameter specifies the time in seconds between retries. Specify a value in the range 0x0001-0xFFFF. def_data.dlus_retry_limit The interval in seconds between the second and subsequent attempts to contact the DLUS specified by the dlus_name and bkup_dlus_name parameters.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Number of times transmission and retransmission of a contact frame (such as SNRM) is allowed using the normal poll timer before SNAplus2 changes to the slow poll timer. A value of 0xFFFF indicates an unlimited retry count. A value of 0x0001 indicates that the switch to the slow poll should be made after the first timer expiry. contact_timer2 Slow poll contact timer in milliseconds.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS Timeout required before an adjacent secondary station (which has previously been removed from the polling list because it has no data to send) is reinserted into the polling list. The timer is specified in milliseconds. nve_poll_timer_retry Number of times a station is removed from the polling list on the normal poll timer before SNAplus2 switches to using the slow poll timer. A value of 0xFFFF indicates an unlimited retry count.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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. A value of 0x0001 indicates that an outage should be generated after the first timer expiry. rem_busy_timer Time allowed for an adjacent secondary station to be in an RNR condition.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS poll_on_iframe Specifies whether this link station is permitted to send the poll bit on an I-frame. This allows SNAplus2 to work with certain SDLC implementations which do not handle receipt of I-frames carrying the poll bit. Possible values are: AP_YES This link station is allowed to send the poll bit on an I-frame. AP_NO This link station is not allowed to send the poll bit on an I-frame.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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.linesp parameter is ignored.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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. Possible values are: VQL_SVC Switched Virtual Circuit VQL_PVC Permanent Virtual Circuit If you define both SVC and PVC LSs between the same local node and remote node, unpredictable results may occur if the SVC LS is started first (since it may not be possible to match the incoming call to the correct LS).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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. The actual size used is 2 to the power of rem_packet (as for loc_packet above). 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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.25 network does not support facilities negotiation, or if you do not want to use it, ensure that the X.25 provider software is configured not to allow flow control negotiation.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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 Timeout required before an XID is retransmitted when trying to contact a remote station. The timer is specified in milliseconds. Higher values may be needed 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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_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 The ls_role parameter was not set to a valid value. AP_INVALID_NODE_TYPE The adj_cp_type parameter was not set to a valid 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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. AP_HPR_NOT_SUPPORTED The hpr_supported parameter was set to AP_YES, but the node does not support HPR. AP_INVALID_TG_NUMBER The TG number supplied was not in the valid range.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS The value specified for dlus_retry_timeout was not valid. AP_INVALID_LS_ROLE The value specified for the ls_role parameter is not valid. AP_INVALID_BTU_SIZE The value specified for the max_send_btu_size parameter was not valid. AP_INVALID_MAX_IFRM_RCVD The value specified for the max_ifrm_rcvd parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS AP_INVALID_LINK_NAME The link station value specified in the ls_name parameter was not valid. AP_INVALID_NUM_LS_SPECIFIED The number of link stations specified was not valid. AP_LOCAL_CP_NAME The name specified for the adj_cp_name parameter is identical to the local CP name. AP_LS_ACTIVE The link station specified in the ls_name parameter is currently active. AP_PU_ALREADY_DEFINED The PU specified in the pu_name parameter has already been defined.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LS 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_LS Table 3-1 Table 3-2 Chapter 3 (Continued) 6→6 E→7 7→E F→F Example of Bit Ordering in a MAC Address Original address 1A 2B 3C 4D 5E 6F Swap digits A1 B2 C3 D4 E5 F6 Convert digits (the bit-reversed form of the original address) 58 D4 3C B2 7A F6 297
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 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_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.
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 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. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_LU_0_TO_3 verb, but SNAplus2 does not make any other use of it.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 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 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 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 Possible values are: AP_INVALID_PU_NAME The pu_name parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_0_TO_3 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_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 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 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 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 base_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 was not valid. AP_PU_NOT_DEFINED 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.
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 Password. This is an 8-byte hexadecimal string, which must not be set to all blanks or all zeros. It must match the equivalent parameter configured for the partner LU on the remote system (except that the least 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_LU_LU_PASSWORD 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_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 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 } MODE_CHARS; compression; reserv1; auto_act; min_conloser_src; max_ru_size_low; max_receive_pacing_win; /* /* /* /* /* /* reserved reserved initial auto-activation count min source contention loser maximum RU size lower bound maximum receive pacing window */ */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_MODE mode_name N
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE 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. SNAplus2 always uses adaptive pacing unless the adjacent node specifies that it is not supported. mode_chars.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE Default session limit for this mode. This limits the number of sessions on this mode between any one local 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).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE Number of sessions that will be activated automatically for 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.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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE 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_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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_MODE The mode_name parameter contained a character that was not valid. AP_INVALID_RECV_PACING_WINDOW The receive_pacing_win parameter was not in the valid range. AP_INVALID_SNASVCMG_MODE_LIMIT 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.
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 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_threshold; /* reserved AP_UINT16 isr_max_ru_size; /* reserved AP_UINT16 isr_rcv_pac_window; /* reserved unsigned char store_endpt_rscvs; /* endpoint RSCV storage unsigned char st
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE 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.fqcp_name Node's fully qualified CP name.
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 Use the normal REQDISCONT support. 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 Setting this flag enables SNAplus2 to continue sessions with hosts that do not follow this protocol. cp_create_parms.ptf[1] ERP support. SNAplus2 normally processes an ACTPU(ERP) as an ERP; this resets the PU-SSCP session, but does not implicitly deactivate the subservient LU-SSCP and PLU-SLU sessions. SNA implementations may legally process ACTPU(ERP) as if it were ACTPU(cold), implicitly deactivating the subservient LU-SSCP and PLU-SLU sessions.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE primary_rc AP_OK target_handle Returned value for use on subsequent verbs. 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_ISR_THRESHOLDS The ISR threshold parameters were not valid (lower threshold above upper, or upper threshold above max_isr_sessions).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_NODE 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_NODE_ALREADY_STARTED The target node is active, so you cannot use this verb to modify its configuration.
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 AP_UINT16 unsigned char unsigned char unsigned char } PLU_CHARS; max_mc_ll_send_size; conv_security_ver; parallel_sess_supp; reserv3[8]; /* /* /* /* /* maximum MC send LL size already-verified security supported? parallel sessions supported? reserved */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_PARTNER_LU plu_chars.fqplu_name Fully qualified LU name for the partner LU.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU 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. This parameter is only relevant if the partner LU is on a host and dependent LU 6.2 is used to access it. plu_chars.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU The partner LU does not support parallel sessions.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PARTNER_LU The plu_alias parameter of an existing partner LU cannot be changed. AP_PLU_ALIAS_ALREADY_USED The plu_alias parameter is already used for an existing partner LU with a different LU name. 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_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 AP_UINT16 AP_UINT16 implicit_deact_timer; /* deact timer for implicit LSs */ act_xid_exchange_limit; /* activation XID exchange limit */ nonact_xid_exchange_limit; /* non-activation XID */ /* exchange limit */ unsigned char ls_xmit_rcv_cap; /* LS transmit-receive capability */ unsigned char max_ifrm_rcvd; /* maximum number of I-frames that*/ /* can be received */ AP_UINT16 target_pacing_count; /* Target pacing count */ AP_UINT16 max_send_b
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT 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_UINT16 np_rcv_timer_retry; /* AP_UINT16 reserve2; /* AP_UINT32 write_timer; /* AP_UINT16 write_timer_retry; /* AP_UINT16 reserve3; /* AP_UINT32 link_conn_timer; /* AP_UINT16 link_conn_timer_retry; AP_UINT16 reserve4; /* AP_UINT16 pri_fdplx; /* AP_UINT16 sec_fdplx; /* AP_UINT16 use_re
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT 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_tx_threshold; repoll_threshold; rr_timer; group_address; poll_frame; AP_UINT16 poll_on_iframe; 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 cha
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT typedef struct vql_ls_spec_data { V0_MUX_INFO mux_info; /* streams config info AP_UINT16 reserve1; /* reserved AP_UINT16 reserve2; /* reserved unsigned char vc_type; /* Virtual Circuit type unsigned char req_rev_charge; /* request reverse charge if non-zero unsigned char loc_packet; /* loc->rem packet size 2**locpacket unsigned char rem_packet; /* rem->loc packet size 2**rempacket unsigned char loc_wsize; /* loc->rem window size unsigned char rem_wsi
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Data for all DLC types: typedef struct v0_mux_info { AP_UINT16 dlc_type; unsigned char need_vrfy_fixup; unsigned char num_mux_ids; AP_UINT32 card_type; AP_UINT32 adapter_number; AP_UINT32 oem_data_length; int mux_ids[5]; } V0_MUX_INFO; /* /* /* /* /* /* /* DLC implementation type reserved reserved reserved reserved reserved reserved */ */ */ */ */ */ */ For Token Ring, Ethernet, or FDDI, the address parameter in the link_address structure is repl
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Specifies whether this port is automatically started when the node is started. Possible values are: AP_YES The port is automatically started when the node is started. AP_NO The port is automatically started only if an LS that uses it is defined to be initially active; otherwise it must be started manually. def_data.dlc_name Name of associated DLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT Incoming calls are resolved by CP name. AP_RESOLVE_BY_LINK_ADDRESS This specifies that an attempt is made to resolve incoming calls by using the link address on CONNECT_IN before using the CP name (or node ID) carried on the received XID3 to resolve them. This bit is ignored unless the port_type parameter is set to AP_PORT_SWITCHED. def_data.port_number The number of the port. def_data.max_rcv_btu_size Maximum BTU size that can be received.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT For an SDLC port with port_type set to AP_NONSWITCHED, this parameter must be zero. If port_type is set to AP_SWITCHED, then the port must be defined to accept either incoming calls (inb_link_act_lim = 1 and out_link_act_lim = 0) or outgoing calls (inb_link_act_lim = 0 and out_link_act_lim = 1). def_data.out_link_act_lim Outbound link activation limit (the number of links reserved for outbound activation).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT If the template specified does not exist or is already at its instance limit when the link is activated, activation will fail. This template name is an 8-byte string in a locally displayable character set. If the implicit_dspu_services parameter is not set to AP_PU_CONCENTRATION, the implicit_dspu_templateparameter is reserved.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT 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. Zero indicates no timeout (the link is not deactivated, as though implicit_limited_resource were set to AP_NO).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT def_data.dlc_data.length Length of the port address (in the following parameter). def_data.dlc_data.address Port address. For SDLC, this is a 1-byte address. If ls_role is set to AP_LS_SEC, or if ls_role is set to AP_LS_NEG and the local station becomes secondary after LS role negotiation, this address is used in the response to an incoming call.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT 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. AP_NO_SESSIONS Implicit links are limited resources, and will be deactivated automatically when no active sessions are using them.
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 conjunction with the retry limit to give a long timeout before outage (such as 30). The timer is specified in 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT pri_fdplx 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 AP_YES SNAplus2 can send a REJ frame. AP_NO SNAplus2 cannot send a REJ frame; instead, it 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT stub_spec_data_len Length of the Stub specific data that follows. Set this to size of (STUB_SPEC_DATA). stub_spec_data.opt1 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).
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT 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-38400 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.linesp parameter is ignored.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT This is an ASCII string, specifying the dial string that must be passed to the modem to instruct it to respond to incoming calls. 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. Port-specific data for QLLC: mux_info.dlc_type Type of the DLC. Set this to AP_IMPL_NLI_QLLC.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT defined in this parameter. If cud_mode is set to VQL_DONTCARE, this parameter is ignored and CUD strings on incoming calls are not checked. add_mode Specifies the type of matching required between the address supplied on an incoming call and the port address defined in the address parameter above. Possible values are: VQL_DONTCARE The address on incoming calls is not checked.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT mux_info.dlc_type Type of the DLC. Possible values are: AP_IMPL_TR_DLPI Token Ring AP_IMPL_ETHER_DLPI Ethernet AP_IMPL_FDDI_DLPI FDDI sap_spec_data.ack_timeout 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 RR keep-alive interval in seconds for an otherwise idle link. sap_spec_data.max_retry Maximum permitted number of retries when waiting for any response or busy state to clear.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT One of the activation limit parameters was not set to a valid value. AP_INVALID_MAX_IFRM_RCVD The max_ifrm_rcvd parameter was not set to a valid value. AP_INVALID_HPR_SUPPORTED A reserved parameter was not set to zero. AP_INVALID_LS_ROLE The ls_role parameter was not set to a valid value. AP_INVALID_DSPU_SERVICES The implicit_dspu_services parameter was not set to a valid value.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_PORT AP_PORT_ACTIVE The specified port cannot be modified because it is currently active. AP_DUPLICATE_PORT_NUMBER A port with the specified port_number has already been defined. 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_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 Specifies the HP-UX user name of the UCF user. This parameter is a null-terminated ASCII string. Do not 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_RCF_ACCESS The DEFINE_*, SET_*, DELETE_*, ADD_*, REMOVE_*, and INIT_NODE verbs are allowed to be directed at any node in the domain. AP_ALLOW_ACTION_REMOTE 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_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) 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 def_data.lu_name 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 The user name structures are included at the end of the def_data structure; the nmber of these structures is specified by the num_users parameter.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_SECURITY_ACCESS_LIST def_data.description A null-terminated text string (0 - 31 characters followed by a null character) describing the security 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_SECURITY_ACCESS_LIST 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_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 unsigned char unsigned char unsigned char tn3270_support; /* Level of TN3270 support allow_specific_lu; /* Allow access to specific LUs printer_lu_name[8]; /* Generic printer LU/pool /* accessed unsigned char reserv1[6]; /* reserved AP_UINT16 port_number; /* TCP/IP port used to access /* server unsigned char lu_name[8]; /* Generic display LU/pool /* accessed unsigned char session_type; /* Unused in SNAplus2 V6 unsigned char model_override;
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TN3270_ACCESS 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. To restrict the use of TN server to a specific group of users, either do not include the default record, or leave it with no 3270 LU or LU pool configured so that it cannot be used.
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 one of this TN3270 user's sessions, the information for 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 Step 3. Edit the file /etc/inetd.conf, and find the line beginning with telnet. Make a note of the executable name and any supplied parameters for the 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.
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 Name of the display LU to be associated with the printer that was specified by the 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 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 Either the supplied display LU name or the supplied printer LU name was not a valid EBCDIC string.
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 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 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_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 unsigned char } TP_CHARS; tp_data[120]; /* 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 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 tp_chars.dynamic_load This parameter must be set to AP_YES. tp_chars.enabled Specifies whether the TP can be attached successfully. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DEFINE_TP AP_SYSTEM_TP_CANT_BE_CHANGED The specified TP name is the name of a TP used internally by SNAplus2 you cannot define or modify a TP with this name. AP_INVALID_CONV_TYPE 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.
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 The LTV type parameter was not set to a valid value. AP_INVALID_LTV_VALUE 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.
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 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 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 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 lu_names The names of the LUs on the LEN node to be deleted. Each name is an 8-byte type-A EBCDIC character 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_ADJACENT_LEN_NODE AP_INVALID_CP_NAME The cp_name parameter contained a character that was not valid. 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.
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_BACKUP 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_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 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_CN_NAME AP_INVALID_NUM_PORTS_SPECIFIED Appendix A, “Common Return Codes,” lists further secondary return codes associ
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 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 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 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 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 There were no LUs defined with names in the specified 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 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 • To delete one or more of the user's sessions but 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 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_EMULATOR_USER The specified user name was not defined as an emulation program user nam
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 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 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_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 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 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 value specified in the resource_type parameter was not valid. AP_INVALID_LU_NAME 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.
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 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 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. Possible values are: AP_NONE LU names have numbers that correspond to the NAU numbers.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3_RANGE 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_NAU_ADDRESS The min_nau or max_nau parameter was not valid.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_LU_0_TO_3_RANGE 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_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 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 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 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. 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_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 Specifies whether this verb refers to the default 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS If the num_sessions parameter (see above) is nonzero, this parameter is ignored. If num_sessions is zero, specify one of the following values: AP_ALL_SESSIONS Delete all sessions but leave the TN3270 user 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) DELETE_TN3270_ACCESS The specified TCP/IP port number did not match any TCP/IP port number defined for this user. 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_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 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 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_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 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 The node was not started because there was a version mismatch between components 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) 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 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 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 Number of sessions to activate automatically. 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) INITIALIZE_SESSION_LIMIT • The min_conwinners_source, min_conwinners_target, or auto_act parameter was set to a value greater than the value of plu_mode_session_limit. 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) INITIALIZE_SESSION_LIMIT One or more sessions are currently active for this LU-LU-mode combination. Use CHANGE_SESSION_LIMIT instead of INITIALIZE_SESSION_LIMIT to specify the limits. 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) INITIALIZE_SESSION_LIMIT 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) 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 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 file_info.role_supplied If requested_role was set to AP_BACKUP, this parameter indicates whether the file handle returned is for the master configuration file or a backup file. Possible values are: 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.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_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. 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) OPEN_FILE Alternatively, it can simply retry OPEN_FILE at intervals until it succeeds. AP_INVALID_VERSION One of the following has occurred: • The SNAplus2 version number in the configuration file header does not match the version of the SNAplus2 software you are using. Check that you have the correct file; if the file was created using an earlier version of SNAplus2, refer to the HP-UX SNAplus2 Upgrade Guide for information about upgrading it.
NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE) OPEN_FILE 498 Chapter 3
4 Chapter 4 NOF API Verbs (QUERY Verbs) 499
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 } DIAG_3270_DATA; 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; /* Number of user alerts */ /* /* /* /* */ */ */ */ description parameter 1 parameter 2 parameter 3 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_3270_DIAG buf_ptr A pointer to a data buffer that SNAplus2
NOF API Verbs (QUERY Verbs) QUERY_3270_DIAG 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 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 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 sessions time when user star
NOF API Verbs (QUERY Verbs) QUERY_3270_USER 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_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 The process ID of the 3270 emulation program for which information is required, or the process ID 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. If this parameter is specified and you are running SNAplus2 in a client-server configuration, the system_name parameter must also be specified.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER user_3270_summary.system_name The computer name on which the 3270 emulation program is running. 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.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER The time at which the user started the 3270 emulation program (this may be earlier than the start time for the first session). This value is specified as “seconds since epoch” (the number of seconds since the start of the year 1970).
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 unsigned char nau_address; AP_UINT32 reserv1[3]; } USER_3270_SESSION_DETAIL; /* 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 length of the overlay structure returned, and should not rely on the use of the sizeof() function.
NOF API Verbs (QUERY Verbs) QUERY_3270_USER_SESSIONS 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 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_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 seq_num_dt[17]; unsigned char reserva[20]; } ACTIVE_TRANSACTION_DATA; /* requestor /* sequence number date/time /* reserved */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_ACTIVE_TRANSACTION 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
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION 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 Sequence number date/time correlator (17 bytes long) 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 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. active_transaction_data.origin_ms_appl_name Application name of the origin for the transaction.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION Application name of the transaction requestor. This name is normally an 8-character EBCDIC string, using type-1134 characters (uppercase A-Z and numerals 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.
NOF API Verbs (QUERY Verbs) QUERY_ACTIVE_TRANSACTION 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_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 Start at the entry immediately following the entry specified by the combination of TP name and system 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.
NOF API Verbs (QUERY Verbs) QUERY_AVAILABLE_TP 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_AVAILABLE_TP The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the tp_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.
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 unsigned char max_buf_use_status; unsigned char debug_param[32]; } QUERY_BUFFER_AVAILABILITY; /* 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_* parameters (after returning them on this verb) to match the current values of these parameters.
NOF API Verbs (QUERY Verbs) QUERY_BUFFER_AVAILABILITY 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 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 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 Central logging is enabled. All log messages are sent to 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 unsigned char } CN_DET_DATA; 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 char modem_class; unsigne
NOF API Verbs (QUERY Verbs) QUERY_CN 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 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_CN 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 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.
NOF API Verbs (QUERY Verbs) QUERY_CN AP_SEC_GUARDED_RADIATION Data is transmitted over a line that is protected against physical and radiation tapping. 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).
NOF API Verbs (QUERY Verbs) QUERY_CN 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.
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 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 Fully qualified name of the CN. 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. 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 Appendix A, “Common Return Codes,” lists further secondary return 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 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.
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 unsigned char } CONV_SUMMARY; conv_state; reserv1; /conversation state /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.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION Start at the entry immediately following the entry 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.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION Identifier of the conversation for which information is required, or the conversation ID to be used as an index into the list of conversations. The conversation ID was returned by the ALLOCATE verb in the invoking TP, or by the RECEIVE_ALLOCATE verb in the invoked TP. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. session_id 8-byte identifier of the session.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION conv_summary.overlay_size The size of the returned conv_summary structure, and therefore the offset to the start of the next entry in the data buffer. When you r application needs to go through the returned buffer to find each conv_summary structure in turn, it must use this value to move to the correct offset for the next data structure, and must not use the C sizeof () operator.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION The session identifier of the session allocated to the conversation. conv_summary.conv_start_time The elapsed time in hundredths of seconds between the time when the SNAplusw node was started and the time when the conversation was started. conv_summary.bytes_sent The number of bytes that have been sent from the local TP to the partner TP since the start of the conversation. conv_summary.
NOF API Verbs (QUERY Verbs) QUERY_CONVERSATION secondary_rc Possible values are: AP_BAD_CONV_ID The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied value, but the conv_id parameter was not valid AP_INVALID_LU_ALIAS The specivied lu_name parameter was not valid. AP_INVALID_LU_NAME The specified lu_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 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 Start at the entry immediately following the entry 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 Each entry in the data buffer consists of the following parameters: cos_data.overlay_size 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.
NOF API Verbs (QUERY Verbs) QUERY_COS Number of session activation requests that failed because there was no acceptable route from this node to the named destination through the network. A route is only acceptable if it is made up entirely of active TGs and nodes that can provide the specified class of service.
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 typedef struct cos_node_status { unsigned char rar; unsigned char status; unsigned char reserv1[2]; } COS_NODE_STATUS; /* 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 the exact length of the overlay structure returned, and sho
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW 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 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 Specifies the minimum congestion status of the node. This parameter may be set to AP_UNCONGESTED, to any 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.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW 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. 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.
NOF API Verbs (QUERY Verbs) QUERY_COS_NODE_ROW 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_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 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; /* /* /* /* /* /* /* /* /* /* /* Effective capacity Reserved Connection Cost Byte cost Reserved Security Propag
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW 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. AP_LIST_FROM_NEXT Start at the entry immediately following 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 encrypted before transmission over the line. AP_SEC_GUARDED_RADIATION 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 cos_tg_row_data.tg_row.minimum.user_def_parm_1 through cos_tg_row_data.tg_row.minimum.user_def_parm_3 Minimum values for 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. cos_tg_row_data.tg_row.maximum.effect_cap Maximum limit for actual bits per second rate (line speed).
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW 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. cos_tg_row_data.tg_row.maximum.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW Delay is greater than 245,760 microseconds (typical for a satellite link). If the verb was issued to a running node, this value will be returned if the DEFINE_COS specified either AP_PROP_DELAY_SATELLITE or AP_PROP_DELAY_MAXIMUM. AP_PROP_DELAY_MAXIMUM Maximum propagation delay. cos_tg_row_data.tg_row.maximum.user_def_parm_1 through cos_tg_row_data.tg_row.maximum.
NOF API Verbs (QUERY Verbs) QUERY_COS_TG_ROW 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_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 unsigned char CPIC_SIDE_INFO unsigned char } CPIC_SIDE_INFO_DEF_DATA; reserv1[16]; side_info; reserv2[24]; 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 /* CPIC side info /* reserved /* /* reserved[3]; /* tp_name_type; /* tp_name[64]; /* mode_name[8]; /* conversation_security_type; /* /* security_user_i
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO 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 symbolic destination names from which SNAplus2 should begin to return data. Possible values are: AP_FIRST_IN_LIST Start at the first entry in the list.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO 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 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 0x01-0x3F, excluding 0x0E and 0x0F. cpic_side_info_data.def_data.side_info.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO XC_SECURITY_PROGRAM_STRONG 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.
NOF API Verbs (QUERY Verbs) QUERY_CPIC_SIDE_INFO The alias of the local LU used to communicate with the target TP. This alias is a character string using any locally displayable characters. 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_LIST_OPTION The list_options parameter was not set to a valid value.
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 To query tracing options on messages flowing between the computer to which this verb is issued (identified by 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.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE AP_CS_DATAGRAM Datagram messages 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.
NOF API Verbs (QUERY Verbs) QUERY_CS_TRACE 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_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 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 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 Specifies the timeout after which free limited-resource conwinner sessions are deactivated. The range is 0-65,535 seconds.
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 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 The list is ordered by parent_name, then by resource_name, and lastly by resource_type. 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”. 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.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY 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. parent_type 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 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: directory_entry_summary.overlay_size 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.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY directory_entry_detail.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_detail.resource_type Type of the resource.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY End node (for an LU resource owned by an end node) AP_NNCP_RESOURCE Network node (for an LU resource owned by a network node, or for an EN or LEN resource) directory_entry_detail.entry_type Specifies the type of the directory entry. This is one of the following: 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.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_ENTRY The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the resource_name parameter was not valid. AP_INVALID_RES_TYPE The resouce_type parameter was not set to a valid value. 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_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 reserva[20]; } DIRECTORY_LU_DETAIL; /* reserved */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_DIRECTORY_LU 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_DIRECTORY_LU 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. 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_DIRECTORY_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_DIRECTORY_LU Fully qualified name of the LU. 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_lu_detail.description A null-terminated text string describing the directory entry, as specified in the definition of the directory entry. directory_lu_detail.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_LU Specifies the type of the resource. This is one of the following: AP_HOME 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 set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the lu_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_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 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. cache_hits This parameter is reserved.
NOF API Verbs (QUERY Verbs) QUERY_DIRECTORY_STATS 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 DLC_DEF_DATA } DLC_DETAIL; 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_UINT16 dlc_spec_data_len; } DLC_DEF_DATA; /* Defined data */ /* State of the DLC /* re
NOF API Verbs (QUERY Verbs) QUERY_DLC 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 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_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.
NOF API Verbs (QUERY Verbs) QUERY_DLC dlc_detail.dlc_name 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 AP_FDDI FDDI 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.
NOF API Verbs (QUERY Verbs) QUERY_DLC 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_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 { 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() function.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE 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 LS resources. AP_PORT_DEFINED_LS 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.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE The required entry specifies 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 The required entry specifies 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 entry to be returned, or the entry to be used as an index into the list.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE 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_DLC_TRACE The entry specifies tracing options for the port named in resource_name, and for all LSs that use this port. AP_LS The entry specifies tracing options for the LS named in resource_name (or for a particular LFSID on this LS). AP_PORT_DEFINED_LS The entry specifies tracing options for the port named in resource_name, and for all defined LSs (but not implicit LSs) that use this port.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE The type of messages being traced for the specified resource or session.
NOF API Verbs (QUERY Verbs) QUERY_DLC_TRACE AP_INVALID_LIST_TYPE The list_type parameter specified a value that was not valid. AP_INVALID_RESOURCE_TYPE The resource_type parameter specified a value that was not valid. 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.
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 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 } DLUR_LU_DETAIL; NOTE plu_name[17]; reserv1[27]; rscv_len; /* 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. This control vector defines the session route through the network and is carried on the BIND.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_LU 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_DLUR_LU 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 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. 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 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. If the node's configuration specifies that DLUR RSCVs are not stored, or if the PLU-SLU session is not active, this length is set to zero and no RSCV is included.
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 FQPCID AP_UINT16 AP_UINT16 } DLUR_PU_DETAIL 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]; unsigned char fqcp_name[17]; unsigned char } FQPCID; reserve3[3]; /* /* /* /* /* /* /* /* /* /* PU identifier */ downstream or loca
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU 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_DLUR_PU 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 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 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 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 The combination of the pcid and fqcp_name parameters uniquely identify each PU whose sessions are being routed using DLUR. The fqcp_name parameter is the CP name of either the DLUR or DLUS 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.
NOF API Verbs (QUERY Verbs) QUERY_DLUR_PU 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_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 PIPE_STATS } DLUS_DATA; 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_sent; sscp_pu_mus_rcvd; sscp
NOF API Verbs (QUERY Verbs) QUERY_DLUS 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 Specifies whether the DLUS node has been designated 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.
NOF API Verbs (QUERY Verbs) QUERY_DLUS Number of REQDACTPUs sent to DLUS over the pipe. dlus_data.pipe_stats.reqdactpu_rsp_received 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.
NOF API Verbs (QUERY Verbs) QUERY_DLUS 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 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 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 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; unsigned char SESSION_STATS SESS
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU 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_STATS; /* /* /* /* /* /* /* /* /* /* /* /* current receive pacing window size*/ number of data frames sent */ num fmd data frames sent */ num
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU 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 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 The size of the returned downstream_lu_summary structure, and therefore the offset to the start of the 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.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU AP_NO The session is not active. downstream_lu_summary.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 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 AP_DLUR Downstream LU is served by DLUR. 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.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU 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. rcv_data_bytes Number of normal flow data bytes received. sidh Session ID high byte.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_LU pacing_type The type of receive pacing in use on this session. 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 This field is reserved for DLUR-served downstream LUs. 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 The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the lu_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_DOWNSTREAM_LU 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_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 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 ls_name[8]; unsigned char pacing_type; } SESSION
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU 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. dspu_name Name of the PU for which information is required (as specified on DEFINE_LS), or the name to be used as an index into the list of PUs.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU 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 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.rcv_ru_size Maximum receive RU size; this field is reserved (and set to zero) if the downstream PU is served by PU concentration. downstream_pu_data.
NOF API Verbs (QUERY Verbs) QUERY_DOWNSTREAM_PU 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 Each dspu_template_data structure is followed by one or more 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 The number of entries actually returned. The last 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.
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
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF 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 */ /* Session type - Model 2-5 or printer*/ /* Can the user override the mo
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF To request data for a specific user 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_EMULATOR_USER_DEF The list is ordered by user name, and then by session name (irrespective of session type) for each user. 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_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.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF information about each user's style file and 3270 permissions but to suppress detailed information about individual sessions. 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_EMULATOR_USER_DEF for this user that are included in the returned data. (The num_filtered_sessions parameter returned for this user indicates the total number of session structures of the requested type that are available.) 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_EMULATOR_USER_DEF The details of the user, as defined in the configuration. This is followed by a number of session structures, defining the user's sessions and the user's remap list.
NOF API Verbs (QUERY Verbs) QUERY_EMULATOR_USER_DEF The list_options parameter was set to AP_LIST_INCLUSIVE, but the session_name parameter did not match a session name defined for the specified user. 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_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 AP_UINT16 }FP_DATA; number_of_appls; /* 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 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”. ms_category Management Services category.
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 The MDS_MU should be delivered to the focal point using default routing. 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 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_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 succinct_audits; unsigned char succinct_errors; } QUERY_GLOBAL_LOG_TYPE; /* 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: primary_rc AP_OK secondary_rc Not used.
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE 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. To obtain more details of the cause of the log and any action required, you can use the snaphelp utility.
NOF API Verbs (QUERY Verbs) QUERY_GLOBAL_LOG_TYPE 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_NOT_CENTRAL_LOGGER 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 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 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 LOCAL_LU_DET_DATA } LOCAL_LU_DETAIL; 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[6]; unsigned char reserv3[1]; ATTACH_ROUTING_DATA atta
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; 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; /* /* /* /* session ID low byte ODAI bit set link station name type of pacing in use */ */ */ */ /* /* /* /* Name of target system for TP timeout value in seconds is target system back-level? reserved */ *
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_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 lu_name or lu_alias parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the lu_name or lu_alias parameter.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU 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. lu_alias LU alias of the LU for which information is required, or the name to be used as an index into the list of LUs. This value is ignored if list_options is set to AP_FIRST_IN_LIST.
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 A null-terminated text string describing the 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.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU 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. 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.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU If this parameter is set to binary zeros, SNAplus2 routes the incoming Allocate request dynamically to a running copy of the TP, if available, or attempts to start the TP on the same computer as the local LU. local_lu_detail.def_data.attach_routing_data.timeout The timeout value (in seconds) for dynamic load requests.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU The LU-SSCP session is not active. local_lu_detail.det_data.appl_conn_active Specifies whether an application is using the LU. If def_data.nau_address is zero, this parameter is reserved. Possible values are: AP_YES An application is using the 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.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU Number of normal flow function management data (FMD) frames sent. local_lu_detail.det_data.lu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. local_lu_detail.det_data.lu_sscp_stats.rcv_data_frames Number of normal flow data frames received. local_lu_detail.det_data.lu_sscp_stats.rcv_fmd_data_frames 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.
NOF API Verbs (QUERY Verbs) QUERY_LOCAL_LU This parameter is a 6-byte field containing the SSCP ID received in the ACTPU for the PU used by this LU. This parameter is used only by dependent LUs, and is set to all binary zeros for independent LUs or if lu_sscp_sess_active is not set to AP_YES.
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 unsigned char } QUERY_LOG_TYPE; succinct_errors; /* use succinct logging in error file? */ 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_YES Audit messages are recorded. 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 If you are using central logging, the choice of succinct or full logging for messages from all computers is determined by the setting of this parameter on the server acting as the central logger; this setting may either be from the SET_GLOBAL_LOG_TYPE verb, or from a SET_LOG_TYPE verb issued to that server to override the default.
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 } LS_SUMMARY; 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 unsigned char unsigned char unsigned c
NOF API Verbs (QUERY Verbs) QUERY_LS 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; unsigned char pu_name[8]; unsigned char unsigned
NOF API Verbs (QUERY Verbs) QUERY_LS typedef struct link_address { AP_UINT16 reserve1; AP_UINT16 length; unsigned char address[32]; } LINK_ADDRESS; /* reserved /* length /* address */ */ */ 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; typedef struct tg_defined_chars { unsigned char effect_cap; unsigned char reserve1[5]; unsigned char c
NOF API Verbs (QUERY Verbs) QUERY_LS AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 } LS_STATS; max_delay; min_delay; max_delay_time; good_xids; bad_xids; /* /* /* /* /* reserved reserved reserved successful XID on LS count unsuccessful XID on LS count */ */ */ */ */ For more details of the link-specific data, see “DEFINE_LS”. The data structure for this data follows the ls_def_data structure, but is padded to start on a 4-byte boundary.
NOF API Verbs (QUERY Verbs) QUERY_LS 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 ls_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the ls_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_LS 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_LS 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 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. 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. AP_VRN Virtual routing node.
NOF API Verbs (QUERY Verbs) QUERY_LS 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. AP_BACK_LEVEL_LEN_NODE Back-level LEN node (one that does not include the Network Name CV in its XID3). AP_HOST_XID3 Host node; SNAplus2 should respond to a polling XID from the node with a format 3 XID.
NOF API Verbs (QUERY Verbs) QUERY_LS Downstream PU; SNAplus2 should not include XID exchange in link activation. The dspu_name and dspu_services fields must also be set. AP_VRN Virtual routing node. ls_detail.overlay_size 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.
NOF API Verbs (QUERY Verbs) QUERY_LS 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_detail.det_data.sub_state This field provides more detailed information about the state of this link station.
NOF API Verbs (QUERY Verbs) QUERY_LS 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_detail.det_data.det_adj_cp_type Type of the adjacent node. This is one of the following: AP_END_NODE End node. AP_NETWORK_NODE Network node. AP_LEARN_NODE Node type is unknown.
NOF API Verbs (QUERY Verbs) QUERY_LS The link was defined explicitly (by DEFINE_LS). ls_detail.det_data.migration Specifies whether the adjacent node is a migration level node (such as a Low Entry Networking or LEN node), or a full APPN network node or end node. Possible values are: AP_YES The adjacent node is a migration-level node. AP_NO The adjacent node is a network node or end node. AP_UNKNOWN The adjacent node level is unknown. ls_detail.det_data.tg_num Number associated with the TG. ls_detail.
NOF API Verbs (QUERY Verbs) QUERY_LS ls_detail.det_data.ls_stats.out_msg_bytes Total number of data bytes sent on this link station. ls_detail.det_data.ls_stats.out_xid_frames Total number of XID (Exchange Identification) frames sent on this link station. ls_detail.det_data.ls_stats.out_msg_frames Total number of data frames sent on this link station. ls_detail.det_data.ls_stats.in_invalid_sna_frames Total number of not valid SNA frames received on this link station. ls_detail.det_data.ls_stats.
NOF API Verbs (QUERY Verbs) QUERY_LS ls_detail.det_data.current_state_time Total time (in hundredths of a second) that this link station has been in its current state. ls_detail.det_data.deact_cause The cause of the last deactivation of the link station. Possible values are: AP_NONE The link station has never been deactivated. AP_DEACT_OPER_ORDERLY The link station was deactivated as a result of an orderly STOP command from an operator.
NOF API Verbs (QUERY Verbs) QUERY_LS Specifies whether the link currently allows remote activation or activation on demand. This is set to AP_NONE if neither is allowed, or to one or both of the following values (combined using a logical OR): AP_AUTO_ACT The link can be activated on demand by the local node when a session requires it. AP_REMOTE_ACT The link can be activated by the remote node. ls_detail.det_data.ls_role The LS role of this link.
NOF API Verbs (QUERY Verbs) QUERY_LS ls_detail.det_data.reverse_anr_label This parameter is reserved. ls_detail.det_data.local_address The local address of this link station. ls_detail.det_data.max_send_btu_size Maximum BTU size that can be sent on this link, as determined by negotiation with the adjacent node. If the link activation has not yet been attempted, a zero value is returned. ls_detail.def_data.
NOF API Verbs (QUERY Verbs) QUERY_LS Retry count for reactivating a failed LS. This parameter is used to specify whether SNAplus2 should attempt to reactivate the LS if it fails while in use (or if an attempt to start the LS fails). Zero indicates that SNAplus2 should not attempt to reactivate the LS; a nonzero value specifies the number of retries to be made. A value of 65,535 indicates that SNAplus2 should retry indefinitely until the LS is activated.
NOF API Verbs (QUERY Verbs) QUERY_LS ls_detail.def_data.adj_cp_type Adjacent node type. This is one of the following: AP_APPN_NODE APPN-capable node; the node type will be learned during XID exchange. AP_NETWORK_NODE Network node. AP_END_NODE End node, or up-level LEN node (one that includes the Network Name CV in its XID3). AP_BACK_LEVEL_LEN_NODE Back-level LEN node (one that does not include the Network Name CV in its XID3).
NOF API Verbs (QUERY Verbs) QUERY_LS 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 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. ls_detail.def_data.dest_address.lsap_address Local SAP address of link station on adjacent node. For all link types: ls_detail.def_data.auto_act_supp Specifies whether the link can be activated automatically when required by a session.
NOF API Verbs (QUERY Verbs) QUERY_LS The link is a limited resource and will be deactivated automatically when no active sessions are using it. AP_INACTIVITY The link is a limited resource and will be deactivated automatically when no active sessions are using it, or when no data has flowed on the link for the time period specified by the link_deact_timer field. ls_detail.def_data.
NOF API Verbs (QUERY Verbs) QUERY_LS 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 Standard SNA host. AP_FNA 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 AP_YES CP-CP sessions are supported. AP_NO 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 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. 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.
NOF API Verbs (QUERY Verbs) QUERY_LS 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. ls_detail.def_data.tg_chars.user_def_parm_1 through def_data.tg_chars.
NOF API Verbs (QUERY Verbs) QUERY_LS AP_LS_NEG Negotiable ls_detail.def_data.max_ifrm_rcvd Maximum of I-frames that can be received by this link station before an acknowledgment is sent. This value is in the range 0-127. When this field is zero, the value of max_ifrm_rcvd from DEFINE_PORT is used as default. ls_detail.def_data.dlus_retry_timeout Interval in seconds between second and subsequent attempts to contact the DLUS specified in the ls_detail.def_data.dlus_name and ls_detail.def_data.
NOF API Verbs (QUERY Verbs) QUERY_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_INVALID_LINK_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the ls_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_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 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; SESSION_STATS plu_stats; unsigned
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 unsigned char unsigned char } SESSION_STATS; 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_UINT16 timeout; unsigned char app_spec_def_data[16]; } LU_0_TO_3_DEF_DATA; /* Link station name /* type of pacing in use /* /* /* /* /* /* /*
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 If the app_type parameter in the lu_0_to_3_det_data structure is set to AP_LUA_APPLICATION, 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_LUA_APPLICATION and the user_name through user_gname parameters are not returned.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 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. To return as many entries as possible, specify 0; 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_LU_0_TO_3 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. lu_name Name of the local LU.
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 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 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 lu_0_to_3_summary.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. 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 No application is using the LU. lu_0_to_3_detail.det_data.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. 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 Maximum size of the send pacing window on this session. (In the LU-SSCP session statistics, this parameter is reserved.) cur_send_pac_win 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 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. 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 • If app_type is set to AP_FMI_APPLICATION, this field is replaced by the session_user_info structure, containing information about the user of this LU. The structure consists of the following fields: 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 The HP-UX user ID with which the program is running. user_gid The HP-UX group ID with which the program is running. 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.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 cfg_address The TCP/IP address of the computer on which the TN3270 program runs, as defined in the configuration record that this user is using. This is a string of 1-64 characters, followed by a null character. The address may be specified as a dotted-decimal IP address (such as 193.1.11.100), as a name (such as newbox.this.co.uk), or as an alias (such as newbox); the format is indicated by the cfg_format parameter.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 This is a printer LU that has been associated with a display LU by a DEFINE_TN3270_ASSOCIATION verb, or a display LU that has been associated with a printer LU by a DEFINE_TN3270_ASSOCIATION verb. The LU is in use by the TN3270 through its association. request_lu_name Requested LU name or associated display 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. lu_0_to_3_detail.det_data.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 The LU is being used by a TN3270 program accessing TN server. lu_0_to_3_detail.det_data.sscp_id A 6-byte field containing the SSCP ID received in the ACTPU for the PU used by this LU. If lu_sscp_sess_activeis not AP_NO, this parameter will be all zeros. lu_0_to_3_detail.def_data.description A null-terminated text string describing the LU, as specified in the definition of the LU. lu_0_to_3_detail.def_data.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 AP_3270_DISPLAY_MODEL_3 AP_3270_DISPLAY_MODEL_4 AP_3270_DISPLAY_MODEL_5 AP_PRINTER AP_SCS_PRINTER AP_RJE_WKSTN AP_UNKNOWN lu_0_to_3_detail.def_data.sscp_id Specifies the ID of the SSCP permitted to activate this LU. This is a 6-byte binary field. If this parameter is set to binary zeros, the LU may be activated by any SSCP. lu_0_to_3_detail.def_data.timeout Timeout for the LU, specified in seconds.
NOF API Verbs (QUERY Verbs) QUERY_LU_0_TO_3 AP_INVALID_LU_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_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_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 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 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.
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 } LU_POOL_DETAIL; plu_sess_active; /* 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 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_POOL 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. AP_LIST_INCLUSIVE Start at the entry specified by the combination of the pool_name and lu_name parameters.
NOF API Verbs (QUERY Verbs) QUERY_LU_POOL 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_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 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 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; /* /* /* /* list options reserved resource type resource name */ */ */ */ /* /* /* /* overlay size resource type resource name timeout */ */ */ */ Supplied Parame
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT 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 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 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: Chapter 4 • If resource_type is set to AP_GLOBAL_TIMEOUT, do not specify this parameter.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT 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. 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_LU62_TIMEOUT Timeout applies to all LU 6.2 sessions for the local LU indicated by the resource_name parameter. AP_PARTNER_LU_TIMEOUT Timeout applies to all LU 6.2 sessions to the partner LU indicated by the resource_name parameter. 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.
NOF API Verbs (QUERY Verbs) QUERY_LU62_TIMEOUT of resource_type and resource_name did not match any that are configured. 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_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 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 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 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 The size of the returned mds_application_data structure, and therefore the offset to the start of the 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.
NOF API Verbs (QUERY Verbs) QUERY_MDS_APPLICATION 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_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 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 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. mds_mus_delivered_remote Number of MDS_MUs successfully delivered to a remote node using the MDS_SEND transaction program.
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 AP_UINT16 AP_UINT16 unsigned char unsigned char } MODE_SUMMARY; 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; AP_UINT16 min_conwinners_target; unsigned char drain_source; u
NOF API Verbs (QUERY Verbs) QUERY_MODE 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 Start at the entry specified by the supplied partner LU 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 Partner LU alias. This 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. 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.
NOF API Verbs (QUERY Verbs) QUERY_MODE Return information about all modes for which sessions are active or have been active. 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_MODE mode_summary.description A null-terminated text string describing the mode, as specified in the definition of the mode. mode_summary.sess_limit Current session limit. 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.
NOF API Verbs (QUERY Verbs) QUERY_MODE 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.min_conwinners_source Specifies the minimum number of sessions on which the local LU is the contention winner. mode_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE Number of contention winner sessions that are automatically activated following the CNOS exchange with the partner LU. mode_detail.act_cw_count Number of active contention winner sessions using this mode. (The local LU does not need to “bid” before using one of these sessions.) mode_detail.act_cl_count Number of active, contention loser sessions using this mode. (The local LU must “bid” before using one of these sessions.) mode_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE AP_NO SNAplus2 uses the maximum RU size specified in the definition of the mode. mode_detail.max_neg_sess_limit Maximum negotiable session limit. Specifies the maximum session limit that a local LU can use with this mode name during its CNOS processing as the target LU. mode_detail.max_rcv_ru_size Maximum received RU size. mode_detail.pending_session_count Specifies the number of sessions pending (waiting for session activation to complete). mode_detail.
NOF API Verbs (QUERY Verbs) QUERY_MODE AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. 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. AP_INVALID_LU_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_name parameter was not valid.
NOF API Verbs (QUERY Verbs) QUERY_MODE 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_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 unsigned char MODE_CHARS } MODE_DEF_DETAIL; mode_name[8]; mode_chars; 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]; cryptography; compression; auto_act; AP_UINT16 min_c
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION 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. 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_MODE_DEFINITION 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. 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_MODE_DEFINITION 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.overlay_size The size of the returned mode_def_detail structure, and therefore the offset to the start of the next entry in the data buffer. mode_def_detail.mode_name Mode name.
NOF API Verbs (QUERY Verbs) QUERY_MODE_DEFINITION 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. Possible values are: AP_YES SNAplus2 ignores the max_ru_size_upp parameter, and sets the upper bound for the maximum RU size to the largest value that can be accommodated in the link BTU size.
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 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_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 The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the application 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_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 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 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; /* reserved */ /* node type */ /* fully qualified CP name */ /* CP alias */ /* mode to COS mapping support */ /* MDS and MS capabilities */ /* node ID */ /* maximum locates node can process*/ /* r
NOF API Verbs (QUERY Verbs) QUERY_NODE 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.node_type Type of node. Possible values are: AP_END_NODE AP_LEN_NODE cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE 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.node_id Node identifier used in XID exchange. This is a 4-byte hexadecimal string. cp_create_parms.max_locates Maximum number of locates that the node can process. cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE 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. Possible values are: AP_YES Register resources with the CDS. AP_NO Do not register resources. cp_create_parms.
NOF API Verbs (QUERY Verbs) QUERY_NODE 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. Possible values are: AP_YES Store RSCVs. AP_NO Do not store RSCVs.
NOF API Verbs (QUERY Verbs) QUERY_NODE 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.ptf Array for configuring and controlling future program temporary fix (ptf) operation. cp_create_parms.ptf[0] REQDISCONT support.
NOF API Verbs (QUERY Verbs) QUERY_NODE 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. SNAplus2 normally processes an ACTPU(ERP) as an ERP; this resets the PU-SSCP session, but does not implicitly deactivate the subservient LU-SSCP and PLU-SLU sessions.
NOF API Verbs (QUERY Verbs) QUERY_NODE Do not use the BIS protocol. Limited resource LU 6.2 sessions are deactivated immediately using UNBIND(cleanup). up_time 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 AP_REG_WITH_NN Node will register its LUs with the adjacent serving network node. AP_REG_CHARS_WITH_NN Node supports send register characteristics. If this function is supported, send registered names must also 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.
NOF API Verbs (QUERY Verbs) QUERY_NODE Release level of the DLUR architecture supported by the node. This is set to the value 1 (the only release level of DLUR currently defined); future versions may incorporate later release levels of the DLUR architecture, and so may return different values. fq_nn_server_name End node only. Name of the network node server for the node. current_isr_sessions This parameter is reserved.
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 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 multiple verbs in the normal way. For more information 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 The size of the returned node_summary structure, and 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.
NOF API Verbs (QUERY Verbs) QUERY_NODE_ALL 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_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.
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 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.num_user_sessions The maximum total number of sessions (type 0-3 and APPC) that your license allows you to have active at any one time.
NOF API Verbs (QUERY Verbs) QUERY_NODE_LIMITS 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 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 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 } PLU_SUMMARY; partner_cp_name[17]; partner_lu_located; /* partner LU CP name /* CP name resolved? */ */ implicit; security_details; duplex_support; preference; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ */ reserva[16]; /* reserved typedef struct plu_detail { AP_UINT16 overlay_size; unsigned char plu_alias[8]; unsigned char fqplu_name[17]; unsigned char reserv1; uns
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU 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. 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_PARTNER_LU 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 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. 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 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_PARTNER_LU A null-terminated text string describing the partner LU, as specified in the definition of the partner LU. plu_summary.act_sess_count 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 plu_detail.fqplu_name 17-byte fully qualified network name for the partner LU. 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. plu_detail.description A null-terminated text string describing the partner LU, as specified in the definition of the partner LU. plu_detail.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU Uninterpreted name of the partner LU. This is an 8-byte type-A EBCDIC character string. plu_detail.parallel_sess_supp Specifies whether parallel sessions are supported. Possible values are: AP_YES 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.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU The entry is an explicit entry. plu_detail.security_details Returns the conversation security support as negotiated on the BIND. Possible values are: AP_CONVERSATION_LEVEL_SECURITY Conversation security information will be accepted on requests to or from the partner LU to allocate a conversation. The specific types of conversation security support are described by the following values.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU support Password Substitution, an Allocate or Send_Conversation with security type set to AP_PGM_STRONG will fail. plu_detail.duplex_support Returns the conversation duplex support as negotiated on the BIND. Possible values are: AP_HALF_DUPLEX Only half-duplex conversations are supported. AP_FULL_DUPLEX Both full-duplex and half-duplex sessions are supported. Expedited data is also supported.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU 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. AP_INVALID_LU_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_name parameter was not valid.
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 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; parallel_sess_supp; reserv3[8]; /* reserved /* partner LU characteristics */ */
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION 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_PARTNER_LU_DEFINITION order of LU alias or LU name, depending on which was specified as the 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.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION 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_DEFINITION The size of the returned partner_lu_def_detail structure, and therefore the offset to the start of the 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 logical record length, in bytes, that can be sent to the partner LU. This may be in the range 1-32,767, or zero to indicate no limit (in which case the 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.
NOF API Verbs (QUERY Verbs) QUERY_PARTNER_LU_DEFINITION The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the plu_alias or fqplu_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_PORT QUERY_PORT QUERY_PORT returns a list of information about a node's ports. If the port is active, it returns "determined" data, i.e. the address of the lan card, no matter what is configured.If the port is inactive, it returns "defined" data, i.e. the mac address held in the configuration file. 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 unsigned char unsigned char PORT_DET_DATA PORT_DEF_DATA } PORT_DETAIL; port_name[8]; reserv1[2]; det_data; def_data; 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_implicit_links; neg_ls_supp; reserva[17]; /* /* /*
NOF API Verbs (QUERY Verbs) QUERY_PORT /* that can be received target_pacing_count; /* target pacing count max_send_btu_size; /* maximum send BTU size dlc_data; /* DLC data hpr_dlc_data; /* reserved implicit_cp_cp_sess_support; /* implicit links allow /* CP-CP sessions unsigned char implicit_limited_resource; /* implicit links are /* limited resource unsigned char implicit_hpr_support; /* reserved unsigned char implicit_link_lvl_error; /* reserved unsigned char retired1; /* reserved TG_DEFINED_CHARS default
NOF API Verbs (QUERY Verbs) QUERY_PORT 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. 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_PORT 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. To return information only on ports associated with a specific DLC, specify the DLC name. 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_PORT 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.description A null-terminated text string describing the port, as specified in the definition of the port. port_summary.port_state Specifies the current state of the port.
NOF API Verbs (QUERY Verbs) QUERY_PORT 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 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.def_ls_bad_xids Total number of unsuccessful 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 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. For SDLC, the following values may be returned: AP_PORT_SWITCHED Switched line.
NOF API Verbs (QUERY Verbs) QUERY_PORT 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 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 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 This parameter is reserved. def_data.implicit_link_lvl_error This parameter is reserved. 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 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_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 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 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_STATS; sidl; odai; l
NOF API Verbs (QUERY Verbs) QUERY_PU 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 The size of the returned pu_data structure, and therefore the offset to the start of the next entry in the data buffer. 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.
NOF API Verbs (QUERY Verbs) QUERY_PU pu_data.pu_sscp_stats.send_ru_size Reserved (always set to zero). pu_data.pu_sscp_stats.max_send_btu_size 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.
NOF API Verbs (QUERY Verbs) QUERY_PU pu_data.pu_sscp_stats.sidl Session ID low byte. pu_data.pu_sscp_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. pu_data.pu_sscp_stats.ls_name Link station name associated with statistics.
NOF API Verbs (QUERY Verbs) QUERY_PU 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. 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.
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 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 The START_*, STOP_*, ACTIVATE_*, DEACTIVATE_*, APING, 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_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char AP_UINT32 AP_UINT32 } RJE_WKSTN_DETAIL; wkstn_pid; reserv1; wkstn_uid; wkstn_gid; wkstn_uname[32]; wkstn_gname[32]; wkstn_session_count; wkstn_start_time; /* /* /* /* /* /* /* /* process ID reserved user ID group ID user name group name count of RJE LU sessions time workstation was started */ */ */ */ */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode A
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 To list only information about workstations running on a particular computer, specify the computer name. To obtain a complete list for all computers, set this field to 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 buffer.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN rje_wkstn_summary.wkstn_pid The process ID of the workstation. rje_wkstn_detail.overlay_size The size of the returned rje_wkstn_detail structure, 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.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN The time at which the workstation was started (this may be earlier than the start time for the first LU session). This value is specified as “seconds since epoch” (the number of seconds since the start of the year 1970).
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 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 workstation */ runs */ count field for the number */ of LUs */
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF 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_RJE_WKSTN_DEF 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. Each entry in the data buffer consists of the following: total_num_entries Total number of entries that could have been returned. This may be higher than num_entries.
NOF API Verbs (QUERY Verbs) QUERY_RJE_WKSTN_DEF 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 parameter did not match any defined RJE workstation name.
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 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. The last entry may be incomplete.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST AP_YES The complete data for the last security access list was too large to fit in the data buffer. At least one user 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.
NOF API Verbs (QUERY Verbs) QUERY_SECURITY_ACCESS_LIST Name of the user. This is a user ID defined using the DEFINE_USERID_PASSWORD verb. 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_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.
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 /* correlator ID */ } SESSION_SUMMARY; typedef struct session_detail { AP_UINT16 overlay_size; unsigned char plu_alias[8]; unsigned char fqplu_name[17]; unsigned char reserv3[3]; unsigned char mode_name[8]; unsigned char session_id[8]; FQPCID fqpcid; unsigned char unsigned char unsigned char unsigned char unsigned char SESSION_STATS unsigned char unsigned char unsigned char AP_UINT32 AP_UINT16 unsigned char unsigned char unsigned char unsigned char } SESSION_DETA
NOF API Verbs (QUERY Verbs) QUERY_SESSION AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 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; send_ru_size; max_send_btu_size; max_rcv_btu_size; max_send_pac_win; cur_send_pac_win; max_rcv_pac_win; /* /* /* /* /* /* /* cur_rcv_pac_win; /* /* send_data_frames; /* send_fmd_data_frames; /* send_data_bytes; /* rcv_data_frames; /* rcv_fmd_data_fram
NOF API Verbs (QUERY Verbs) QUERY_SESSION 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. 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_SESSION 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. To specify the LU associated with the local CP (the default LU), set both lu_name and lu_alias to binary zeros. lu_alias Locally defined LU alias.
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 Maximum BTU size that can be sent. 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 ID low byte. 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.
NOF API Verbs (QUERY Verbs) QUERY_SESSION session_detail.session_start_time The time between the CP starting and this session becoming active, measured in one-hundredths of a 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.
NOF API Verbs (QUERY Verbs) QUERY_SESSION session_detail.rscv_len Length of the RSCV which is appended to the session_detail structure. (If none is appended, then the length is zero.) 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.
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 } BACKUP_SUMMARY; reserv2[4]; /* 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 Total number of entries available. A value greater than 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.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET 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 check, SNAplus2 returns the following parameters.
NOF API Verbs (QUERY Verbs) QUERY_SNA_NET 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 (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 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 AP_UINT32 AP_UINT32 AP_UINT32 ioctets_in; AP_UINT32 ioctets_out; AP_UINT32 uiframes_in; AP_UINT32 uiframes_out; AP_UINT32 xids_in; AP_UINT
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_UINT16 unsigned char AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 role; name[8]; state; maxdata; replyto; maxin; maxout; modulo; reserv2[3]; retries_m; retries_t; retries_n; rnrlimit; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* current role of link station */ reserved */ operational state of LS */ current max PDU size for logical link */ current reply timeout */ current max unack'd fr
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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; link deactivations due frames link deactivations due link deacts due to rem link deacts due to end retransmitted I-frames start-up I-frames retransmitted to bad rcvd */ */ to inactivity */ busy timer expiry*/ of retry sequence*/ rcvd since */ */ since start-up */
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS AP_UINT32 AP_UINT32 AP_UINT32 int } V0_MUX_INFO; card_type; adapter_number; oem_data_length; mux_ids[5]; /* /* /* /* type of adapter card DLC adapter number reserved reserved */ */ */ */ Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_STATISTICS name Name of the LS or port for which statistics are required (as specified by the stats_type parameter).
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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. This parameter applies only if table_type is set to AP_STATS_TBL; it is ignored otherwise. Possible values are: AP_YES Reset the statistics; a subsequent QUERY_STATISTICS verb will contain only data gathered after this verb was issued.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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 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. For more information about these parameters, see “DEFINE_DLC”. LS statistics for SDLC: sdl_ls_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.poll_rsps_out Total number of polls responded to by the adjacent link station. sdl_ls_stats_table.local_busies Total number of times the local link station has entered busy state (RNR). sdl_ls_stats_table.remote_busies Total number of times the remote link station has entered busy state (RNR). sdl_ls_stats_table.iframes_in The total number of I-frames received from the adjacent link station (including retries and out-of-order frames).
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_ls_stats_table.xids_out The total number of XID frames transmitted to the adjacent link station. sdl_ls_stats_table.tests_in The total number of TEST frames, commands, or responses received from the adjacent link station. sdl_ls_stats_table.tests_out The total number of TEST frames, commands, or responses transmitted to the adjacent link station. sdl_ls_stats_table.rejs_in The total number of REJ frames received from the adjacent link station.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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.snrm_out The total number of SNRM frames sent. LS operational information for SDLC: sdl_ls_oper_table.index The index value used internally by SNAplus2 to identify the port that owns this LS. sdl_ls_stats_table.address The poll address of the secondary link station.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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.maxin The maximum number of frames that the LS can receive before it must send an acknowledgment. sdl_ls_stats_table.maxout The maximum number of frames that the LS can send before it must wait for an acknowledgment. sdl_ls_stats_table.modulo The sequence number modulus for the LS.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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. If the LS has not failed, this field is set to zeros. sdl_ls_stats_table.last_fail_ctrl_out The control field from the last frame sent before the last failure.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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. sdl_port_stats_table.dwarf_frames The number of frames received by the port that were too short to be valid. sdl_port_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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.octets_out The total number of bytes (not including FCSs) transmitted to adjacent link stations. sdl_port_stats_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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.type Specifies whether the port is operating as though connected to a leased or switched line. Possible values are: SDL_MIB_LEASED SDL_MIB_SWITCHED sdl_port_oper_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS sdl_port_oper_table.pause The length of time that the primary station waits between successive cycles of polling secondary stations. This parameter applies only if the LS role is primary; its value is undefined if the LS role is secondary. sdl_port_oper_table.slow_poll_method The method used for periodically polling failed secondary link stations. This is set to SDL_MIB_POLLPAUSE. sdl_port_oper_table.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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. AP_INVALID_TABLE_TYPE The table_type parameter was not set to a valid value.
NOF API Verbs (QUERY Verbs) QUERY_STATISTICS 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 If no tracing is active, or if tracing of all types is active, 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 returned
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF 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 users for which data should be returned.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF 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 The address can be specified as a dotted-decimal IP address (such as 193.1.11.100), as a fully qualified name (such as newbox.this.co.uk), or as an alias (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 parameter indicates the number of session structures for this user that are included in the returned data. Otherwise, this parameter is not used. num_last_sessions 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.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF AP_NO This is a normal TN3270 user record. tn3270_access_summary.client_address The TCP/IP address of the TN3270 user. This is a null-terminated ASCII string. tn3270_access_summary.address_format Specifies the format of the client_address parameter. Possible values are: 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.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ACCESS_DEF information is the same as for the DEFINE_TN3270_ACCESS verb, except for the following: • The num_sessions parameter in the def_data structure defines the total number of sessions defined for the user. • If the port_number 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_TN3270_ACCESS_DEF 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_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 Data is returned in the form of tn3270_association structures. Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_TN3270_ASSOCIATION 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_TN3270_ASSOCIATION 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. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
NOF API Verbs (QUERY Verbs) QUERY_TN3270_ASSOCIATION 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 • The list_options parameter was set to AP_LIST_FROM_NEXT, but the display LU name 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 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 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. buf_size Size of the supplied data buffer.
NOF API Verbs (QUERY Verbs) QUERY_TP 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 Number of instances of the TP that have been started 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).
NOF API Verbs (QUERY Verbs) QUERY_TP 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_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 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_TP_DEFINITION 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_TP_DEFINITION Name of the security access list used by this TP (defined using the DEFINE_SECURITY_ACCESS_LIST verb). This 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.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION AP_YES A user ID and password are required to start the TP. AP_NO No security information is required. 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.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION AP_NO TP cannot be attached. tp_def_detail.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_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.
NOF API Verbs (QUERY Verbs) QUERY_TP_DEFINITION 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_TP_NAME The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from 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.
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 AP_UINT16 ltv_length; } TP_LOAD_INFO_DEF_DATA; /* 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 overlay structure returned, and should not rely on the use of the sizeof() function.
NOF API Verbs (QUERY Verbs) QUERY_TP_LOAD_INFO 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 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_TP_LOAD_INFO def_data.type Indicates the TP type. Possible values are: AP_TP_QUEUED 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 cleared, and tracing continues to the second file. When this file then reaches the size specified by trace_file_size, the first file is cleared, and tracing continues to the first file. This ensures that tracing can continue for long periods without using excessive disk 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.
NOF API Verbs (QUERY Verbs) QUERY_TRACE_FILE 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_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.
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 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 unsigned char } USERID_PASSWORD_CHARS; profiles[10][10]; /* 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 structure returned, and should not rely on the use of the sizeof()function.
NOF API Verbs (QUERY Verbs) QUERY_USERID_PASSWORD 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 Chapter 5 NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) 1011
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 VCB Structure typedef struct 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 sun
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 The application issued REGISTER_INDICATION_SINK using the synchronous NOF entry point. This verb must use the asynchronous entry point. 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) 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 Modify tracing for the port named in resource_name and its implicit LSs. resource_name The name of the DLC, port, or LS, for which tracing is being removed or modified. This parameter is reserved 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) REMOVE_DLC_TRACE (this message type is currently not used) AP_TRACE_NC (this message type is currently not used) 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 AP_INVALID_LFSID_SPECIFIED The LS named in resource_name does not have any tracing options set for the specified LFSID. AP_INVALID_FILTER_TYPE The message_type parameter specified a message type 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.
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 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. 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT The local LU is responsible for deactivating sessions. AP_TARGET 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT Session limits will not be set to zero if CNOS negotiation fails. Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Possible values are: AP_FORCED The session limits were set to zero even though CNOS negotiation failed.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT 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_MODE_NAME_SELECT 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT 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 RESET_SESSION_LIMIT to specify the limits. 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 (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) RESET_SESSION_LIMIT 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. primary_rc AP_CNOS_PARTNER_LU_REJECT The verb failed because SNAplus2 failed to negotiate the session limits with the partner. Check configuration at both the local LU and partner LU.
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 Tracing is being changed. The trace_flags parameter defines the interfaces where tracing is being activated or deactivated; other interfaces will not be affected. set_flags If init_flags is set to AP_NO, this parameter specifies whether tracing is to be activated or deactivated at the requested interfaces. Possible values are: AP_YES Tracing is to be activated at the interfaces specified by the trace_flags parameter.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_BCK_CS_TRACE 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_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 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 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 (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 Leave exception logging unchanged from the existing 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 server acting as the central logger; this setting may 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; 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_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 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following 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 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 a full path or the path relative to the default directory. If you include the path, ensure that it is a valid path (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). To continue logging to the file specified on a previous SET_LOG_FILE verb, specify a null string.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_FILE has been issued, is 1,000,000 bytes. A value of zero indicates “continue using the existing file size” and not “no limit”. You may need to increase the size of the log files 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 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 (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 } SET_LOG_TYPE; succinct_audits; succinct_errors; /* 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_LOG_TYPE, or to revert to using these defaults.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE AP_LEAVE_UNCHANGED 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 AP_LEAVE_UNCHANGED Leave succinct logging or full logging unchanged from the existing definition.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_LOG_TYPE 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_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 Read-only mode: the application will use only 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 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_PROC_MODE The mode parameter was not set to a valid value. AP_INVALID_TARGET_MODE The mode parameter was not valid for the selected target.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_PROCESSING_MODE verbs for the target handle must be completed before attempting to change the processing mode. AP_NOT_MASTER The processing mode cannot be changed to AP_MODE_READ_WRITE or AP_MODE_COMMIT because the target handle specifies a file (either the domain configuration file or the SNA network data file) on a backup server that is no longer acting as the master server.
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 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 maximum space required is approximately twice the value of trace_file_size. AP_NO Tracing is to one file. AP_LEAVE_UNCHANGED Leave the dual_files setting unchanged from the 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero). file_name_2 Name of the second trace file; this parameter is used only if dual_files is set to AP_YES. To continue using the file name specified on a previous set_trace_file verb, set this parameter to a null string.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) SET_TRACE_FILE 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 (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 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 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 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. 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 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. 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.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_INTERNAL_PU AP_INVALID_BKUP_DLUS_NAME 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 AP_DLUS_REJECTED The DLUS rejected the session activation request. AP_DLUS_CAPS_MISMATCH The configured DLUS name was not a DLUS node. AP_PU_FAILED_ACTPU 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 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following 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 Possible values are: AP_ACTIVATION_LIMITS_REACHED The activation limits have been reached.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS LS activation will be retried (up to the number of attempts specified by react_timer_retry). AP_NO LS activation will not be retried. 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 (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) START_LS 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) 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 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 Returned Parameters: Cancelled If the verb does not execute because it has been cancelled, SNAplus2 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.
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 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_STOP_TYPE The stop_type parameter was not set to a valid value.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_INTERNAL_PU The node does not support DLUR; this is defined by the dlur_supported parameter on DEFINE_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 (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 ls_name Name of LS to be stopped. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes, which must already have been 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 The specified LS is already in the process of being deactivated. 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 (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 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_PORT_NAME The port_name parameter did not match the name of a defined po
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) STOP_PORT Returned Parameters: Cancelled If the verb does not execute because it has been cancelled, SNAplus2 returns the following parameters: primary_rc AP_CANCELLED 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.
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 Deactivate all LSs associated with the node before stopping. 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 The opcode parameter of the indication that is no longer required.
NOF API Verbs (REGISTER_INDICATION_SINK to UNREGISTER_INDICATION_SINK) UNREGISTER_INDICATION_SINK 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) UNREGISTER_INDICATION_SINK 1104 Chapter 5
6 Chapter 6 NOF Indications 1105
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 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. 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 entry_type Specifies the type of the directory entry. This is one of the following: AP_HOME 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.
NOF Indications DLC_INDICATION DLC_INDICATION This indication is generated when a DLC changes state between active and inactive.
NOF Indications DLC_INDICATION No previous DLC indications were lost. 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. Chapter 6 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. Chapter 6 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 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 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.
NOF Indications DLUR_PU_INDICATION PU identifier defined in a DEFINE_INTERNAL_PU verb or obtained in an XID from a downstream PU. This value is a 4-byte hexadecimal string. Bits 0-11 are set to the Block number and bits 12-31 are set to the ID number that uniquely identifies the PU. pu_location 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.
NOF Indications DLUR_PU_INDICATION Having forwarded a DACTPU to the PU, DLUR is now 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. dlus_name Name of the dependent LU server (DLUS) node that the PU is currently using (or attempting to use). The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
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 Number of RSP(REQACTPU)s received from DLUS 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 char unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; reserve; /* /* /* /* /* /* /* 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 AP_DOWNSTREAM_LU_INDICATION primary_rc AP_OK da
NOF Indications DOWNSTREAM_LU_INDICATION 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 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 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. (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 } SESSION_STATS; ls_name[8]; reserve; /* 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 pu_sscp_stats.cur_send_pac_win 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.
NOF Indications DOWNSTREAM_PU_INDICATION 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.
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_BACKUP_FP 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 unsigned char unsigned char unsigned char unsigned char } SESSION_STATS; sidl; odai; ls_name[8]; pacing_type /* 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 are valid only when both the nau_address parameter is set to a nonzero value and the lu_sscp_active parameter is set to AP_YES.
NOF Indications LOCAL_LU_INDICATION 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 significant only if the nau_address parameter is not set to 0 (zero). If the nau_address parameter is set to 0, the pu_name parameter is set to all binary zeros. 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.
NOF Indications LOCAL_LU_INDICATION Number of normal flow data frames sent. lu_sscp_stats.send_fmd_data_frames Number of normal flow function management data (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.
NOF Indications LOCAL_LU_INDICATION sscp_id The identifier of the SSCP as received in the ACTPU for the PU used by this LU. This parameter is 6 bytes 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 } LS_STATS; echo_rsps; current_delay; max_delay; min_delay; max_delay_time; good_xids; bad_xids; /* /* /* /* /* /* /* reserved reserved reserved reserved reserved successful XID on LS count unsuccessful XID on LS count */ */ */ */ */ */ */ Parameters opcode AP_LS_INDICATION primary_rc AP_OK data_lost Specifies whether any previous LS indications have been lost.
NOF Indications LS_INDICATION 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_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 data bytes received on this link station. ls_stats.in_xid_frames 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.
NOF Indications LS_INDICATION Total number of unsuccessful XID exchanges that have occurred on this link station since it was started. tg_num 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 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_LU_0_TO_3_INDICATION primary_rc AP_OK data_lost Specifies whether any previous LU 0-3 indications have been lost.
NOF Indications LU_0_TO_3_INDICATION Name of the LU whose session status has changed. 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.
NOF Indications LU_0_TO_3_INDICATION host_attachment 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 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. send_fmd_data_frames Number of normal flow FMD data frames sent. send_data_bytes Number of normal flow data bytes sent.
NOF Indications LU_0_TO_3_INDICATION 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.
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 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. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. plu_alias Partner 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 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 NOF_STATUS_INDICATION If status is set to AP_LOCAL_ABENDED, this parameter is reserved.
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 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. removed This parameter is currently not used; a PLU indication is generated only when the LUs start to communicate, and not when they stop communicating.
NOF Indications PLU_INDICATION 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. 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 } SESSION_STATS; ls_name[8]; reserve; /* Link station name /* reserved */ */ Parameters opcode AP_PU_INDICATION primary_rc AP_OK data_lost Specifies whether any previous PU 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.
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 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_STATS; sidl; odai; ls_name[8]; pacing_type; /* /* /* /* /* /* /* /* /* /*
NOF Indications SESSION_INDICATION 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 of the mode 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. 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.
NOF Indications SESSION_INDICATION Maximum receive RU size. sess_stats.send_ru_size Maximum send RU size. 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.
NOF Indications SESSION_INDICATION Number of normal flow data bytes received. sess_stats.sidh Session ID high byte. 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.
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 1184 Chapter 6
A Appendix A Common Return Codes 1185
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 connection to the target file has been lost. AP_NODE_NOT_CONFIGURED The system has just been installed, and a DEFINE_NODE verb has not yet been issued (or the Motif or ascii administration tools have not yet been used to configure the node). You must do this before issuing any other verbs. AP_NOT_MASTER 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.
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 1194 Appendix A
Index Numerics 3270 emulation program diagnostics parameters, 160 user, 230, 505, 512, 687 A access list, conversation security, 375 ACTIVATE_SESSION, 117 activating a session, 117 ADD_BACKUP, 122 ADD_DLC_TRACE, 124 APING, 129 application scheduled mode, 98 APPN node, 54 asynchronous entry point, 89 callback routine, 95 overview, 92 audit log file, 723, 1046 B back-level support tracing, 530, 1029 backup server, 937 adding, 122 deleting, 409 C callback routine, 93, 95 requirements, 96 supplied to REGISTER_*
Index DELETE_CN, 412 DELETE_COS, 414 DELETE_CPIC_SIDE_INFO, 416 DELETE_DIRECTORY_ENTRY, 418 DELETE_DLC, 420 DELETE_DOWNSTREAM_LU, 422 DELETE_DOWNSTREAM_LU_RANGE, 424 DELETE_DSPU_TEMPLATE, 427 DELETE_EMULATOR_USER, 430 DELETE_FOCAL_POINT, 433 DELETE_INTERNAL_PU, 436 DELETE_LOCAL_LU, 438 DELETE_LS, 440 DELETE_LU_0_TO_3, 445 DELETE_LU_0_TO_3_RANGE, 447 DELETE_LU_LU_PASSWORD, 451 DELETE_LU_POOL, 453 DELETE_LU62_TIMEOUT, 442 DELETE_MODE, 455 DELETE_PARTNER_LU, 457 DELETE_PORT, 459 DELETE_RCF_ACCESS, 461 DELETE_
Index LOCAL_TOPOLOGY_INDICATION, 1144 log file, 723, 1046 log message type, 704, 726, 1040, 1051 log messages, central logging, 536, 538, 1034 LS defining, 258 querying, 730 starting, 1079 statistics, 943 stopping, 1093 LS_INDICATION, 1146 LU pool defining, 317 querying, 787 LU type 0 - 3, 301, 307 LU type 6.
Index detailed information, 113 list options, 111 returning information about multiple resources, 111 summary information, 113 QUERY_3270_DIAG, 500 QUERY_3270_USER, 505 QUERY_3270_USER_SESSIONS, 512 QUERY_ACTIVE_TRANSACTION, 518 QUERY_AVAILABLE_TP, 525 QUERY_BCK_CS_TRACE, 530 QUERY_BUFFER_AVAILABILITY, 532 QUERY_CENTRAL_LOGGER, 536 QUERY_CENTRAL_LOGGING, 538 QUERY_CN, 540 QUERY_CN_PORT, 547 QUERY_COS, 559 QUERY_COS_NODE_ROW, 564 QUERY_COS_TG_ROW, 571 QUERY_CPIC_SIDE_INFO, 581 QUERY_CS_TRACE, 588 QUERY_DEFAU
Index SET_PROCESSING_MODE, 106, 1056 SET_TN_SERVER_TRACE, 1060 SET_TRACE_FILE, 1062 SET_TRACE_TYPE, 1067 side information, CPI-C, 186, 581 signal-based scheduling mode, 99 signals (HP-UX), 100 sigpoll signal, 100 single-threaded applications, 98 sleep call (HP-UX), 100 SNA network file indication, 84 sna.
