HP-UX SNAplus2 R7 NOF Programmer’s Guide HP-UX 11i v1, 11i v2 and 11i v3 Edition: 4 Manufacturing Part Number: 5991–2748 April 2007 © 2007 Hewlett-Packard Development Company, L.P. All rights reserved.
Contents Legal Notices.............................................................................................................................................35 Warranty............................................................................................................................................35 U.S. Government License.. .............................................................................................................. 35 Copyright Notices.. ...................................
1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9 1.5.10 1.5.11 1.5.12 1.5.13 1.5.14 1.5.15 1.5.16 1.5.17 1.5.18 1.5.19 1.5.20 5250 Communications.................................................................................................52 RJE Communications..................................................................................................52 LUA Communications..................................................................................................53 APPC Communications......................
3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 iv Supplied Parameters.. .................................................................................................81 Returned Parameters: Successful Execution.. ........................................................... 82 Returned Parameters: Parameter Check....................................................................82 Returned Parameters: Activation Failure....................................................................
3.7.4 3.7.5 3.7.6 Returned Parameters: Parameter Check..................................................................100 Returned Parameters: State Check..........................................................................100 Returned Parameters: Other Conditions...................................................................100 3.8 DEACTIVATE_CONV_GROUP..............................................................................................100 3.8.1 VCB Structure.........................
3.14.1 3.14.2 3.14.3 3.14.4 3.14.5 3.14.6 vi VCB Structure..........................................................................................................115 Supplied Parameters...............................................................................................116 Returned Parameters: Successful Execution.. ....................................................... 120 Returned Parameters: Parameter Check................................................................
3.21.1 3.21.2 3.21.3 3.21.4 VCB Structure..........................................................................................................138 Supplied Parameters...............................................................................................139 Returned Parameters: Successful Execution.. ....................................................... 139 Returned Parameters: Other Conditions.................................................................139 3.22 DEFINE_DOWNSTREAM_LU.. ..
viii 3.27 DEFINE_INTERNAL_PU.....................................................................................................159 3.27.1 VCB Structure..........................................................................................................159 3.27.2 Supplied Parameters...............................................................................................159 3.27.3 Returned Parameters: Successful Execution.. ....................................................... 161 3.27.
3.32.6 Returned Parameters: Other Conditions.................................................................202 3.33 DEFINE_LU_0_TO_3_RANGE...........................................................................................203 3.33.1 VCB Structure..........................................................................................................203 3.33.2 Supplied Parameters...............................................................................................203 3.33.
3.39.2 3.39.3 3.39.4 3.39.5 3.39.6 3.39.7 x Supplied Parameters...............................................................................................234 Returned Parameters: Successful Execution.. ....................................................... 245 Returned Parameters: Parameter Check................................................................245 Returned Parameters: State Check........................................................................
3.46.1 3.46.2 3.46.3 3.46.4 3.46.5 VCB Structure..........................................................................................................261 Supplied Parameters...............................................................................................261 Returned Parameters: Successful Execution.. ....................................................... 262 Returned Parameters: Parameter Check................................................................
xii 3.53 DELETE_COS.....................................................................................................................276 3.53.1 VCB Structure..........................................................................................................276 3.53.2 Supplied Parameters...............................................................................................276 3.53.3 Returned Parameters: Successful Execution.. ....................................................... 277 3.
3.59.2 3.59.3 3.59.4 3.59.5 Supplied Parameters...............................................................................................286 Returned Parameters: Successful Execution.. ....................................................... 287 Returned Parameters: Parameter Check................................................................287 Returned Parameters: Other Conditions.................................................................287 3.60 DELETE_EMULATOR_USER........................
3.65.6 xiv Returned Parameters: Other Conditions.................................................................297 3.66 DELETE_LU62_TIMEOUT..................................................................................................297 3.66.1 VCB Structure..........................................................................................................297 3.66.2 Supplied Parameters...............................................................................................297 3.66.
3.72.4 3.72.5 Returned Parameters: Parameter Check................................................................307 Returned Parameters: Other Conditions.................................................................307 3.73 DELETE_PORT...................................................................................................................307 3.73.1 VCB Structure..........................................................................................................307 3.73.
3.79.4 3.79.5 xvi Returned Parameters: Parameter Check................................................................316 Returned Parameters: Other Conditions.................................................................316 3.80 DELETE_TP_LOAD_INFO..................................................................................................316 3.80.1 VCB Structure..........................................................................................................317 3.80.
3.86.1 3.86.2 3.86.3 3.86.4 3.86.5 3.86.6 3.86.7 3.86.8 3.86.9 VCB Structure..........................................................................................................329 Supplied Parameters...............................................................................................329 Returned Parameters: Successful Execution.. ....................................................... 329 Returned Parameters: Parameter Check................................................................
3.92.3 3.92.4 3.92.5 xviii Returned Parameters: Successful Execution.. ....................................................... 350 Returned Parameters: Parameter Check................................................................351 Returned Parameters: Other Conditions.................................................................351 3.93 QUERY_BCK_CS_TRACE.. ............................................................................................... 352 3.93.1 VCB Structure.....................
3.99.3 3.99.4 3.99.5 Returned Parameters: Successful Execution.. ....................................................... 367 Returned Parameters: Parameter Check................................................................369 Returned Parameters: Other Conditions.................................................................369 3.100 QUERY_COS....................................................................................................................369 3.100.1 VCB Structure...................
3.106.3 3.106.4 3.106.5 Returned Parameters: Successful Execution.. ..................................................... 390 Returned Parameters: Node Not Started.. ........................................................... 390 Returned Parameters: Other Conditions...............................................................390 3.107 QUERY_DIRECTORY_ENTRY.. ....................................................................................... 391 3.107.1 VCB Structure.................................
3.113.5 3.113.6 Returned Parameters: Function Not Supported.. .................................................420 Returned Parameters: Other Conditions...............................................................420 3.114 QUERY_DLUR_PU.. ......................................................................................................... 421 3.114.1 VCB Structure........................................................................................................421 3.114.2 Supplied Parameters...
3.120.1 3.120.2 3.120.3 3.120.4 3.120.5 VCB Structure........................................................................................................450 Supplied Parameters.............................................................................................452 Returned Parameters: Successful Execution.. ..................................................... 453 Returned Parameters: Parameter Check..............................................................
3.127.1 3.127.2 3.127.3 3.127.4 3.127.5 VCB Structure........................................................................................................485 Supplied Parameters.............................................................................................485 Returned Parameters: Successful Execution.. ..................................................... 486 Returned Parameters: Parameter Check..............................................................
3.134.3 3.134.4 3.134.5 Returned Parameters: Successful Execution.. ..................................................... 537 Returned Parameters: Parameter Check..............................................................537 Returned Parameters: Other Conditions...............................................................538 3.135 QUERY_MDS_APPLICATION.. ........................................................................................ 538 3.135.1 VCB Structure..................................
3.141.3 3.141.4 3.141.5 3.141.6 Returned Returned Returned Returned Parameters: Parameters: Parameters: Parameters: Successful Execution.. ..................................................... 562 Parameter Check..............................................................564 Function Not Supported.. .................................................565 Other Conditions...............................................................565 3.142 QUERY_NN_TOPOLOGY_STATS........................................
3.148.4 3.148.5 Returned Parameters: Parameter Check..............................................................607 Returned Parameters: Other Conditions...............................................................608 3.149 QUERY_PORT.. ................................................................................................................ 608 3.149.1 VCB Structure........................................................................................................608 3.149.
3.156 QUERY_SECURITY_ACCESS_LIST................................................................................641 3.156.1 VCB Structure........................................................................................................641 3.156.2 Supplied Parameters.............................................................................................642 3.156.3 Returned Parameters: Successful Execution.. ..................................................... 643 3.156.
3.163 QUERY_TN_SERVER_TRACE.. ...................................................................................... 678 3.163.1 VCB Structure........................................................................................................678 3.163.2 Supplied Parameters.............................................................................................678 3.163.3 Returned Parameters: Successful Execution.. ..................................................... 678 3.163.
3.170.3 3.170.4 3.170.5 3.170.6 Returned Returned Returned Returned Parameters: Parameters: Parameters: Parameters: Successful Execution.. ..................................................... 698 Parameter Check..............................................................698 Function Not Supported.. .................................................699 Other Conditions...............................................................699 3.171 REMOVE_DLC_TRACE...............................................
3.177.1 3.177.2 3.177.3 3.177.4 3.177.5 VCB Structure........................................................................................................714 Supplied Parameters.............................................................................................715 Returned Parameters: Successful Execution.. ..................................................... 716 Returned Parameters: Parameter Check..............................................................
3.184.3 3.184.4 3.184.5 3.184.6 Returned Parameters: Successful Execution.. ..................................................... 731 Returned Parameters: Parameter Check..............................................................731 Returned Parameters: Other Conditions...............................................................732 Trace Types............................................................................................................732 3.185 START_DLC................................
3.189.7 Returned Parameters: Other Conditions...............................................................743 3.190 STOP_INTERNAL_PU......................................................................................................743 3.190.1 VCB Structure........................................................................................................744 3.190.2 Supplied Parameters.............................................................................................744 3.190.
4.3 DLC_INDICATION.................................................................................................................757 4.3.1 VCB Structure............................................................................................................757 4.3.2 Parameters.. .............................................................................................................. 757 4.4 DLUR_LU_INDICATION.......................................................................................
4.17 NN_TOPOLOGY_TG_INDICATION....................................................................................791 4.17.1 VCB Structure..........................................................................................................791 4.17.2 Parameters.. ............................................................................................................ 791 4.18 NOF_STATUS_INDICATION............................................................................................... 793 4.
Legal Notices Trademark Notices 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.
Publishing History New and Changed Information in This Edition Publishing History The manual publishing date and part number indicate its current edition. The publishing date will change when a new edition is printed. Minor changes may be made without changing the publishing date. The manual part number will change when extensive changes are made. Manual updates may be issued between editions to correct errors or document product changes.
Before You Begin About This Book Before You Begin HP-UX SNAplus2 NOF Programmer’s 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 manual provides detailed reference information for experienced NOF programmers.
Before You Begin About This Book • Appendix A, Return Code Values, lists all the possible return codes in the NOF interface in numerical order and gives their meanings. • Appendix B, Common Return Codes, provides information about return codes that are common to all the NOF verbs. Typographic Conventions Table 1, Typographic Conventions shows the typographic styles used in this document.
Before You Begin SNAplus2 Publications This symbol is used to indicate the start of a section of text that applies to the Windows client, which runs on Microsoft Windows 2000, Windows XP, or Windows Server 2003. The APIs for Windows clients are fully compatible with Microsoft SNA Server and Windows Open System Architecture (WOSA), enabling applications written for SNA Server to run unchanged on Windows clients. This symbol indicates the end of a section of operating system specific text.
Before You Begin SNAplus2 Publications Explains how to install the SNAplus2 software and set up system files. HP-UX SNAplus2 Migration 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.
Before You Begin Related Publications 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.
Introduction to the NOF API Purpose of the NOF API 1 Introduction to the NOF API This chapter provides an introduction to the SNAplus2 NOF API. It includes the following information: • Purpose of the NOF API • SNAplus2 components and resources • Client-server operation • NOF verbs and indications 1.1 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 SNAplus2 Components 1.1.1 Node Configuration File Configuration information for each SNAplus2 node is held in a text file on the computer where the node runs. This file includes information about the node’s resources, and specifies which resources will be active when SNAplus2 is started.
Introduction to the NOF API SNAplus2 Resources Figure 1–1 SNAplus2 Components HLLAPI Application 3270 emulation program LUA Application APPC Application CPI-C Application RCF User space Kernel Local node LU Services LU 0 LU 6.2 LU 1,2,3 SDLC Token Ring Communications with host and peer computers 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.
Introduction to the NOF API SNAplus2 Resources • LUs • • Type 0–3 for: • 3270 • RJE • LUA communications Type 6.2 for: • APPC • CPI-C communications • 5250 emulation • Modes and classes of service • Directory information Domain resources Additional resources not defined as part of the node, which are used to support particular user programs.
Introduction to the NOF API SNAplus2 Resources Figure 1–2 PU Concentration Facilities Provided by SNAplus2 Host Controller SNA Node Providing PU Concentration Downstream Computers 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.
Introduction to the NOF API SNAplus2 Resources Figure 1–3 SNAplus2 TN Server TN Server Configuration Host View of the Configuration Host TN3270 Program View of the Configuration Host SNA Node Running TN Server SNA Node Host TCP/IP Network TCP/IP Network SNA Nodes Running 3270 Emulators Clients Running TN3270 and TN3270E Programs Clients Running TN3270 and TN3270E Programs The SNAplus2 TN server feature provides an association between a TN3270 user and SNAplus2 3270 LU.
Introduction to the NOF API Client-Server Operation 1.4 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 are HP-UX computers; clients can be running HP-UX or Windows.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions highest backup server available in either of the two domains if the master is inactive at this point) will become the domain configuration file across the LAN; this will overwrite any changes made to the domain configuration file in the other domain while the network was split. Because of this, do not attempt to make any changes to the domain configuration file in either of the two domains while the LAN connection is broken.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • SET_PROCESSING_MODE To register for indications when the target configuration changes, use the following verb: • REGISTER_INDICATION_SINK To unregister when indications are no longer required, use the following verb: • UNREGISTER_INDICATION_SINK To release the target node or file when you have finished issuing NOF verbs, use one of the following verbs: • DISCONNECT_NODE, CLOSE_FILE You can issue OPEN_FILE, CONNECT_NODE, D
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • QUERY_CN, QUERY_CN_PORT To delete a CN when it is no longer required, or to remove ports from a CN without deleting the CN, use the following verb: • DELETE_CN To stop the node, which deactivates all resources associated with it, use the following verb: • TERM_NODE To define default parameters used by the node, or to query the definition of these parameters, use the following verbs: • DEFINE_DEFAULTS, QUERY_DEFAULTS To qu
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions 1.5.4 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 Section 1.5.2, 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 1.5.6 LUA Communications If applications running on SNAplus2 will be using LUA to communicate with host programs, you need to define the communications link to the host. For more information, see Section 1.5.2, Getting Started. The definition of the LS to the host must include the name of a local PU to own the LUs, and must have the solicit_sscp_sessions parameter set to AP_YES. You then need to define LUs that can be used for LUA.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions Because APPN can locate a partner LU dynamically when a local application needs to start a session to it, normally you do not need to define partner LUs. However, you may need to define partner LUs if you need to enforce the use of particular APPC features such as conversation security.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions need to specify it in the SNAplus2 invokable TP data file. For more information about this file, refer to the HP-UX SNAplus2 Administration Guide.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • DEFINE_DOWNSTREAM_LU, DEFINE_DOWNSTREAM_LU_RANGE To obtain information about the configuration or current status of downstream LUs or about the downstream PU that serves them, use the following verbs: • QUERY_DOWNSTREAM_LU, QUERY_DOWNSTREAM_PU To delete downstream LUs when they are no longer required, use the following verbs: • DELETE_DOWNSTREAM_LU, DELETE_DOWNSTREAM_LU_RANGE 1.5.
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 optionally group these LUs into LU pools. For more information about defining LUs and pools, see Section 1.5.3, 3270 Communications.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To define these permissions and enable NetView operators to access SPCF or UCF or both, use the following verb: • DEFINE_RCF_ACCESS To check the permissions currently defined, use the following verb: • QUERY_RCF_ACCESS To prevent operators from using either SPCF or UCF, use the following verb: • DELETE_RCF_ACCESS To remove access to one function but leave the other available, use the following verb: • DEFINE_RCF_ACCESS 1.5.
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions • ADD_DLC_TRACE, REMOVE_DLC_TRACE If you want to activate tracing to diagnose problems with other SNAplus2 kernel components or to deactivate it after collecting the required data, use the following verb: • 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: • S
Introduction to the NOF API NOF Verbs to Manage Specific SNAplus2 Functions To delete a node and the LUs associated with it or to delete LUs from a node entry, use the following verb: • DELETE_ADJACENT_LEN_NODE If the local node is an end node or network node communicating with a LEN node, or if the local node is the network node serving a LEN node, you need to set up directory entries for the LEN node and its LUs, using the verbs described above.
Introduction to the NOF API NOF Indications • 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 1.5.
Introduction to the NOF API NOF Indications For more information about registering to receive indications, see Section 3.170, REGISTER_INDICATION_SINK. For more information about individual indications, see Chapter 4, NOF Indications. 1.6.1 Configuration Indications An application can register to receive information about changes to the configuration of a particular target (the domain configuration file, a running node, or an inactive node).
Writing NOF Applications HP-UX Considerations 2 Writing NOF Applications This chapter describes the following: UNIX • HP-UX considerations • NOF API entry points for HP-UX • Compiling and linking the NOF application WINDOWS • Windows considerations • NOF API entry points for Windows • Compiling and linking the NOF application • Writing portable applications • Target (node or file) for NOF verbs, and how they interact with the target • Ordering and dependencies between NOF verbs • NOF res
Writing NOF Applications HP-UX Considerations results of the verb processing. In cases when SNAplus2 is able to completely process the request, the callback routine will not be invoked. All NOF verbs can be issued through this entry point. The REGISTER_INDICATION_SINK and UNREGISTER_INDICATION_SINK verbs must be issued through this entry point. An application must use this entry point if either of the following conditions is true: • The application needs to receive NOF indications.
Writing NOF Applications HP-UX Considerations Note The NOF VCBs contain many parameters marked as “reserved”; some of these are used internally by the SNAplus2 software, and others are not used in this version but may be used in future versions. Your application must not attempt to access any of these reserved parameters; instead, it must set the entire contents of the VCB to zero to ensure that all of these parameters are zero, before it sets other parameters that are used by the verb.
Writing NOF Applications HP-UX Considerations For more information about the parameters in the NOF_CALLBACK structure, see Section 2.1.1, NOF API Entry Points for HP-UX. Supplied Parameters An application supplies the following parameters when it uses the nof_async entry point: target_handle This parameter is supplied in one of the following ways: • • • For the following verbs, this parameter is not used; set it to 0 (zero).
Writing NOF Applications HP-UX Considerations Returned Values The asynchronous entry point returns one of the following values: AP_COMPLETED 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.
Writing NOF Applications Windows Considerations target_handle For NOF indications, SNAplus2 passes the target handle that was supplied with the REGISTER_INDICATION_SINK verb. For completion of verbs, this parameter is undefined. nofvcb One of the following: • For NOF indications, a pointer to a VCB supplied by SNAplus2. • For completion of verbs, a pointer to the VCB supplied by the application. The VCB now includes the returned parameters set by SNAplus2.
Writing NOF Applications Windows Considerations This section describes operating system issues that you need to consider when writing NOF applications for use on Windows clients. 2.2.1 NOF API Entry Points for Windows A Windows NOF 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.
Writing NOF Applications Windows Considerations • • QUERY_CENTRAL_LOGGER For all other NOF verbs, the application supplies the value that was returned on the CONNECT_NODE or OPEN_FILE verb. nofvcb Pointer to a Verb Control Block (VCB) that contains the parameters for the verb being issued. The VCB structure for each verb is described in Chapter 3, NOF API Verbs. These structures are defined in the NOF API header file nof_c.h.
Writing NOF Applications Windows Considerations AP_CORR AP_UINT32 ); typedef union ap_corr corr indic_length { void * AP_UINT32 AP_INT32 } AP_CORR; corr_p; corr_l; corr_i; For more information about the parameters in the NOF_CALLBACK structure, see Section 2.2.1, NOF API Entry Points for Windows.
Writing NOF Applications Windows Considerations The callback routine that SNAplus2 will call when the verb completes. For more information about the requirements for a callback routine, see Section 2.2.1, NOF API Entry Points for Windows. corr An optional correlator for use by the application. This parameter is defined as a C union so that the application can specify any of three different parameter types: pointer, 32–bit integer, or 16–bit integer.
Writing NOF Applications Windows Considerations } AP_CORR; Supplied Parameters SNAplus2 calls the callback routine with the following parameters: target_handle This parameter is undefined. nofvcb A a pointer to the VCB supplied by the application. The VCB now includes the returned parameters set by SNAplus2. corr The correlator value supplied by the application. This value enables the application to correlate the returned information with its other processing.
Writing NOF Applications Target For NOF Verbs 2.3 Writing Portable Applications The following guidelines are provided for writing SNAplus2 NOF applications so that they will be portable to other environments: • Include the NOF header file without any path name prefix. This enables the application to be used in an environment with a different file system. Use include options on the compiler to locate the file (see Section 2.1.2, Compiling and Linking the NOF Application or Section 2.2.
Writing NOF Applications Target For NOF Verbs • 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. Verbs that return only status information cannot be issued to an inactive node, and verbs that return both definition and status will return only definition information when issued to an inactive node.
Writing NOF Applications NOF Restrictions Based on Node Configuration 2.5 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 The following NOF verbs are only valid at a network node or branch network node; the primary return code AP_FUNCTION_NOT_SUPPORTED is returned if you attempt to issue them at an end node or LEN node.
Writing NOF Applications List Options For QUERY_* Verbs 2.7 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 These options enable the application to manage the information it receives, as follows: • To obtain a specific entry, it sets the index value to the name of that entry, list_options to indicate “start from the named entry”, buf_size to at least the size of a single entry, and num_entries to 1.
NOF API Verbs ACTIVATE_SESSION 3 NOF API Verbs This chapter provides the following information for each NOF API verb: • Description of the verb’s purpose and usage • Whether the verb can be issued to an active node, an inactive node, the domain configuration file, or the SNA network data file (unless otherwise stated, verbs may be issued either to an active node or to an inactive node) • Verb control block (VCB) structure, as defined in the NOF API header file nof_c.
NOF API Verbs ACTIVATE_SESSION 3.1.
NOF API Verbs ACTIVATE_SESSION The polarity for the session. Possible values are: AP_POL_EITHER AP_POL_FIRST_SPEAKER AP_POL_BIDDER If AP_POL_EITHER is set, ACTIVATE_SESSION activates a first speaker session if available, otherwise a bidder session is activated. If AP_POL_FIRST_SPEAKER or AP_POL_BIDDER is set, ACTIVATE_SESSION only succeeds if a session of the requested polarity is available. cnos_permitted Indicates that CNOS processing is permitted.
NOF API Verbs ADD_BACKUP AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias. AP_INVALID_LU_NAME The lu_name parameter did not match any defined local LU name. AP_INVALID_PLU_NAME The fqplu_name parameter did not match any defined partner LU name, or the plu_alias parameter did not match any defined partner LU name. AP_INVALID_CNOS_PERMITTED The value specified in the cnos_permitted parameter was not valid.
NOF API Verbs ADD_BACKUP unsigned char AP_UINT16 AP_UINT32 unsigned char unsigned char } ADD_BACKUP; format; primary_rc; secondary_rc; backup_name[128]; reserv3[4]; /* /* /* /* /* reserved primary return code secondary return code name of backup server to add reserved */ */ */ */ */ 3.2.2 Supplied Parameters The application supplies the following parameters: opcode AP_ADD_BACKUP backup_name The name of the server being added to the list of backup servers. If the server name includes a .
NOF API Verbs ADD_DLC_TRACE 3.3 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, LS, or HPR RTP connection, 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, link stations, and HPR RTP connections. For more information about how to use SNAplus2 tracing, see the HP-UX SNAplus2 Administration Guide.
NOF API Verbs ADD_DLC_TRACE 3.3.2 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. Possible values are: AP_ALL_RESOURCES Set up tracing options for all DLCs, ports, link stations, and HPR RTP connections. AP_DLC Set up tracing options for the DLC named in resource_name, and for all ports and LSs that use this DLC.
NOF API Verbs ADD_DLC_TRACE filter.message_type The type of messages to trace for the specified resource or session.
NOF API Verbs APING AP_INVALID_MESSAGE_TYPE The message_type parameter specified a value that was not valid. INVALID_RTP_CONNECTION The resource_name parameter does not match any RTP connection. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.3.
NOF API Verbs APING unsigned char AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 } APING; echo; iterations; alloc_time; min_time; avg_time; max_time; partner_ver_len; /* /* /* /* /* /* /* data echo flag number of iterations time taken for ALLOCATE minimum send/receive time average send/receive time maximum send/receive time size of string to receive */ */ */ */ */ */ */ 3.4.
NOF API Verbs APING A password and user ID are required to start the TP, but the password must not be sent in clear text. If password substitution is not supported on the session, the aping fails. Otherwise, the password is sent encrypted. pwd Password required to access the partner TP; this parameter is required only if the security parameter is set to AP_PGM. This is a 10-byte type-AE EBCDIC character string, padded on the right with EBCDIC spaces if the password is shorter than 10 bytes.
NOF API Verbs APING primary_rc AP_OK alloc_time 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 APING 3.4.5 Returned Parameters: Allocation Failure If the verb does not execute because SNAplus2 cannot allocate the APPC conversation, SNAplus2 returns the following parameters: primary_rc AP_ALLOCATION_ERROR secondary_rc Possible values are: AP_ALLOCATION_FAILURE_NO_RETRY The conversation cannot be allocated because of a permanent condition, such as a configuration error or session protocol error. Check the sense_data parameter and the error log file for more information.
NOF API Verbs CHANGE_SESSION_LIMIT primary_rc AP_DEALLOC_ABEND The partner TP deallocated the conversation because of an error condition. The reason for the error may be logged on the remote node. 3.4.7 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs CHANGE_SESSION_LIMIT AP_CHANGE_SESSION_LIMIT lu_name LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is defined by its LU alias instead of its LU name, set this parameter to 8 binary zeros. lu_alias LU alias of the local LU, as defined to SNAplus2.
NOF API Verbs CHANGE_SESSION_LIMIT Minimum number of sessions using this mode for which the partner LU is the contention winner. Specify a value in the range 0–32,767. The sum of the min_conwinners_source and min_conwinners_target parameters must not exceed the plu_mode_session_limit parameter. auto_act Number of sessions to automatically activate after the session limit is changed.
NOF API Verbs CHANGE_SESSION_LIMIT AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias. AP_INVALID_LU_NAME The lu_name parameter did not match any defined local LU name. AP_INVALID_MODE_NAME The mode_name parameter did not match any defined mode name. AP_INVALID_PLU_NAME The fqplu_name parameter did not match any defined partner LU name. AP_INVALID_RESPONSIBLE The responsible parameter was not set to a valid value.
NOF API Verbs CLOSE_FILE 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 CONNECT_NODE 3.6.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. 3.6.4 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.
NOF API Verbs CONNECT_NODE 3.7.2 Supplied Parameters The application supplies the following parameters: opcode AP_CONNECT_NODE node_type To connect to a particular node in order to manage the node’s configuration, set this parameter to AP_SPECIFIED_NODE. To connect to the node currently acting as the central logger, set this parameter to AP_CENTRAL_LOGGER.
NOF API Verbs DEACTIVATE_CONV_GROUP 3.7.4 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. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.7.
NOF API Verbs DEACTIVATE_CONV_GROUP AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char lu_name[8]; unsigned char lu_alias[8]; AP_UINT32 conv_group_id; unsigned char type; unsigned char reserv3[3]; AP_UINT32 sense_data; } DEACTIVATE_CONV_GROUP; /* /* /* /* /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code local LU name local LU alias conversation group identifier deactivation type res
NOF API Verbs DEACTIVATE_LU_0_TO_3 3.8.4 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_DEACT_CG_INVALID_CGID 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.
NOF API Verbs DEACTIVATE_SESSION opcode AP_DEACTIVATE_LU_0_TO_3 lu_name LU name of the 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. 3.9.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters. This return code can also indicate that there was no active session for the specified LU (implying that the session has already been deactivated).
NOF API Verbs DEACTIVATE_SESSION AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT32 unsigned char unsigned char } DEACTIVATE_SESSION; secondary_rc; lu_name[8]; lu_alias[8]; session_id[8]; plu_alias[8]; mode_name[8]; type; reserv3[3]; sense_data; fqplu_name[17]; reserv4[20]; /* /* /* /* /* /* /* /* /* /* /* /* secondary return code local LU name local LU alias session identifier partner LU alias mode name deactivation type reserved deacti
NOF API Verbs DEACTIVATE_SESSION Do not deactivate the session until all conversations using the session have ended. sense_data If type is set to AP_DEACT_CLEANUP, this parameter specifies the sense data to be used when deactivating the session. Otherwise this parameter is not used. fqplu_name Fully qualified LU name for the partner LU, as defined to SNAplus2. This parameter is used only if the plu_alias field is set to zeros; it is ignored if plu_alias is specified.
NOF API Verbs DEFINE_3270_DIAG 3.11 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. 3.11.
NOF API Verbs DEFINE_3270_DIAG def_data.rtm_overflow Specifies whether to send RTM data to the host every time one of the RTM counters overflows (reaches its maximum value). There is a counter for each of the intervals defined by the rtm_thresh values below. Possible values are: AP_YES Send RTM data to the host each time a counter overflows. AP_NO Do not send RTM data to the host at counter overflow. RTM data may be lost when a counter overflows. def_data.
NOF API Verbs DEFINE_ADJACENT_LEN_NODE For each alert, up to the number specified in num_alerts, an alert_3270_data structure is required with the following information: alert_3270_data.description A text description of the alert. This is an ASCII string of 1–52 characters, followed by a null character. This description is displayed in the 3270 user interface, to identify the alert to the user. It is not sent to NetView; the NetView operator identifies the alert by its number. alert_3270_data.
NOF API Verbs DEFINE_ADJACENT_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. To query the directory entries created by this verb, use QUERY_DIRECTORY_ENTRY. If this verb is issued to the network node acting as the server for the LEN node, the LEN node’s resources are added to the network node’s directory database.
NOF API Verbs DEFINE_ADJACENT_LEN_NODE The specified LU names are wildcard entries. AP_NO The specified LU names are explicit entries. lu_names The names of the LUs being defined on the LEN node. Each name is an 8-byte type-A EBCDIC character string, right-padded with EBCDIC spaces, corresponding to the second part of the fully qualified LU name (the first part of the fully qualified name is defined by the cp_name parameter above).
NOF API Verbs DEFINE_CN secondary_rc Possible values are: AP_INVALID_CP_NAME The specified CP name is already defined in a directory entry, and is not a LEN node. AP_INVALID_LU_NAME One or more of the specified LU names was already defined on a different parent node. 3.12.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs DEFINE_CN unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } TG_DEFINED_CHARS; effect_cap; reserve1[5]; connect_cost; byte_cost; reserve2; security; prop_delay; modem_class; user_def_parm_1; user_def_parm_2; user_def_parm_3; /* /* /* /* /* /* /* /* /* /* /* effective capacity reserved connection cost byte cost reserved security propagation delay reserved user-defined parameter 1 user-de
NOF API Verbs DEFINE_CN 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 DEFINE_CN primary_rc AP_OK 3.13.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_DEF_LINK_INVALID_SECURITY The security parameter was not set to one of the valid values. AP_EXCEEDS_MAX_ALLOWED Adding the specified number of ports would exceed the maximum total number of ports on a CN.
NOF API Verbs DEFINE_COS AP_FUNCTION_NOT_SUPPORTED The local node is a LEN node. This verb is valid only at a network node or an end node. 3.13.7 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.14 DEFINE_COS DEFINE_COS adds a class of service definition or modifies a previously defined COS.
NOF API Verbs DEFINE_COS unsigned char unsigned char unsigned char unsigned char unsigned char } TG_DEFINED_CHARS; 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 weight; unsigned char reserv1; } COS_NODE_ROW; typedef struct cos_node_status { unsigned char rar; unsigned char status; unsigned char reserv1[2]; } COS_NODE_STATUS; /* /* /* /* /* propagation delay reserved user defined
NOF API Verbs DEFINE_COS maximum characteristics defined for each TG row. The TG is then assigned the weight of the first TG row which bounds all the TG’s characteristics within the limits specified. If the TG characteristics do not satisfy any of the listed TG rows, the TG is considered unsuitable for this COS, and is assigned an infinite weight. The TG rows must be concatenated in ascending order of weight. cos_tg_row.minimum.effect_cap Minimum limit for actual bits per second rate (line speed).
NOF API Verbs DEFINE_COS AP_PROP_DELAY_PKT_SWITCHED_NET Delay is in the range 49,512–245,760 microseconds (typical for a packet-switched network). AP_PROP_DELAY_SATELLITE Delay is greater than 245,760 microseconds (typical for a satellite link). AP_PROP_DELAY_MAXIMUM Maximum propagation delay. cos_tg_row.minimum.user_def_parm_1 through cos_tg_row.user_def_parm_3 Minimum values for user-defined parameters, which you can use to include other TG characteristics not covered by the above parameters.
NOF API Verbs 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 DEFINE_COS The number of ISR sessions exceeds the threshold value. cos_node_row.weight Weight associated with this node row. 3.14.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.14.
NOF API Verbs DEFINE_CPIC_SIDE_INFO 3.14.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.15 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.
NOF API Verbs DEFINE_CPIC_SIDE_INFO } CPIC_SIDE_INFO; 3.15.2 Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_CPIC_SIDE_INFO sym_dest_name Symbolic destination name which identifies the side information entry. This is an 8-byte ASCII string, padded on the right with spaces if necessary. The name can contain any displayable character. def_data.
NOF API Verbs DEFINE_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 can be used only if the remote system supports password substitution. XC_SECURITY_SAME The target TP uses conversation security, and can accept an “already verified” indicator from the local TP.
NOF API Verbs DEFINE_DEFAULT_PU 3.16 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. This verb also enables the user to delete the default PU, by specifying a null PU name.
NOF API Verbs DEFINE_DEFAULTS 3.16.4 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.17 DEFINE_DEFAULTS DEFINE_DEFAULTS specifies default parameters used by the node. 3.17.
NOF API Verbs DEFINE_DEFAULTS default_chars.implicit_plu_forbidden Specifies whether SNAplus2 puts implicit definitions in place for unknown partner LUs. Possible values are: AP_YES SNAplus2 does not put implicit definitions in place for unknown partner LUs. All partner LUs must be defined explicitly. AP_NO SNAplus2 puts implicit definitions in place for unknown partner LUs. default_chars.
NOF API Verbs DEFINE_DIRECTORY_ENTRY 3.18 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. This allows you to define the node and its LUs with a single verb.
NOF API Verbs DEFINE_DIRECTORY_ENTRY AP_ENCP_RESOURCE End node or LEN node AP_NNCP_RESOURCE Network node AP_LU_RESOURCE LU AP_WILDCARD_LU_RESOURCE Wildcard LU name. For an LU or wildcard LU, the directory entry for the parent resource (the owning CP) must already be defined. description A null-terminated text string (0–31 characters followed by a null character) describing the directory entry.
NOF API Verbs DEFINE_DLC 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 DEFINE_DLC unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 unsigned char AP_UINT16 } DLC_DEF_DATA; description[32]; /* initially_active; /* reserv1[15]; /* dlc_type; /* neg_ls_supp; /* port_types; /* hpr_only; /* reserv3; /* retry_flags; /* max_activation_attempts; activation_delay_timer; reserv4[4]; dlc_spec_data_len; resource description is the DLC initially active? reserved DLC type negotiab
NOF API Verbs DEFINE_DLC } VDL_DLC_CFG; 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; AP_INT32 mux_ids[5]; } V0_MUX_INFO; /* /* /* /* /* /* /* DLC implementation type reserved reserved type of adapter card DLC adapter number reserved reserved */ */ */ */ */ */ */ 3.19.
NOF API Verbs DEFINE_DLC Ethernet AP_FDDI FDDI AP_IP Enterprise Extender (HPR/IP) def_data.neg_ls_supp Specifies whether the DLC supports negotiable link stations. You cannot change this parameter for an existing DLC; this parameter can be specified only when creating a new DLC. If dlc_type is set to AP_QLLC, this must be set to AP_YES. Possible values are: AP_YES Link stations using this DLC may be negotiable.
NOF API Verbs DEFINE_DLC udp_port[0] UDP port used for LLC commands. udp_port[1] UDP port used for network priority traffic. udp_port[2] UDP port used for high priority traffic. udp_port[3] UDP port used for medium priority traffic. udp_port[4] UDP port used for low priority traffic. ipdlc_dlc_spec_data.ip_precedence Array of five IP precedence values used by the DLC for different traffic priorities. Each entry in this array is a value in the range 0 (minimum)—7 (maximum).
NOF API Verbs DEFINE_DLC Type of the adapter card. Possible values are: AP_CARD_HP_PSI Single-port PSI card AP_CARD_HP_ACC 8-port ACC card AP_CARD_HP_EICON_PCI_SDLC Eicon PCI SDLC card sdl_spec_data.mux_info.adapter_number Adapter number used by the DLC. If the server contains more than one SDLC adapter card, specify 0 (zero) for the first card, 1 for the second card, and so on. Otherwise, set this parameter to 0 (zero). sdl_spec_data.
NOF API Verbs DEFINE_DLC Type of the DLC. Possible values are: AP_IMPL_TR_DLPI Token Ring AP_IMPL_ETHER_DLPI Ethernet AP_IMPL_FDDI_DLPI FDDI vdl_dlc_cfg.mux_info.card_type Type of the adapter card. Possible values are: AP_CARD_TOKEN_RING_DLPI Token Ring AP_CARD_ETHERNET_DLPI Ethernet AP_CARD_FDDI_DLPI FDDI vdl_dlc_cfg.mux_info.adapter_number Adapter number used by the DLC. This is the same as the “Card Instance Number” for the adapter card.
NOF API Verbs DEFINE_DLUR_DEFAULTS 3.19.5 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_DLC_ACTIVE The specified DLC cannot be modified because it is currently active. AP_INVALID_DLC_TYPE You cannot change the DLC type, negotiable link support, or supported port types for an existing DLC. They can be specified only when creating a new DLC.
NOF API Verbs DEFINE_DLUR_DEFAULTS } DEFINE_DLUR_DEFAULTS; 3.20.2 Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_DLUR_DEFAULTS description 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.
NOF API Verbs DEFINE_DOMAIN_CONFIG_FILE AP_OK 3.20.4 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 was not in the correct format.
NOF API Verbs DEFINE_DOWNSTREAM_LU AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char reserv3[8]; CONFIG_FILE_HEADER hdr; } DEFINE_DOMAIN_CONFIG_FILE; typedef struct config_file_header { AP_UINT16 major_version; AP_UINT16 minor_version; AP_UINT16 update_release; AP_UINT32 revision_level; unsigned char comment[100]; unsigned char updating; } CONFIG_FILE_HEADER; /* /* /* /* /* /* /* verb operation code reserved reserved primary return
NOF API Verbs DEFINE_DOWNSTREAM_LU This verb can also be used to activate a downstream LU that is already defined (for example, because the downstream workstation has just been activated). To do this, reissue the DEFINE_DOWNSTREAM_LU verb for that LU. Note that all parameters must be the same as in the original definition, because you cannot modify the definition.
NOF API Verbs DEFINE_DOWNSTREAM_LU def_data.host_lu_name Name of the host LU or host LU pool that the downstream LU will be mapped onto. This is an 8-byte type-A EBCDIC string, padded on the right with EBCDIC spaces. For PU concentration, the host LU cannot be a dependent LU type 6.2. However, if the downstream LU is LU type 6.2, you can configure the host LU as an LU type 0–3 and specify that the model type for the host LU is unknown.
NOF API Verbs 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. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.22.
NOF API Verbs DEFINE_DOWNSTREAM_LU_RANGE Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.22.
NOF API Verbs DEFINE_DOWNSTREAM_LU_RANGE unsigned char delayed_logon; unsigned char reserv4[6]; } DEFINE_DOWNSTREAM_LU_RANGE; /* Allow delayed logon to host LU */ /* reserved */ 3.23.2 Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_DOWNSTREAM_LU_RANGE dslu_base_name Base name for the names of the new LUs. This is a 5-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the base name is less than 5 characters.
NOF API Verbs DEFINE_DOWNSTREAM_LU_RANGE Specifies whether to use delayed logon with this range of downstream LUs (the upstream LU is not activated until the user requests it). Possible values are: AP_YES Use delayed logon with this range of downstream LUs; the upstream LU is not activated until the user requests it. AP_NO Do not use delayed logon with this range of downstream LUs. This field is ignored if the downstream LUs are used to communicate with a SNAplus2 Primary RUI application instead of a host.
NOF API Verbs DEFINE_DSPU_TEMPLATE The specified dspu_name parameter was not valid. AP_PU_NOT_DEFINED The specified dspu_name parameter did not match any defined PU name. AP_INVALID_PU_TYPE The PU specified by the dspu_name parameter is not a downstream PU that supports PU concentration. AP_LU_ALREADY_DEFINED 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.
NOF API Verbs DEFINE_DSPU_TEMPLATE 3.24.
NOF API Verbs DEFINE_DSPU_TEMPLATE num_of_dslu_templates The number of downstream LU (DSLU) templates being defined by this verb. The subrecord dslu_template contains the following parameters: min_nau NAU address of the first downstream PU, in the range 1–255. max_nau NAU address of the last downstream PU, in the range 1–255. allow_timeout Specifies whether to timeout host LUs used by the downstream LU if the session is left inactive for the timeout period specified on the host LU definition.
NOF API Verbs DEFINE_DSPU_TEMPLATE 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. AP_INVALID_NAU_RANGE The address specified on the min_nau or max_nau parameters was not in the valid range.
NOF API Verbs DEFINE_EMULATOR_USER The local node does not support PU concentration; this is defined by the pu_conc_support parameter on the DEFINE_NODE verb. 3.24.7 Returned Parameters: Other Conditions Appendix B, Common Return Codes, lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs DEFINE_EMULATOR_USER 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 description unsigned char reserv2[16]; /* reserved union { SESSION_3270_DEF_DATA def_data_3270; /* definition of 3270 session SESSION_5250_DEF_DATA def_data_5250; /* definition of 5250 session } session_variant;
NOF API Verbs DEFINE_EMULATOR_USER When the user starts the emulation program, SNAplus2 checks the user ID against the emulator user records in the configuration to find the correct record, in the following order: • If the user ID matches a record for a specific user name, this record is used. • If the user ID cannot be matched but the user’s group ID matches a record for a group, this record is used.
NOF API Verbs DEFINE_EMULATOR_USER Specifies whether the user has permission to change the mapping of 3270 sessions to LUs, either by remapping them from within the 3270 user interface, or by specifying LU names on the command line when starting the 3270 emulation program. (For a 5250-only user, this field is ignored.) Possible values are: AP_YES The user can change the LU/session mapping. AP_NO The user cannot change the LU/session mapping. def_data.
NOF API Verbs DEFINE_EMULATOR_USER interface will display session numbers 2, 3, and 5 using the information defined for these names. (The names SESS0001–SESS0010 are not displayed in the control interface; they are replaced by the long names defined for these sessions in the 3270 style file.) 3270 sessions that are available for the user to remap to must be given names that are not in the range above.
NOF API Verbs DEFINE_EMULATOR_USER The user can change the screen model. AP_NO The user cannot change the screen model. For a 5250 session, the following fields are included: session_def_data.session_variant.def_data_5250.local_lu_alias LU alias of the local LU that this session uses. This is an 8-byte ASCII string (starting with a letter), padded on the right with spaces. It must match the alias of an APPC local LU that has already been defined. session_def_data.session_variant.def_data_5250.
NOF API Verbs DEFINE_FOCAL_POINT AP_INVALID_SESSION_TYPE The emulator_type or session_type parameter for one or more sessions was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.25.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.25.
NOF API Verbs DEFINE_FOCAL_POINT opcode AP_DEFINE_FOCAL_POINT ms_category Management Services category. This may be either one of the category names specified in the MS DisciplineSpecific Application Programs table of Systems Network Architecture: Management Services Reference (see Related Publications), padded with EBCDIC spaces (0x40), or a user-defined category. A user-defined category name is an 8-byte type-1134 EBCDIC string, padded with EBCDIC spaces (0x40) if necessary.
NOF API Verbs DEFINE_FOCAL_POINT 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. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.26.
NOF API Verbs DEFINE_INTERNAL_PU 3.27 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 DLUR or PU concentration, or to define a local PU that is directly attached to the host, use DEFINE_LS instead of DEFINE_INTERNAL_PU.) 3.27.
NOF API Verbs DEFINE_INTERNAL_PU A null-terminated text string (0–31 characters followed by a null character) describing the internal PU. This string is for information only; it is stored in the node’s configuration file and returned on the QUERY_DLUR_PU and QUERY_PU verbs, but SNAplus2 does not make any other use of it. def_data.initially_active Specifies whether this internal PU is automatically started when the node is started.
NOF API Verbs DEFINE_INTERNAL_PU AP_NO The local PU does not send NMVT (power off) messages to the host. If the host supports DDDLU but does not support the NMVT (power off) message, this parameter must be set to AP_NO. 3.27.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.27.
NOF API Verbs DEFINE_LOCAL_LU 3.27.7 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.28 DEFINE_LOCAL_LU The DEFINE_LOCAL_LU verb defines a new local LU.
NOF API Verbs DEFINE_LOCAL_LU unsigned char unsigned char } ROUTING_DATA; back_level; reserved[59]; /* is target system back-level? /* reserved */ */ 3.28.2 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 DEFINE_LOCAL_LU • The LU session limit must be greater than or equal to the sum of the session limits for all modes that the LU will use. def_data.default_pool Specifies whether the LU is in the pool of default dependent LUs. For more information, see Section 3.28.7, Default LUs. Possible values are: AP_YES The LU is in the pool of default LUs, and can be used by applications that do not specify an LU name. AP_NO The LU is not in the pool.
NOF API Verbs DEFINE_LOCAL_LU node that owns this LU, set this parameter to binary zeros. Otherwise, set it to the name of the computer where the TP runs. If the system name includes a . (period) character, SNAplus2 assumes that it is a fully-qualified name; otherwise it performs a DNS lookup to determine the system name. def_data.attach_routing_data.timeout The timeout value for dynamic load requests.
NOF API Verbs DEFINE_LOCAL_LU 3.28.5 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_LU_NAME 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.
NOF API Verbs DEFINE_LS 3.29 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. 3.29.
NOF API Verbs DEFINE_LS AP_UINT16 link_deact_timer; /* link deactivation timer unsigned char reserv1; /* reserved unsigned char default_nn_server; /* default LS to NN server? unsigned char ls_attributes[4]; /* LS attributes unsigned char adj_node_id[4]; /* adjacent node ID unsigned char local_node_id[4]; /* local node ID unsigned char cp_cp_sess_support; /* CP-CP session support unsigned char use_default_tg_chars; /* Use the default tg_chars TG_DEFINED_CHARS tg_chars; /* TG characteristics AP_UINT16 target
NOF API Verbs DEFINE_LS 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_retry; reserve4; nve_poll_timer2; nve_poll_timer_retry2; rese
NOF API Verbs DEFINE_LS unsigned char unsigned char } STUB_SPEC_DATA; hex_hmod_data; reserve1[2]; /* reserved /* reserved */ */ DLC-specific data for QLLC: typedef struct vql_ls_spec_data { V0_MUX_INFO mux_info; AP_UINT16 reserve1; AP_UINT16 reserve2; unsigned char vc_type; unsigned char req_rev_charge; unsigned char loc_packet; unsigned char rem_packet; unsigned char unsigned char AP_UINT16 unsigned char AP_UINT16 loc_wsize; rem_wsize; fac_len; fac[32]; retry_limit; AP_UINT16 AP_UINT16 retry_ti
NOF API Verbs DEFINE_LS AP_UINT16 } VDL_LS_CFG; t1_retry_limit; /* I-frame retransmission limit */ DLC-specific data for Enterprise Extender (HPR/IP): typedef struct ipdlc_link_spec_data { V0_MUX_INFO mux_info; AP_UINT16 ack_timeout; AP_UINT16 max_retry; AP_UINT16 liveness_timeout; unsigned char short_hold_mode; unsigned char remote_hostname[100]; } IPDLC_LINK_SPEC_DATA; /* /* /* /* /* /* streams information ACK timer for command frames Retry limit for command frames Liveness timer Run in short-hold
NOF API Verbs DEFINE_LS The LS is automatically started when the node is started. AP_NO The LS is not automatically started; it must be started manually. If the LS is a leased SDLC link or a QLLC PVC link, you are recommended to set this parameter to AP_YES to ensure that the link is always available. def_data.react_timer Reactivation timer for reactivating a failed LS.
NOF API Verbs DEFINE_LS If adj_cp_type is set to AP_BACK_LEVEL_LEN_NODE, SNAplus2 uses this value only as an identifier; set it to any string (of the format described below) that does not match other CP names defined at this node. 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.
NOF API Verbs DEFINE_LS IP address. Specify this value for an Enterprise Extender (HPR/IP) link. AP_UNSPECIFIED Unspecified address format. Specify this value for any link type other than Enterprise Extender (HPR/ IP). def_data.dest_address.length Length of the destination address field, as specified in the following parameter or parameters. For Enterprise Extender (HPR/IP), this parameter and dest_address.address are reserved.
NOF API Verbs DEFINE_LS AP_YES The link can be activated automatically. AP_NO The link cannot be activated automatically. If this parameter is set to AP_YES: • The reactivation timer fields are ignored. If the LS fails, SNAplus2 does not attempt to reactivate it until a dependent LU application that was using the session attempts to restart the session; an LS used by independent LUs will not be reactivated by SNAplus2, and must be restarted manually.
NOF API Verbs DEFINE_LS def_data.solicit_sscp_sessions For an Enterprise Extender (HPR/IP) port, this parameter is reserved. Specifies whether to request the adjacent node to initiate sessions between the SSCP and the local CP and dependent LUs. 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.
NOF API Verbs DEFINE_LS Name of the downstream PU. The name is an 8-byte type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces. 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 or AP_DLUR If the downstream PU is used for DLUR, this name should match the PU name configured on the host.
NOF API Verbs DEFINE_LS AP_NO HPR traffic should not be sent on this link using link-level error recovery. 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 DEFINE_LS AP_NO Include the Network Name CV in the XID. AP_SUPPRESS_CP_NAME Do not include the Network Name CV. If adj_cp_type is set to any other value, this parameter is ignored. def_data.adj_node_id 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.
NOF API Verbs DEFINE_LS def_data.tg_chars.security Security level of the network. Possible values are: AP_SEC_NONSECURE No security. AP_SEC_PUBLIC_SWITCHED_NETWORK Data is transmitted over a public switched network. AP_SEC_UNDERGROUND_CABLE Data is transmitted over secure underground cable. 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.
NOF API Verbs DEFINE_LS def_data.max_send_btu_size Maximum BTU size that can be sent from this link station. This value is used to negotiate the maximum BTU size that a pair of link stations can use to communicate with each other. The value includes the length of the TH and RH (total 9 bytes) as well as the RU. Specify a value in the range 265–65535 (265–4105 for SDLC). def_data.ls_role Link station role.
NOF API Verbs DEFINE_LS The link is a downlink. If def_data.adj_cp_type is set to AP_NETWORK_NODE, this parameter must be set to AP_UPLINK. def_data.adj_brnn_cp_support This parameter applies only if the local node is a Branch Network Node and the adjacent node is a network node (the parameter def_data.adj_cp_type is set to AP_NETWORK_NODE, or it is set to AP_APPN_NODE and the node type discovered during XID exchange is network node). It is reserved if the local and remote nodes are any other type.
NOF API Verbs DEFINE_LS contact_timer_retry 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 DEFINE_LS no_resp_timer_retry Number of times an adjacent secondary station is seen to fail to respond before the primary sends an outage message to the DLC user. A value of 0xFFFF indicates an unlimited retry count. 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 DEFINE_LS 4-wire connection (2 wire connection if not set). bit 6 Use NRZI (NRZ if not set) bit 4 Line is full-duplex (half-duplex if not set) The remaining bits are reserved. stub_spec_data.opt2 Reserved. stub_spec_data.linesp The line speed for the line used on this port. For example, 2400 (0x00000960) for a 2400 baud line. Valid values are in the range 600–38,400 baud. The exact meaning of this parameter depends on the value set on the physical_link parameter.
NOF API Verbs DEFINE_LS 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). To avoid these problems, ensure that PVC LSs are activated before any SVC LSs between the same pair of nodes. req_rev_charge Specifies whether X.
NOF API Verbs DEFINE_LS If your X.25 network or the remote system requires any other facilities data in addition to the above parameters, specify it using this parameter. Check with the administrator of your X.25 network, or the administrator of the remote system, to determine what to specify in this parameter. If the X.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 DEFINE_LS set to a single hex byte, which is 0xC3 to request that the called node supports the 1980 QLLC level, or 0xCB to request 1984 support. 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 DEFINE_LS Link-specific data for Enterprise Extender (HPR/IP): ipdlc_link_spec_data.mux_info.dlc_type Type of DLC. Set this to AP_IP. ipdlc_link_spec_data.ack_timeout Duration for the acknowledgment timer (sometimes called the T1 timer): the time in milliseconds within which a response must be received for a command frame sent to the adjacent link station. If the response is not received within this time, a duplicate frame is sent.
NOF API Verbs DEFINE_LS 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. AP_DEF_LINK_INVALID_SECURITY The tg_chars.security parameter was not set to a valid value.
NOF API Verbs DEFINE_LS AP_INVALID_TG_NUMBER The TG number supplied was not in the valid range. AP_MISSING_CP_NAME A TG number was defined, but no CP name was supplied. AP_MISSING_CP_TYPE A TG number was defined, but no CP type was supplied. AP_MISSING_TG_NUMBER The link was defined to be auto-activated, but no TG number was supplied. AP_PARALLEL_TGS_NOT_SUPPORTED This node cannot support more than one LS defined between it and the same adjacent node.
NOF API Verbs DEFINE_LS Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.29.5 Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters. primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_DUPLICATE_CP_NAME A link to the CP name specified in the adj_cp_name parameter has already been defined.
NOF API Verbs DEFINE_LS 3.29.7 Bit Ordering in MAC Addresses Ethernet LANs use a different representation of MAC addresses from that used by Token Ring and FDDI; the order of the bits in each byte of the address on Ethernet is the reverse of the order on Token Ring. Normally, the local and remote nodes are on the same LAN, or on LANs of the same type connected by a bridge; in this case, they will both use the same representation of the MAC address, and no conversion is required.
NOF API Verbs DEFINE_LS_ROUTING Escape Sequence Decimal Value Hexadecimal Value ACK 6 0x06 BEL 7 0x07 BS 8 0x08 HT 9 0x09 LF 10 0x0A VT 11 0x0B FF 12 0x0C CR 13 0x0D SO 14 0x0E SI 15 0x0F DLE 16 0x10 DC1 17 0x11 DC2 18 0x12 DC3 19 0x13 DC4 20 0x14 NAK 21 0x15 SYN 22 0x16 ETB 23 0x17 CAN 24 0x18 EM 25 0x19 SUB 26 0x1A ESC 27 0x1B FS 28 0x1C GS 29 0x1D RS 30 0x1E US 31 0x1F SP 32 0x20 DEL 127 0x7F 3.
NOF API Verbs DEFINE_LS_ROUTING Note You cannot use DEFINE_LS_ROUTING with an Enterprise Extender (HPR/IP) link station. This is because all traffic on this link type must flow over an RTP connection, which is not fixed to a particular link station and can switch to a different path. 3.30.
NOF API Verbs DEFINE_LS_ROUTING The fq_partner_lu parameter contains a wildcard entry. AP_NO The fq_partner_lu parameter does not contain a wildcard entry. ls_name Name of the link station to use for communication between the local LU (specified by the lu_name parameter) and the partner LU (specified in the fq_partner_lu parameter). Specify 1–8 locally displayable characters. 3.30.
NOF API Verbs DEFINE_LU62_TIMEOUT 3.30.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.31 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.
NOF API Verbs DEFINE_LU62_TIMEOUT Name of the resource being queried. This value can be one of the following: • If resource_type is set to AP_GLOBAL_TIMEOUT, do not specify this parameter. • 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 DEFINE_LU_0_TO_3 3.32 DEFINE_LU_0_TO_3 The DEFINE_LU_0_TO_3 verb defines an LU for use with 3270 emulation, RJE 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 DEFINE_LU_0_TO_3 3.32.2 Supplied Parameters The application supplies the following parameters: opcode AP_DEFINE_LU_0_TO_3 lu_name Name of the local LU. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. def_data.description A null-terminated text string (0–31 characters followed by a null character) describing the LU.
NOF API Verbs DEFINE_LU_0_TO_3 If you are not using the LU for 3270 emulation or RJE, it is not necessary to specify an explicit LU type; set this parameter to AP_UNKNOWN. If the host system supports DDDLU (Dynamic Definition of Dependent LUs), and this parameter is set to any value other than AP_UNKNOWN, SNAplus2 will define the LU dynamically at the host when the communications link to the host is established.
NOF API Verbs DEFINE_LU_0_TO_3 Possible values are: AP_INVALID_LU_NAME The lu_name parameter contained a character that was not valid. AP_INVALID_POOL_NAME The pool_name parameter contained a character that was not valid. AP_INVALID_NAU_ADDRESS The nau_address parameter was not in the permitted range. AP_INVALID_PRIORITY The priority parameter was not set to a valid value. AP_INVALID_TERM_METHOD The term_method parameter was not set to a valid value.
NOF API Verbs DEFINE_LU_0_TO_3_RANGE 3.33 DEFINE_LU_0_TO_3_RANGE The DEFINE_LU_0_TO_3_RANGE verb defines a range of LUs for use with 3270 emulation, RJE 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 DEFINE_LU_0_TO_3_RANGE description A null-terminated text string (0–31 characters followed by a null character) describing the LUs; the same string is used for each LU in the range. 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. 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 DEFINE_LU_0_TO_3_RANGE Specifies the ID of the SSCP permitted to activate this LU. Specify a value in the range 0–65,535. If this parameter is set to 0 (zero), the LU can be activated by any SSCP. timeout Timeout for the LU specified in seconds.
NOF API Verbs DEFINE_LU_0_TO_3_RANGE 3.33.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME The base_name parameter contained a character that was not valid. AP_INVALID_POOL_NAME The pool_name parameter contained a character that was not valid. AP_INVALID_NAU_ADDRESS One or more of the LU addresses were not in the permitted range.
NOF API Verbs DEFINE_LU_LU_PASSWORD 3.33.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.34 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. 3.34.
NOF API Verbs DEFINE_LU_LU_PASSWORD verification_protocol Requested LU-LU verification protocol to use. Possible values are: AP_BASIC Use basic LU-LU verification protocols. AP_ENHANCED Use enhanced LU-LU verification protocols. AP_EITHER Basic or enhanced verification is accepted. description A null-terminated text string (0–31 characters followed by a null character) describing the password.
NOF API Verbs DEFINE_LU_POOL 3.34.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.35 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 Section 3.
NOF API Verbs DEFINE_LU_POOL Names of the LUs that are being assigned to the pool. Each of these LUs must already be defined to SNAplus2 as an LU of type 0–3. Each LU name is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. If a specified LU is currently assigned to a different pool, SNAplus2 removes it from that pool (because an LU cannot be in more than one pool) and assigns it to the pool specified by this verb. 3.35.
NOF API Verbs DEFINE_MODE 3.36 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 DEFINE_MODE AP_DEFINE_MODE mode_name Name of the mode. This is an 8-byte type-A EBCDIC string, padded on the right with EBCDIC spaces if the name is shorter than 8 bytes.The name must start with a letter, or can start with # for one of the SNA-defined modes such as #INTER. For information about SNA-defined modes, see the HP-UX SNAplus2 Administration Guide. To specify the default COS that will be used for any unrecognized mode names, set this parameter to 8 binary zeros.
NOF API Verbs DEFINE_MODE If you specify an explicit limit, the LU session limit for any LU that uses this mode must be greater than or equal to the sum of the session limits for all modes that the LU will use. mode_chars.min_conwin_src Minimum number of contention winner sessions that a local LU using this mode can activate. This value is used when CNOS (Change Number of Sessions) exchange is initiated either by the remote system or implicitly by SNAplus2. Specify a value in the range 0–32,767.
NOF API Verbs DEFINE_MODE 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_COMPRESSION The compression parameter is not valid. AP_INVALID_COS_NAME The cos_name parameter did not match any defined COS name. AP_INVALID_COS_SNASVCMG_MODE The COS for the SNA-defined mode SNASVCMG cannot be changed.
NOF API Verbs DEFINE_NODE 3.36.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.37 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. 3.37.
NOF API Verbs DEFINE_NODE AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } CP_CREATE_PARMS; /* stored in Topology Database /* max number of TGs that can be /* stored
NOF API Verbs DEFINE_NODE AP_NETWORK_NODE AP_BRANCH_NETWORK_NODE AP_END_NODE AP_LEN_NODE cp_create_parms.fqcp_name Node’s fully qualified CP name. 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. cp_create_parms.cp_alias Locally used CP alias. This alias can be used by APPC applications to access the CP LU. This is an 8-byte ASCII string.
NOF API Verbs DEFINE_NODE Specifies the time in seconds before a network search will timeout. Specify zero for no timeout. cp_create_parms.reg_with_nn Specifies whether to register the node’s resources with the network node server when the node is started. Note that the valid values for this parameter are different depending on whether the node is an End Node or a Branch Network Node.If the local node is a Network Node or a LEN Node, this parameter is reserved.
NOF API Verbs DEFINE_NODE cp_create_parms.mds_send_alert_q_size Size of the MDS send alert queue. If the number of queued alerts reaches this limit, SNAplus2 deletes the oldest alert on the queue. SNAplus2 uses the value 2 unless you specify a larger number. cp_create_parms.cos_cache_size Size of the COS Database weights cache. This value should be set to the maximum number of COS definitions required. SNAplus2 uses the value 8 unless you specify a larger number. cp_create_parms.
NOF API Verbs DEFINE_NODE this value to AP_YES means an RSCV will be stored for each ISR session. This extra storage can be up to 256 bytes per session.) For an end node or LEN node, this parameter is reserved. 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.
NOF API Verbs DEFINE_NODE cp_create_parms.max_ls_exception_events The maximum number of LS exception events to be recorded by the node. cp_create_parms.ptf Array for configuring and controlling future program temporary fix (ptf) operation, as follows: cp_create_parms.ptf[0] REQDISCONT support and Mandatory Search Status support. SNAplus2 normally uses REQDISCONT to deactivate limited resource host links that are no longer required by session traffic.
NOF API Verbs DEFINE_NODE AP_NONE Use the normal processing. AP_OVERRIDE_ERP Process all ACTPU requests as ACTPU(cold). cp_create_parms.ptf[2] BIS support. SNAplus2 normally uses the BIS protocol prior to deactivating a limited resource LU 6.2 session. Set this byte to one of the following values: AP_NONE Use the normal processing. AP_SUPPRESS_BIS Do not use the BIS protocol. Limited resource LU 6.2 sessions are deactivated immediately using UNBIND(cleanup). cp_create_parms.ptf[3] APINGD support.
NOF API Verbs DEFINE_NODE Do not check security parameters on a received Attach if the invokable TP does not require it. cp_create_parms.ptf[6] RTP options for HPR. To use SNAplus2’s normal RTP processing, set this parameter to AP_NONE. To customize RTP operation, specify the following value: AP_FORCE_STANDARD_ARB SNAplus2 normally advertises support on RTP connections for both the standard ARB algorithm and the ARB responsive mode algorithm.
NOF API Verbs DEFINE_NODE SNAplus2 TN Server normally includes the TCP/IP Information Control Vector (0x64) in an Open(SSCP) request to the host for a TN3270 session. This vector contains the TCP/IP address and port number used by the TN3270 client, which can be displayed on the host console or used by the host (for example in billing).
NOF API Verbs DEFINE_NODE Syncpoint is not supported. cp_create_parms.cplu_attributes Identifies additional information about the node’s Control Point LU. This parameter is equivalent to the lu_attributes parameter on DEFINE_LOCAL_LU, but applies only to the node’s Control Point LU (which does not have an explicit LU definition). Possible values are: AP_NONE No additional information identified. AP_DISABLE_PWSUB Disable password substitution support for the control point LU.
NOF API Verbs DEFINE_PARTNER_LU AP_DLUR_NOT_SUPPORTED This version of SNAplus2 does not support the DLUR feature. AP_INVALID_REG_WITH_NN The reg_with_nn parameter was not set to a valid value. AP_INVALID_COS_TABLE_VERSION The cos_table_version parameter was not set to a valid value. AP_INVALID_SEND_TERM_SELF The send_term_self parameter was not set to a valid value. AP_INVALID_DISABLE_BRANCH_AWRN The disable_branch_awareness parameter was not set to a valid value.
NOF API Verbs DEFINE_PARTNER_LU an APPC application that uses a partner LU alias when allocating a session, therefore you need to define a partner LU in order to map the alias to a fully-qualified partner LU name. If the local node or the remote node (where the partner LU is located) is a LEN node, note that you need to define a directory entry for the partner LU to allow SNAplus2 to access it. This can be done using either DEFINE_ADJACENT_LEN_NODE or DEFINE_DIRECTORY_ENTRY.
NOF API Verbs DEFINE_PARTNER_LU A null-terminated text string (0–31 characters followed by a null character) describing the partner LU. This string is for information only; it is stored in the node’s configuration file and returned on the QUERY_PARTNER_LU and QUERY_PARTNER_LU_DEFINITION verbs, but SNAplus2 does not make any other use of it. plu_chars.plu_un_name Uninterpreted name of the partner LU (the name of the LU as defined to the remote SSCP). The name is an 8-byte EBCDIC character string.
NOF API Verbs DEFINE_PORT The fqplu_name parameter contained a character that was not valid. AP_INVALID_UNINT_PLU_NAME The plu_un_name parameter contained a character that was not valid. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.38.5 Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs DEFINE_PORT } DEFINE_PORT; typedef struct port_def_data { unsigned char description[32]; /* resource description */ unsigned char initially_active; /* is the port initially active? */ unsigned char reserv2[15]; /* reserved */ unsigned char dlc_name[8]; /* DLC name associated with port */ unsigned char port_type; /* port type */ unsigned char port_attributes[4]; /* port attributes */ unsigned char implicit_uplink_to_en; /* implicit EN links up or down? */ unsigned char implicit_appn_links_len
NOF API Verbs DEFINE_PORT typedef struct link_address { unsigned char format; unsigned char reserve1; AP_UINT16 length; unsigned char address[32]; } LINK_ADDRESS; 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_
NOF API Verbs DEFINE_PORT AP_UINT16 AP_UINT16 AP_UINT32 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_retry; reserve1; contact_timer2; contact_timer_retry2; reserve2; disc_timer; disc_timer_retry; reserve3; nve_poll_timer; nve_poll_timer_retry; reserve4; nve_poll_timer2; nve_poll_timer_retry2; reserve5; no_resp_timer; AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT16 unsigned char unsigned char AP_UINT32 unsigned char unsigned
NOF API Verbs DEFINE_PORT unsigned char cud[16]; unsigned char add_mode; AP_UINT16 add_len; AP_UINT32 xtras; AP_UINT32 xtra_len; } VQL_PORT_SPEC_DATA; /* /* /* /* /* Call User Data matching reqd on called address length of called address to match reserved reserved */ */ */ */ */ Link-specific data for QLLC: 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
NOF API Verbs DEFINE_PORT AP_UINT16 AP_UINT16 AP_UINT16 } VDL_LS_CFG; xid_retry_limit; t1_timeout; t1_retry_limit; /* XID retransmission limit /* T1 timeout value in seconds /* I-frame retransmission limit */ */ */ Port-specific data for Enterprise Extender (HPR/IP): typedef struct ipdlc_port_spec_data { V0_MUX_INFO mux_info; /* streams information */ unsigned char local_ip_interface[32]; /* identifier of local network card */ } IPDLC_PORT_SPEC_DATA; Link-specific data for Enterprise Extender (HPR/IP)
NOF API Verbs DEFINE_PORT A null-terminated text string (0–31 characters followed by a null character) describing the port. This string is for information only; it is stored in the node’s configuration file and returned on the QUERY_PORT verb, but SNAplus2 does not make any other use of it. def_data.initially_active 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.
NOF API Verbs DEFINE_PORT Implicit links to an End Node are uplinks. AP_NO Implicit links to an End Node are downlinks. def_data.port_number The number of the port. For Enterprise Extender (HPR/IP), this parameter is reserved. def_data.max_rcv_btu_size Maximum BTU size that can be received. The value includes the length of the TH and RH (total 9 bytes) as well as the RU. Specify a value in the range 265–65535 (265–4105 for SDLC). def_data.
NOF API Verbs DEFINE_PORT For Enterprise Extender (HPR/IP), this parameter is reserved. For Enterprise Extender (HPR/IP), this parameter is reserved. Specifies the DSPU template, defined on the DEFINE_DSPU_TEMPLATE verb. This template is used for definitions if the local node is to provide PU concentration for an implicit link activated on this port. If the template specified does not exist or is already at its instance limit when the link is activated, activation will fail.
NOF API Verbs DEFINE_PORT AP_LS_TWA Two-way alternating For Enterprise Extender (HPR/IP), this parameter must be set to AP_LS_TWS. def_data.max_ifrm_rcvd Maximum number of I-frames that can be received by the local link stations before an acknowledgment is sent. Range: 1–127. def_data.target_pacing_count Numeric value between 1 and 32,767 inclusive indicating the desired pacing window size. (The current version of SNAplus2 does not make use of this value.) def_data.
NOF API Verbs DEFINE_PORT (The first parameter in the address structure normally contains the MAC address, but this value is used only on the LS and is reserved on the 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 DEFINE_PORT For details of these parameters, see Section 3.29, DEFINE_LS. def_data.port_spec_data_len 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 portspecific data. For details of these parameters, see Section 3.
NOF API Verbs DEFINE_PORT 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. link_conn_timer The link connection timeout together with the retry limit corresponds to the time interval after which SNAplus2 fails an attempt to activate an LS because it has not detected that DSR has been raised. The timer is specified in milliseconds.
NOF API Verbs DEFINE_PORT If def_data.port_type above is AP_NONSWITCHED, set this parameter to AP_PORT_LEASED. For a switched line (def_data.port_type is AP_SWITCHED): • If the port is used for outgoing calls (inb_link_act_lim is zero), set this parameter to AP_PORT_SW_DIAL (Dial-out capabilities). • If the port is used for incoming calls (out_link_act_lim is zero), AP_PORT_SW_ANSWER (Answer capabilities).
NOF API Verbs DEFINE_PORT bit 5 Monitor DCD (do not monitor if not set) bit 4 Stream flags on the line (do not stream if not set) bits 3–0 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–38400 baud. stub_spec_data.rcv_pool_size The initial number of buffers reserved for receiving data on the port. Set this to the value 4. stub_spec_data.
NOF API Verbs DEFINE_PORT cud_len Specifies the length of the Call User Data (in the cud parameter below). cud Call user data to be used for verifying incoming calls. If cud_mode above is set to VQL_IDENTITY or VQL_STARTSWITH, incoming calls are accepted only if they specify a CUD string that matches the value 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.
NOF API Verbs DEFINE_PORT • Run the command netstat ---i on the server where the card is installed. • Check the Network column in the output data to find the appropriate IP subnet for this link. The Name column in the same row of the output data contains the identifier to be used in this parameter. 3.39.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.39.
NOF API Verbs DEFINE_RCF_ACCESS A reserved parameter was set to a nonzero value. AP_INVALID_LINK_SPEC_FORMAT A reserved parameter was set to a nonzero value. AP_INVALID_IMPLICIT_UPLINK The implicit_uplink_to_en parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.39.
NOF API Verbs DEFINE_RCF_ACCESS issued using the Service Point Command Facility (SPCF). For more information about SPCF and UCF, see the HP-UX SNAplus2 Administration Guide. You can use this verb to permit access to both SPCF and UCF, or to only one of them. This verb must be issued to the domain configuration file; it can be used to specify the RCF access for the first time, or to modify an existing definition.
NOF API Verbs DEFINE_RJE_WKSTN AP_ALLOW_DEFINE_REMOTE 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. 3.40.
NOF API Verbs DEFINE_RJE_WKSTN unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char RJE_WKSTN_DEF_DATA } DEFINE_RJE_WKSTN; reserv2; format; primary_rc; secondary_rc; workstation_name[4]; def_data; 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[128]; AP_UINT16 unsigned char unsigned char } RJE_WKSTN_DEF_DATA; num_lus; reserv4[18]; lu_name[5][8]; /* /* /* /* /*
NOF API Verbs DEFINE_RJE_WKSTN Before the workstation can be used, you must create the workstation directory /var/opt/sna/rje/ WKST on the specified computer; WKST represents the name of the RJE workstation, as specified by the workstation_name parameter above. You should also create a workstation style file with the name WKST.sty in the directory /etc/opt/sna; for more information about the workstation style file, refer to the HP-UX SNAplus2 RJE User’s Guide.
NOF API Verbs DEFINE_RTP_TUNING 3.41.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.42 DEFINE_RTP_TUNING DEFINE_RTP_TUNING specifies parameters to be used when setting up RTP connections. After you issue this verb, the parameters you specify will be used for all future RTP connections until you modify them by issuing a new DEFINE_RTP_TUNING verb. 3.42.
NOF API Verbs DEFINE_SECURITY_ACCESS_LIST • 120 seconds (2 minutes) for AP_HIGH • 60 seconds (1 minute) for AP_NETWORK 3.42.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.42.
NOF API Verbs DEFINE_SECURITY_ACCESS_LIST If a local LU or an invokable TP does not have a security access list defined, but is still configured to require conversation security, the standard conversation security checking still applies. 3.43.1 VCB Structure The DEFINE_SECURITY_ACCESS_LIST verb contains a variable number of security_user_data structures; these define the user names to be added to the security access list.
NOF API Verbs DEFINE_TN3270_ACCESS For each user name in the list, up to the number specified in num_users, a security_user_data structure is required with the following information: user_name Name of the user. This is a user ID defined using the DEFINE_USERID_PASSWORD verb. 3.43.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.43.
NOF API Verbs DEFINE_TN3270_ACCESS typedef struct define_tn3270_access { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; AP_UINT16 default_record; unsigned char client_address[68]; TN3270_ACCESS_DEF_DATA def_data; } DEFINE_TN3270_ACCESS; typedef struct tn3270_access_def_data { unsigned char description[32]; unsigned char reserv1[16]; AP_UINT16 address_format; AP_UINT32 num_sessions; unsigned char reserv3[64]; } TN3270_ACCESS_DEF_DATA; typedef s
NOF API Verbs 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 DEFINE_TN3270_ACCESS Specifies the level of TN3270 support. Possible values are: AP_TN3270 Specifies that TN3270E protocols are disabled. AP_TN3270E Specifies that TN3270E protocols are enabled. TN3270 and TN3287 protocols are always enabled. For an AS/400 TN3270 client, this parameter must be set to AP_TN3270E. 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 DEFINE_TN3270_ACCESS primary_rc AP_OK 3.44.4 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_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.
NOF API Verbs DEFINE_TN3270_ASSOCIATION kill processid processid is the process ID that you found in step 5. 7. Start the SNAplus2 Internet daemon program, by issuing the following command: snapinetd 8. Restart the Internet daemon program, by issuing the following command: inetd 9. Restart the SNAplus2 software, and then restart the node. Steps 5, 6, 7, and 8 must be repeated each time you restart the HP-UX computer.
NOF API Verbs DEFINE_TN3270_ASSOCIATION opcode AP_DEFINE_TN3270_ASSOCIATION display_lu_name Name of the display LU to be associated with the printer that was specified by the def_data.printer_lu_name parameter. This is a type-A 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 DEFINE_TN3270_DEFAULTS 3.46 DEFINE_TN3270_DEFAULTS DEFINE_TN3270_DEFAULTS defines TN3270 parameters used on all client sessions. 3.46.
NOF API Verbs DEFINE_TP AP_TN3270_NOP Send Telnet NOP messages. AP_TN3270_TM Send Telnet DO TIMING-MARK messages. def_data.keepalive_interval Interval (in seconds) between consecutive keep-alive messages. The interval should be long enough to minimize network traffic, especially if there are typically many idle client connections. The shorter the keepalive interval, the quicker failures are detected, but the more network traffic is generated.
NOF API Verbs DEFINE_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). DEFINE_TP is required only if you need to specify additional parameters that cannot be set in the file: to restrict the TP to use particular options for conversation security, confirm synchronization, or conversation type (mapped or basic), or to restrict the number of instances of the TP that can be running at any time. 3.47.
NOF API Verbs DEFINE_TP conversations with it. If you specify a security access list, the tp_chars.security_rqd parameter must be set to AP_YES. To specify that the TP is available for use by any user, set this parameter to 14 binary zeros. tp_chars.conv_type Specifies the type(s) of conversation supported by this TP. Possible values are: AP_BASIC The TP supports only basic conversations. AP_MAPPED The TP supports only mapped conversations. AP_EITHER The TP supports either basic or mapped conversations.
NOF API Verbs DEFINE_TP TP cannot be attached. tp_chars.pip_allowed Specifies whether the TP can receive Program Initialization Parameters (PIP). Possible values are: AP_YES TP can receive PIP. AP_NO TP cannot receive PIP. tp_chars.tp_instance_limit Limit on the number of instances of this TP that can be active at any one time. A value of zero means no limit. 3.47.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.
NOF API Verbs DEFINE_TP_LOAD_INFO AP_STATE_CHECK secondary_rc Possible values are: AP_SECURITY_LIST_NOT_DEFINED The security_list_name parameter did not match any defined security list name. 3.47.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs DEFINE_TP_LOAD_INFO tp_name 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. Note This parameter can be used only if the TP is an APPC TP. If the TP is a CPI-C application, this parameter is reserved and must be set to all zeros.
NOF API Verbs DEFINE_TP_LOAD_INFO AP_TYPE_TP_STDIN Standard input. The value string specifies the full path name of the standard input file or device. If this LTV is not specified, the default is /dev/null. AP_TYPE_TP_STDOUT Standard output. The value string specifies the full path name of the standard output file or device. If this LTV is not specified, the default is /dev/null. AP_TYPE_TP_STDERR Standard error. The value string specifies the full path name of the standard error file or device.
NOF API Verbs DEFINE_USERID_PASSWORD 3.48.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.49 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. 3.49.
NOF API Verbs DEFINE_USERID_PASSWORD Some CPI-C implementations have a maximum user ID length of 8 characters. If you specify a user ID of 9 or 10 characters, CPI-C applications running on other systems may not be able to access applications on the SNAplus2 system using this user ID and password. password_chars.description A null-terminated text string (0–31 characters followed by a null character) describing the user ID and password.
NOF API Verbs DELETE_ADJACENT_LEN_NODE 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 DELETE_ADJACENT_LEN_NODE The fully qualified name of the CP in the adjacent LEN node. The name is a 17-byte EBCDIC string, rightpadded 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. num_of_lus The number of LUs to be deleted, in the range 1 to 10. To delete the entire LEN node definition, specify zero. lu_names The names of the LUs on the LEN node to be deleted.
NOF API Verbs DELETE_BACKUP primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_CP_NAME The specified CP name does not exist. AP_INVALID_LU_NAME One or more of the specified LU names does not exist. 3.50.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs DELETE_CN If the server name includes a . (period) character, SNAplus2 assumes that it is a fully-qualified name; otherwise it performs a DNS lookup to determine the server name. 3.51.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. 3.51.
NOF API Verbs DELETE_CN 3.52.
NOF API Verbs DELETE_COS AP_INVALID_NUM_PORTS_SPECIFIED The num_ports parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.52.5 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.
NOF API Verbs DELETE_CPIC_SIDE_INFO Class of service name. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. 3.53.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.53.
NOF API Verbs DELETE_DIRECTORY_ENTRY AP_UINT32 secondary_rc; unsigned char reserv2a[8]; unsigned char sym_dest_name[8]; } DELETE_CPIC_SIDE_INFO; /* secondary return code /* reserved /* Symbolic destination name */ */ */ 3.54.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_CPIC_SIDE_INFO sym_dest_name Symbolic destination name which identifies the side information entry.
NOF API Verbs DELETE_DIRECTORY_ENTRY 3.55.1 VCB Structure typedef struct delete_directory_entry { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char resource_name[17]; unsigned char reserv3; AP_UINT16 resource_type; } DELETE_DIRECTORY_ENTRY; /* /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code fully qualified resource name reserved resource type */ */ */ */ */ */ */ */ 3.55.
NOF API Verbs DELETE_DLC secondary_rc Possible values are: AP_INVALID_FQ_LU_NAME The resource_name parameter was not the name of a defined directory entry. AP_INVALID_RESOURCE_TYPE The resource_type parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.55.
NOF API Verbs DELETE_DLC 3.56.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_DLC dlc_name Name of DLC to be deleted. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. 3.56.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.56.
NOF API Verbs DELETE_DOWNSTREAM_LU 3.57 DELETE_DOWNSTREAM_LU This verb is used to delete a downstream LU. 3.57.1 VCB Structure typedef struct delete_downstream_lu { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char dslu_name[8]; } DELETE_DOWNSTREAM_LU; /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code Downstream LU name */ */ */ */ */ */ 3.57.
NOF API Verbs DELETE_DOWNSTREAM_LU_RANGE primary_rc AP_STATE_CHECK secondary_rc Possible values are: AP_INVALID_LU_NAME The dslu_name parameter did not match any defined downstream LU name. AP_DSLU_ACTIVE The LU cannot be deleted because it is currently active. Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.57.
NOF API Verbs DELETE_DOWNSTREAM_LU_RANGE unsigned char min_nau; unsigned char max_nau; } DELETE_DOWNSTREAM_LU_RANGE; /* Minimum NAU address in range /* Maximum NAU address in range */ */ 3.58.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_DOWNSTREAM_LU_RANGE dslu_base_name Base name for the names of the 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.
NOF API Verbs DELETE_DSPU_TEMPLATE secondary_rc Possible values are: AP_INVALID_LU_NAME There were no LUs defined with names in the specified range. AP_DSLU_ACTIVE One or more of the LUs in the range cannot be deleted because it is currently active. Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.58.
NOF API Verbs DELETE_DSPU_TEMPLATE unsigned char unsigned char unsigned char unsigned char } DSLU_TEMPLATE; allow_timeout; delayed_logon; reserv1[8]; host_lu[8]; /* /* /* /* /* Allow timeout of host LU? Allow delayed logon to host LU reserved Host LU or Pool name */ */ */ */ */ 3.59.2 Supplied Parameters Supplied parameters are: opcode AP_DELETE_DSPU_TEMPLATE template_name Name of the DSPU template to be deleted, or the DSPU template containing the DSLU templates to be deleted.
NOF API Verbs DELETE_EMULATOR_USER Name of the host LU or host LU pool onto which all the downstream LUs within the range will be mapped. 3.59.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.59.
NOF API Verbs DELETE_EMULATOR_USER unsigned char session_names[10][8]; /* user? /* names of sessions to be /* deleted */ */ */ } DELETE_EMULATOR_USER; 3.60.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_EMULATOR_USER user_name The name of the user. This is an ASCII string of 1–32 characters, padded on the right with spaces if the name is shorter than 32 characters, which must match a previously-defined emulator user name.
NOF API Verbs DELETE_FOCAL_POINT 3.60.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_EMULATOR_USER The specified user name was not defined as an emulation program user name. AP_INVALID_USER_SESSION The specified session name did not match the name of a session defined for this user.
NOF API Verbs DELETE_FOCAL_POINT Management Services category. This may be either one of the category names specified in the MS DisciplineSpecific Application Programs table of Systems Network Architecture: Management Services Reference (see Related Publications), padded with EBCDIC spaces (0x40), or a user-defined category. A user-defined category name is an 8-byte type-1134 EBCDIC string, padded with EBCDIC spaces (0x40) if necessary. type Specifies the type of the focal point that is being deleted.
NOF API Verbs DELETE_INTERNAL_PU 3.61.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.62 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. 3.62.
NOF API Verbs DELETE_LOCAL_LU 3.62.5 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. 3.62.
NOF API Verbs DELETE_LS AP_DELETE_LOCAL_LU lu_name Name of the local LU to be deleted. 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. 3.63.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.63.
NOF API Verbs DELETE_LS unsigned char } DELETE_LS; ls_name[8]; /* name of link station */ 3.64.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_LS ls_name Name of link station being deleted. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. 3.64.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.64.
NOF API Verbs DELETE_LS_ROUTING 3.64.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.65 DELETE_LS_ROUTING The DELETE_LS_ROUTING verb deletes the association of a partner LU to a link station that was previously defined using the DEFINE_LS_ROUTING verb. 3.65.
NOF API Verbs DELETE_LS_ROUTING AP_NO The fq_partner_lu parameter does not contain a wildcard entry. 3.65.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.65.
NOF API Verbs DELETE_LU62_TIMEOUT 3.65.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.66 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. 3.66.
NOF API Verbs DELETE_LU_0_TO_3 • If resource_type is set to AP_LOCAL_LU_TIMEOUT, specify 1–8 locally displayable type-A characters as a local LU name. • If resource_type is set to AP_PARTNER_LU_TIMEOUT, specify the fully qualified name of the partner LU as follows: 17 locally displayable type-A characters consisting of a 1–8 character network name, followed by a period, followed by a 1–8 character partner LU name.
NOF API Verbs DELETE_LU_0_TO_3 3.67.1 VCB Structure typedef struct delete_lu_0_to_3 { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char lu_name[8]; } DELETE_LU_0_TO_3; /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code LU name */ */ */ */ */ */ 3.67.
NOF API Verbs DELETE_LU_0_TO_3_RANGE Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.67.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.68 DELETE_LU_0_TO_3_RANGE This verb is used to delete a range of LUs used for 3270 emulation, RJE or LUA (type 0–3 LUs).
NOF API Verbs DELETE_LU_0_TO_3_RANGE 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. The numbers are specified in decimal and the base_name parameter can contain only five characters. AP_USE_BASE_NUMBER Start deleting the LUs in the range from the value specified in the base_number parameter.
NOF API Verbs DELETE_LU_LU_PASSWORD AP_INVALID_LU_NAME There were no LUs defined with names in the specified range. Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.68.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs DELETE_LU_POOL 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. 3.69.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.69.
NOF API Verbs DELETE_LU_POOL unsigned char AP_UINT16 AP_UINT32 unsigned char AP_UINT16 unsigned char } DELETE_LU_POOL; format; primary_rc; secondary_rc; pool_name[8]; num_lus; lu_names[10][8]; /* /* /* /* /* /* reserved primary return code secondary return code LU pool name Number of specified LUs LU names */ */ */ */ */ */ 3.70.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_LU_POOL pool_name Name of the LU pool.
NOF API Verbs DELETE_MODE The supplied num_lus parameter was not in the valid range. 3.70.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.71 DELETE_MODE DELETE_MODE deletes the definition of a mode. You cannot delete SNA-defined modes such as SNASVCMG and CPSVCMG. 3.71.
NOF API Verbs DELETE_PARTNER_LU Possible values are: AP_CP_OR_SNA_SVCMG_UNDELETABLE The specified mode name is one of the SNA-defined mode names, and cannot be deleted. AP_MODE_NAME_NOT_DEFD The specified mode name is not the name of a mode defined on the SNAplus2 system. AP_DEL_MODE_DEFAULT_SPCD The specified mode was defined as the default mode using the DEFINE_DEFAULTS verb, so it cannot be deleted.
NOF API Verbs DELETE_PORT 3.72.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.72.4 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_PLU_NAME The supplied fqplu_name parameter did not match any defined partner LU name.
NOF API Verbs DELETE_RCF_ACCESS opcode AP_DELETE_PORT port_name Name of port being deleted. This is an 8-byte ASCII string, right-padded with spaces if the name is shorter than 8 characters. 3.73.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.73.
NOF API Verbs DELETE_RJE_WKSTN 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. SNAplus2 acts on the RCF access parameters during node startup; if RCF access is deleted while a node is running, the change does not take effect on the server where the node is running until the node is stopped and restarted. 3.74.
NOF API Verbs DELETE_SECURITY_ACCESS_LIST AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char } DELETE_RJE_WKSTN; opcode; reserv2; format; primary_rc; secondary_rc; workstation_name[4]; /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code workstation name */ */ */ */ */ */ 3.75.
NOF API Verbs DELETE_SECURITY_ACCESS_LIST 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. Deleting the user name does not affect the active conversations, but the invoking program will not be able to set up any further conversations using the deleted user name. 3.76.
NOF API Verbs DELETE_TN3270_ACCESS primary_rc AP_OK 3.76.4 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 specified security access list name was not 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. 3.
NOF API Verbs DELETE_TN3270_ACCESS /* to delete */ } TN3270_SESSION_NAME; 3.77.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_TN3270_ACCESS default_record 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.
NOF API Verbs DELETE_TN3270_ASSOCIATION primary_rc AP_OK 3.77.4 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_CLIENT_ADDRESS The specified client address did not match the TCP/IP address defined for any TN3270 user. AP_INVALID_PORT_NUMBER The specified TCP/IP port number did not match any TCP/IP port number defined for this user.
NOF API Verbs DELETE_TP display_lu_name Specifies the name of the display LU whose association is to be deleted. This is an EBCDIC string padded on the right with EBCDIC spaces. 3.78.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.78.
NOF API Verbs DELETE_TP_LOAD_INFO AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char } DELETE_TP; opcode; reserv2; format; primary_rc; secondary_rc; tp_name[64]; /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code TP name */ */ */ */ */ */ 3.79.2 Supplied Parameters The application supplies the following parameters: opcode AP_DELETE_TP tp_name Name of the TP to be deleted. 3.79.
NOF API Verbs DELETE_TP_LOAD_INFO 3.80.1 VCB Structure typedef struct delete_tp_load_info { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char tp_name[64]; unsigned char lu_alias[8]; } DELETE_TP_LOAD_INFO; /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code TP name LU alias */ */ */ */ */ */ */ 3.80.
NOF API Verbs DELETE_USERID_PASSWORD Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.80.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.81 DELETE_USERID_PASSWORD DELETE_USERID_PASSWORD deletes a password associated with a user ID, or removes profiles for a user ID and password. 3.81.
NOF API Verbs DELETE_USERID_PASSWORD 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. If delete_type is set to AP_REMOVE_USER, this parameter is reserved. password_chars.password This parameter is ignored. password_chars.profiles Profiles associated with user.
NOF API Verbs DISCONNECT_NODE 3.82 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 INIT_NODE 3.82.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.83 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. 3.83.
NOF API Verbs INITIALIZE_SESSION_LIMIT 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. AP_DLUR_NOT_SUPPORTED The configuration of the node specifies that DLUR is supported, but the node is defined as a LEN node.
NOF API Verbs INITIALIZE_SESSION_LIMIT unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char unsigned char unsigned char unsigned char reserv2; format; primary_rc; secondary_rc; lu_name[8]; lu_alias[8]; plu_alias[8]; fqplu_name[17]; unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 reserv3; mode_name[8]; reserv3a; set_negotiable; plu_mode_session_limit; min_conwinners_source; AP_UINT16 min_conwinners_target; AP_UINT16 auto_act; unsigned char reserv4[4]; AP_UINT32 sen
NOF API Verbs INITIALIZE_SESSION_LIMIT set_negotiable Specifies whether the maximum negotiable session limit for this mode, as defined by DEFINE_MODE, should be modified. Possible values are: AP_YES Use the value specified by plu_mode_session_limit as the maximum negotiable session limit for this LU-LU-mode combination. AP_NO Leave the maximum negotiable session limit as the value specified for the mode.
NOF API Verbs INITIALIZE_SESSION_LIMIT secondary_rc Possible values are: AP_EXCEEDS_MAX_ALLOWED The plu_mode_session_limit, min_conwinners_source, min_conwinners_target, or auto_act parameter was set to a value outside the valid range. AP_CANT_CHANGE_TO_ZERO The plu_mode_session_limit parameter cannot be set to zero using this verb; SET_SESSION_LIMIT instead. use RE- AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias.
NOF API Verbs OPEN_FILE sense_data The SNA sense data associated with the allocation failure. 3.84.7 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 initialized because of a condition that requires action (such as a configuration mismatch or a session protocol error).
NOF API Verbs OPEN_FILE typedef struct config_file { unsigned char requested_role; unsigned char role_supplied; unsigned char system_name[128]; unsigned char } CONFIG_FILE; file_name[81]; /* /* /* /* /* config file requested config file returned computer name where file located file name */ */ */ */ */ 3.85.2 Supplied Parameters The application supplies the following parameters: opcode AP_OPEN_FILE file_info.requested_role The type of file to be opened.
NOF API Verbs OPEN_FILE For all other values of requested_role, this parameter is undefined. file_info.system_name Name of the SNAplus2 computer where the file is located. file_info.file_name Name of the file. This parameter is an ASCII string of 1–80 characters, followed by a null (0x00) character. 3.85.
NOF API Verbs PATH_SWITCH • 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 Migration Guide for information about upgrading it. • There was a version mismatch between components of the SNAplus2 software.
NOF API Verbs PATH_SWITCH 3.86.4 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_RTP_CONNECTION The value specified for the rtp_connection_name parameter did not match the name of an existing RTP connection. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.86.
NOF API Verbs QUERY_3270_DIAG primary_rc AP_INVALID_VERB secondary_rc (No secondary return code is returned.) 3.86.9 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.87 QUERY_3270_DIAG QUERY_3270_DIAG returns information about the 3270 diagnostics parameters for the SNAplus2 system.
NOF API Verbs QUERY_3270_DIAG } DIAG_3270_DATA; typedef struct alert_3270_data { AP_UINT16 overlay_size; unsigned char description[53]; unsigned char parameter1[33]; unsigned char parameter2[33]; unsigned char parameter3[33]; unsigned char reserv1[8]; } ALERT_3270_DATA; /* /* /* /* /* /* reserved description parameter 1 parameter 2 parameter 3 reserved */ */ */ */ */ */ 3.87.
NOF API Verbs QUERY_3270_DIAG 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 alert entries that could have been returned. This may be higher than num_entries. num_entries The number of alert entries actually returned.
NOF API Verbs QUERY_3270_USER 3.88 QUERY_3270_USER QUERY_3270_USER returns information about 3270 emulation program users. It can return either summary or detailed information, about a single user or multiple users, depending on the options used.
NOF API Verbs QUERY_3270_USER unsigned char } USER_3270_DETAIL; reserv3[4]; /* reserved */ 3.88.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_3270_USER 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. To request data for a specific user rather than a range, specify the value 1.
NOF API Verbs QUERY_3270_USER 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. AP_USER_PROCESS Return information about a specific copy of the 3270 emulation program, identified by the 3270 user name, computer name, and process ID.
NOF API Verbs QUERY_3270_USER Total number of entries that could have been returned. This may be higher than num_entries. num_entries The number of entries actually returned. Each entry in the data buffer consists of the following: user_3270_summary.overlay_size The size of the returned user_3270_summary structure, and therefore the offset to the start of the next entry in the data buffer.
NOF API Verbs QUERY_3270_USER_SESSIONS 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). 3.88.
NOF API Verbs QUERY_3270_USER_SESSIONS unsigned char reserv3[5]; unsigned char user_name[32]; unsigned char system_name[128]; AP_UINT32 user_pid; unsigned char lu_name[8]; } QUERY_3270_USER_SESSIONS; typedef struct user_3270_session_summary { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char reserv1[4]; } USER_3270_SESSION_SUMMARY; typedef struct user_3270_session_detail { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char nau_address; unsigned char sess_type; unsigned char res
NOF API Verbs QUERY_3270_USER_SESSIONS 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 application can obtain specific entries from the list, see Section 2.7, List Options For QUERY_* Verbs. user_name The name of the 3270 user for whom information is required; this is an ASCII string of 1–32 characters. This parameter must be specified.
NOF API Verbs QUERY_3270_USER_SESSIONS 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. system_name 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.
NOF API Verbs QUERY_ACTIVE_TRANSACTION The user_name, system_name, or user_pid parameter was not set to a valid value. AP_INVALID_3270_SESSION The lu_name parameter was not set to a valid value. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.89.
NOF API Verbs QUERY_ACTIVE_TRANSACTION unsigned char fq_dest_cp_name[17]; unsigned char unsigned char dest_ms_appl_name[8]; fq_req_loc_cp_name[17]; unsigned char req_agent_appl_name[8]; unsigned char seq_num_dt[17]; unsigned char reserva[20]; } ACTIVE_TRANSACTION_DATA; /* /* /* /* /* /* /* /* /* /* origin cp name of transaction destination appl name of transaction dest fq cp name of transaction requestor appl name of transaction requestor sequence number date/time reserved */ */ */ */ */ */ */ */
NOF API Verbs QUERY_ACTIVE_TRANSACTION This name is normally an 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 SNA Management Services Reference. The string must be 8 characters long; pad on the right with EBCDIC space characters (0x40) if necessary. seq_num_dt Sequence number date/time correlator (17 bytes long) of the original transaction, as defined in the IBM SNA Formats manual.
NOF API Verbs QUERY_ACTIVE_TRANSACTION active_transaction_data.dest_ms_appl_name Application name of the destination application for the transaction. 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_ADJACENT_NN 3.91 QUERY_ADJACENT_NN The QUERY_ADJACENT_NN verb returns information about adjacent network nodes (the network nodes to which CP-CP sessions are active or have been active at some time). It can be used only if the SNAplus2 node is a network node, and is not valid if it is an end node or LEN node. This verb can be used to obtain information about a specific adjacent network node, or about multiple adjacent network nodes, depending on the options used.
NOF API Verbs QUERY_ADJACENT_NN Maximum number of adjacent NNs for which data should be returned. To request data for a specific adjacent NN 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 of adjacent NNs from which SNAplus2 should begin to return data.
NOF API Verbs QUERY_ADJACENT_NN operator. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. adj_nncp_data.adj_nncp_name Fully qualified name of the adjacent NN. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF API Verbs QUERY_AVAILABLE_TP primary_rc AP_FUNCTION_NOT_SUPPORTED The local node is an end node or LEN node. This verb is valid only at a network node. 3.91.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_AVAILABLE_TP opcode AP_QUERY_AVAILABLE_TP 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 TPs for which data should be returned. To request data for a specific TP rather than a range, specify the value 1.
NOF API 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_BCK_CS_TRACE 3.93 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). It is used only when you are in the processs of migrating a client-server SNAplus2 system to a new release of the software, so that one or more servers are running the current-level software and providing support for computers running the back-level software.
NOF API Verbs QUERY_BUFFER_AVAILABILITY Text strings describing UDP events AP_BCK_TCP_TEXT Text strings describing TCP events AP_BCK_TEXT Text strings describing other events AP_BCK_MS_TRACE Tracing on TRANSFER_MS_DATA verbs (passed to the MS library on the server) 3.93.4 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_BUFFER_AVAILABILITY AP_UINT32 max_buf_res_use_bytes; AP_UINT32 max_peak_usage; unsigned char max_throttle_status; unsigned char max_buf_use_status; unsigned char debug_param[32]; unsigned char reserv3[8]; } QUERY_BUFFER_AVAILABILITY; /* /* /* /* /* /* max rsrv buffer usage - bytes maximum peak usage maximum throttle status maximum congestion status reserved reserved */ */ */ */ */ */ 3.94.
NOF API Verbs QUERY_BUFFER_AVAILABILITY buf_res_use_count The number of reserved buffers in use. buf_res_use_bytes The number of bytes in the reserved buffers currently in use. peak_usage Peak buffer usage—smoothed percentage of buffers that are actually used. peak_decay Smoothing parameter. throttle_status Adaptive pacing status. buf_use_status Congestion status.
NOF API Verbs QUERY_CENTRAL_LOGGER 3.95 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. 3.95.
NOF API Verbs QUERY_CENTRAL_LOGGING 3.95.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.96 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 Section 3.179, SET_LOG_FILE.
NOF API Verbs QUERY_CN 3.96.4 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. 3.96.
NOF API Verbs QUERY_CN unsigned char unsigned char } QUERY_CN; reserv3; fqcn_name[17]; typedef struct cn_data { AP_UINT16 overlay_size; unsigned char fqcn_name[17]; unsigned char reserv1; CN_DET_DATA det_data; CN_DEF_DATA def_data; } CN_DATA; typedef struct cn_det_data { AP_UINT16 num_act_ports; unsigned char reserva[20]; } CN_DET_DATA; typedef struct cn_def_data { unsigned char description[32]; unsigned char reserve0[16]; unsigned char num_ports; unsigned char cn_type; unsigned char reserve1[15]; TG_DEF
NOF API Verbs QUERY_CN Maximum number of CNs for which data should be returned. To request data for a specific CN 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 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.
NOF API Verbs QUERY_CN cn_data.fqcn_name 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_data.det_data.num_act_ports The number of active ports on the connection network. cn_data.def_data.description A null-terminated text string describing the CN, as specified in the definition of the CN. cn_data.def_data.
NOF API Verbs QUERY_CN 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). AP_PROP_DELAY_MAXIMUM Maximum propagation delay.
NOF API Verbs QUERY_CN_PORT 3.98 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 a network node or an end node; it is not valid at a LEN node. 3.98.
NOF API Verbs QUERY_CN_PORT The position in the list of ports 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 port_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the port_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.
NOF API Verbs QUERY_CONVERSATION cn_port_data.fqcn_name 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.
NOF API Verbs QUERY_CONVERSATION 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. 3.99.
NOF API Verbs QUERY_CONVERSATION Maximum number of conversations for which data should be returned. To request data for a specific conversation rather than a range, specify the value 1. 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_CONVERSATION 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_COS AP_END_CONV_STATE AP_PEND_DEALL_STATE AP_PEND_POST_STATE AP_POST_ON_RECEIPT_STATE AP_RECEIVE_STATE AP_RESET_STATE AP_SEND_STATE AP_SEND_PENDING_STATE 3.99.
NOF API Verbs QUERY_COS unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char AP_UINT32 AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char } QUERY_COS; reserv2; format; primary_rc; secondary_rc; *buf_ptr; buf_size; total_buf_size; num_entries; total_num_entries; list_options; reserv3; cos_name[8]; typedef struct cos_data { AP_UINT16 overlay_size; unsigned char cos_name[8]; unsigned char description[32]; unsigned char reserv1[16]; unsigned char transmission_priority; AP_UINT16
NOF API Verbs QUERY_COS AP_LIST_FROM_NEXT 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 Section 2.7, 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_COS_NODE_ROW AP_NETWORK (the highest priority) cos_data.num_of_node_rows Number of node rows defined for this COS. cos_data.num_of_tg_rows Number of TG rows defined for this COS. cos_data.trees Number of route tree caches built for this COS since the last initialization. cos_data.calcs Number of session activation requests (and therefore route calculations) specifying this class of service. cos_data.
NOF API Verbs QUERY_COS_NODE_ROW 3.101.
NOF API Verbs QUERY_COS_NODE_ROW case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list of COS node 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 node_row_index parameters.
NOF API Verbs QUERY_COS_NODE_ROW When your application needs to go through the returned buffer to find each cos_node_row_data 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. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. cos_node_row_data.
NOF API Verbs QUERY_COS_TG_ROW cos_node_row_data.node_row.weight Weight associated with this node row. 3.101.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_COS_NAME The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the supplied name, but the cos_name parameter was not valid.
NOF API Verbs QUERY_COS_TG_ROW unsigned char AP_UINT16 } QUERY_COS_TG_ROW; cos_name[8]; tg_row_index; typedef struct cos_tg_row_data { AP_UINT16 overlay_size; unsigned char cos_name[8]; AP_UINT16 tg_row_index; COS_TG_ROW tg_row; } COS_TG_ROW_DATA; typedef struct cos_tg_row { TG_DEFINED_CHARS minimum; TG_DEFINED_CHARS maximum; unsigned char weight; unsigned char reserv1; } COS_TG_ROW; typedef struct tg_defined_chars { unsigned char effect_cap; unsigned char reserve1[5]; unsigned char connect_cost; unsigne
NOF API Verbs QUERY_COS_TG_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 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. The list is ordered by cos_name, and then by tg_row_index for each COS.
NOF API Verbs QUERY_COS_TG_ROW cos_tg_row_data.tg_row_index TG row index (the first row has an index of zero). 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_COS_TG_ROW Delay is greater than 245,760 microseconds (typical for a satellite link). AP_PROP_DELAY_MAXIMUM Maximum propagation delay. cos_tg_row_data.tg_row.minimum.user_def_parm_1 cos_tg_row_data.tg_row.minimum.user_def_parm_3 through 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.
NOF API Verbs QUERY_CPIC_SIDE_INFO 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 QUERY_CPIC_SIDE_INFO 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. The CPI-C function queries the application’s own copy in memory of the side information table, which the application may have modified using the other CPI-C side information functions. This verb must be issued to the domain configuration file. 3.103.
NOF API Verbs QUERY_CPIC_SIDE_INFO opcode AP_QUERY_CPIC_SIDE_INFO 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 symbolic destination names for which data should be returned. To request data for a specific symbolic destination name rather than a range, specify the value 1.
NOF API Verbs QUERY_CPIC_SIDE_INFO Each entry in the data buffer consists of the following parameters: cpic_side_info_data.overlay_size The size of the returned cpic_side_info_data structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each cpic_side_info_data 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_CPIC_SIDE_INFO As for XC_SECURITY_PROGRAM, except that the local node must not send the password across the network in clear text format. This value can be used only if the remote system supports password substitution. XC_SECURITY_SAME The target TP uses conversation security, and can accept an “already verified” indicator from the local TP. (This indicates that the local TP was itself invoked by another TP, and has verified the security user ID and password supplied by this TP.
NOF API Verbs QUERY_CS_TRACE 3.104 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 must be issued to a running node. 3.104.
NOF API Verbs QUERY_CS_TRACE The types of tracing currently active. For more information about these trace types, see Section 3.176, SET_CS_TRACE. 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_DEFAULT_PU 3.104.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.105 QUERY_DEFAULT_PU QUERY_DEFAULT_PU allows the user to query the default PU (defined using DEFINE_DEFAULT_PU). 3.105.
NOF API Verbs QUERY_DEFAULTS the previous default PU until the session associated with the defined default PU becomes active. In this case, this parameter specifies the name of the previous default PU, and is different from the def_pu_name field. If there are no active PU sessions, this field will be set to all binary zeros. 3.105.
NOF API Verbs QUERY_DEFAULTS 3.106.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK default_chars.description A null-terminated text string describing the default parameters, as specified in DEFINE_DEFAULTS. default_chars.mode_name Name of the default mode.
NOF API Verbs QUERY_DIRECTORY_ENTRY 3.107 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. If the verb is issued to a running node, it returns information both on resources that have been defined explicitly (using DEFINE_DIRECTORY_ENTRY, or DEFINE_ADJACENT_LEN_NODE) and on resources that have been located dynamically.
NOF API Verbs QUERY_DIRECTORY_ENTRY unsigned char description[32]; /* resource description unsigned char reserv1[16]; /* reserved AP_UINT16 real_owning_cp_type; /* CP type of real owner unsigned char real_owning_cp_name[17]; /* CP name of real owner unsigned char reserve2; /* reserved } DIRECTORY_ENTRY_SUMMARY; */ */ */ */ */ typedef struct directory_entry_detail { AP_UINT16 overlay_size; /* size of this entry */ unsigned char resource_name[17]; /* network qualified res name */ unsigned char reserv1a; /*
NOF API Verbs QUERY_DIRECTORY_ENTRY 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 parent_name, resource_name, and resource_type parameters. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of the parent_name, resource_name, and resource_type parameters. The list is ordered by parent_name, then by resource_name, and lastly by resource_type.
NOF API Verbs QUERY_DIRECTORY_ENTRY 3.107.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_DIRECTORY_ENTRY AP_NONE The real owner is the parent resource. AP_ENCP_RESOURCE The real owner is an end node that is not the parent resource. For example, if the resource is owned by an End Node in the domain of a Branch Network Node (BrNN), the directory of this BrNN’s Network Node Server includes the BrNN as the parent resource, but the real owning CP is the End Node. directory_entry_summary.
NOF API Verbs QUERY_DIRECTORY_ENTRY AP_ENCP_RESOURCE 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. AP_REGISTER Registered resource (NN only). directory_entry_detail.location Specifies the location of the resource.
NOF API Verbs QUERY_DIRECTORY_LU Specifies whether this directory entry was registered by another node that is not the owning CP of the resource. This is one of the following: AP_NONE The directory entry was not registered, or was registered by its owning CP. AP_ENCP_RESOURCE The directory entry was registered by a node that is not its owning CP.
NOF API Verbs QUERY_DIRECTORY_LU This verb must be issued to a running node. 3.108.
NOF API Verbs QUERY_DIRECTORY_LU Maximum number of LUs for which data should be returned. To request data for a specific LU rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer. list_options The position in the list from which SNAplus2 should begin to return data, and the level of information required for each entry.
NOF API Verbs QUERY_DIRECTORY_LU Each entry in the data buffer consists of the following parameters: directory_lu_summary.overlay_size The size of the returned directory_lu_summary structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each directory_lu_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_DIRECTORY_LU The resource is not within the domain of the local node. directory_lu_detail.entry_type Specifies the type of the resource. This is one of the following: AP_HOME Local resource. AP_CACHE Cached entry. AP_REGISTER Registered resource (NN only). 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.
NOF API Verbs QUERY_DIRECTORY_STATS The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.108.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_DIRECTORY_STATS AP_QUERY_DIRECTORY_STATS 3.109.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK max_caches For a network node, the maximum number of cache entries allowed. cur_caches For a network node, the current number of cache entries. cur_home_entries Current number of home entries. cur_reg_entries Current number of registered entries.
NOF API Verbs QUERY_DLC not_found_bcast_locates For a network node, the number of broadcast locates returned “not found”. locates_outstanding Current number of outstanding locates, both directed and broadcast. 3.109.4 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.110 QUERY_DLC QUERY_DLC returns information about DLCs.
NOF API 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; /* Defined data */ /* State of the DLC /* reserved /* reserved */ */ */ 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 hpr_only; /* unsigned
NOF API Verbs QUERY_DLC 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 dlc_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the dlc_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.7, List Options For QUERY_* Verbs.
NOF API Verbs QUERY_DLC dlc_summary.state State of the DLC. This is one of the following: AP_ACTIVE The DLC is active. AP_NOT_ACTIVE The DLC is not active. AP_PENDING_INACTIVE STOP_DLC is in progress. dlc_summary.dlc_type Type of DLC. This is one of the following: AP_SDLC SDLC AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI AP_IP Enterprise Extender (HPR/IP) dlc_detail.
NOF API Verbs QUERY_DLC A null-terminated text string describing the DLC, as specified in the definition of the DLC. dlc_detail.def_data.initially_active Specifies whether this DLC is automatically started when the node is started. Possible values are: AP_YES The DLC is automatically started when the node is started. AP_NO The DLC is not automatically started; it must be started manually. dlc_detail.def_data.dlc_type Type of DLC.
NOF API Verbs QUERY_DLC_TRACE Unpadded length, in bytes, of data specific to the type of DLC. The data structure for this data follows the def_data structure, but is padded to start on a 4-byte boundary. For more details of the DLC-specific data, see Section 3.19, DEFINE_DLC. 3.110.
NOF API Verbs QUERY_DLC_TRACE DLC_TRACE_FILTER } QUERY_DLC_TRACE; filter_entry; typedef struct dlc_trace_data { AP_UINT16 overlay_size; DLC_TRACE_FILTER filter; } DLC_TRACE_DATA; typedef struct dlc_trace_filter { unsigned char resource_type; unsigned char resource_name[8]; SNA_LFSID lfsid; unsigned char message_type; } DLC_TRACE_FILTER; typedef struct sna_lfsid { union { AP_UINT16 struct { unsigned char unsigned char } s; } uu; AP_UINT16 } SNA_LFSID; /* resource to start at */ /* size of returned en
NOF API Verbs QUERY_DLC_TRACE AP_LIST_INCLUSIVE Start at the entry specified by the filter_entry structure. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the filter_entry structure. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.7, List Options For QUERY_* Verbs. list_type The type of resource for which to list tracing options.
NOF API Verbs QUERY_DLC_TRACE The required entry specifies tracing options for the LS named in resource_name. AP_RTP_RESOURCE_TYPE The required entry specifies tracing options for the RTP connection named in the resource_name parameter. AP_PORT_DEFINED_LS 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.
NOF API Verbs QUERY_DLC_TRACE overlay_size The size of the returned dlc_trace_data structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each dlc_trace_data 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_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_NLP (this message type is currently not used) AP_TRACE_NC (this message type is currently not used) AP_TRACE_SEGS Non-BBIU segments that do not contain an RH AP_TRACE_CTL Messages other then MUs and XIDs 3.111.
NOF API Verbs QUERY_DLUR_DEFAULTS 3.112 QUERY_DLUR_DEFAULTS The QUERY_DLUR_DEFAULTS verb allows the user to query the defaults defined using the DEFINE_DLUR_DEFAULTS verb. 3.112.
NOF API Verbs QUERY_DLUR_LU Specifies how SNAplus2 operates when it receives a negative RSP(REQACTPU) from DLUS, or is attempting to reactivate a failed DLUR PU. Possible values are: AP_YES If either the default primary DLUS or default backup DLUS is active, SNAplus2 will attempt to activate or reactivate the PU by using the active DLUS only. AP_NO SNAplus2 will attempt to activate or reactivate the PU by using the standard retry logic. 3.112.
NOF API Verbs QUERY_DLUR_LU AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char } QUERY_DLUR_LU; total_buf_size; num_entries; total_num_entries; list_options; reserv3; lu_name[8]; pu_name[8]; filter; typedef struct dlur_lu_summary { AP_UINT16 overlay_size; unsigned char lu_name[8]; } DLUR_LU_SUMMARY; typedef struct dlur_lu_detail { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char pu_name[8]; unsigned char dlus_name[17]; unsigned char unsigned
NOF API 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_DLUR_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_DLUR_LU AP_INTERNAL LU is on the local node. AP_DOWNSTREAM LU is on a downstream node (network node only). dlur_lu_detail.nau_address Network accessible unit address of the LU. dlur_lu_detail.plu_name If the PLU-SLU session is active, this field contains the name of the PLU; otherwise it is set to 17 binary zeros. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs QUERY_DLUR_PU 3.114 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. If this verb is issued to an inactive node, it returns information only about PUs defined at the local node; if it is issued to a running node, it also returns information about active downstream PUs using DLUR at this node. 3.114.
NOF API Verbs QUERY_DLUR_PU } DLUR_PU_DETAIL; typedef struct fqpcid { unsigned char pcid[8]; unsigned char fqcp_name[17]; unsigned char } FQPCID; reserve3[3]; /* procedure correlator identifier */ /* originator’s network qualified */ /* CP name */ /* reserved */ 3.114.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_DLUR_PU 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_DLUR_PU dlus_name DLUS name for which PU information is required. To list only information about PUs associated with a specific DLUS, specify the DLUS name; a PU will be listed only if it has an SSCP-PU session to the specified DLUS node. To obtain a complete list for all DLUSs, set this field to binary zeros. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs QUERY_DLUR_PU dlur_pu_summary.pu_name Name of the PU. 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_pu_summary.description A null-terminated text string describing the PU, as specified in the definition of the PU. If the PU is an active downstream PU, rather than a defined internal PU, this parameter is reserved. dlur_pu_detail.
NOF API Verbs QUERY_DLUR_PU This is set to one of the following. AP_INTERNAL PU is on the local node. AP_DOWNSTREAM PU is on a downstream node (network node only). dlur_pu_detail.active_dlus_name Name of DLUS node that the PU is currently using. If the SSCP-PU session is not active, this field will be set to all binary zeros. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs QUERY_DLUR_PU The pipe is in the process of being deactivated. AP_INACTIVE The pipe is not active. dlur_pu_detail.fqpcid.pcid Procedure Correlator ID used on the pipe. This is an 8-byte hexadecimal string. If the SSCP-PU session is not active this field will be set to binary zeros. dlur_pu_detail.fqpcid.fqcp_name Fully qualified Control Point name used on the pipe. If the SSCP-PU session is not active this field will be set to binary zeros.
NOF API Verbs QUERY_DLUS primary_rc AP_FUNCTION_NOT_SUPPORTED The local node does not support DLUR; this is defined by the dlur_support parameter on the DEFINE_NODE verb. 3.114.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.115 QUERY_DLUS QUERY_DLUS returns information about DLUS nodes known to the DLUR feature of SNAplus2.
NOF API Verbs QUERY_DLUS unsigned char } DLUS_DATA; persistent_pipe; 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_pu_m
NOF API Verbs QUERY_DLUS The list is ordered by dlus_name. For more information about how the application can obtain specific entries from the list, see Section 2.7, List Options For QUERY_* Verbs. dlus_name Name of the DLUS for which information is required, or the name to be used as an index into the list of DLUSs. This value is ignored if list_options is set to AP_FIRST_IN_LIST. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces.
NOF API Verbs QUERY_DLUS 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. AP_INACTIVE The pipe is not active. dlus_data.num_active_pus Number of PUs currently using the pipe to the DLUS. dlus_data.pipe_stats.reqactpu_sent Number of REQACTPUs sent to DLUS over the pipe. dlus_data.pipe_stats.reqactpu_rsp_received Number of RSP(REQACTPU)s received from DLUS over the pipe. dlus_data.
NOF API Verbs QUERY_DOMAIN_CONFIG_FILE dlus_data.pipe_stats.sscp_lu_mus_rcvd Number of SSCP-LU MUs received from DLUS over the pipe. dlus_data.pipe_stats.sscp_lu_mus_sent Number of SSCP-LU MUs sent to DLUS over the pipe. 3.115.
NOF API Verbs QUERY_DOWNSTREAM_LU AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char reserv3[8]; CONFIG_FILE_HEADER hdr; } QUERY_DOMAIN_CONFIG_FILE; typedef struct config_file_header { AP_UINT16 major_version; AP_UINT16 minor_version; AP_UINT16 update_release; AP_UINT32 revision_level; unsigned char comment[100]; AP_UINT16 updating; } CONFIG_FILE_HEADER; /* /* /* /* /* /* verb operation code reserved reserved primary return code sec
NOF API Verbs QUERY_DOWNSTREAM_LU Primary RUI application. For more information about Primary RUI, see HP-UX SNAplus2 LUA Programmer’s Guide. The returned 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_DOWNSTREAM_LU unsigned char SESSION_STATS SESSION_STATS reserv1; lu_sscp_stats; ds_plu_stats; SESSION_STATS us_plu_stats; unsigned char unsigned char host_lu_name[8]; host_pu_name[8]; /* /* /* /* /* /* /* /* unsigned char reserva[4]; } DOWNSTREAM_LU_DET_DATA; typedef struct downstream_lu_def_data { unsigned char description[32]; unsigned char reserv1[16]; unsigned char nau_address; unsigned char dspu_name[8]; unsigned char host_lu_name[8]; unsigned char allow_timeout; unsigned ch
NOF API Verbs QUERY_DOWNSTREAM_LU Size of the supplied data buffer. num_entries Maximum number of downstream 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_DOWNSTREAM_LU When the node is not running, this parameter is ignored; SNAplus2 returns information about all downstream LUs. 3.117.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.
NOF API Verbs QUERY_DOWNSTREAM_LU AP_DLUR Downstream LU is served by DLUR. downstream_lu_summary.nau_address Network accessible unit address of the LU. downstream_lu_summary.lu_sscp_sess_active Specifies whether the LU-SSCP session is active. Possible values are: AP_YES The session is active. AP_NO The session is 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.
NOF API Verbs QUERY_DOWNSTREAM_LU When the verb is issued to a running node, this parameter specifies the services provided by the local node to the downstream LU. Possible values are: AP_PU_CONCENTRATION Downstream LU is served by PU concentration. 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).
NOF API Verbs QUERY_DOWNSTREAM_LU Number of normal flow data bytes received. sidh Session ID high byte. (In the upstream PLU-SLU session statistics for an LU served by PU concentration, this parameter is reserved.) sidl Session ID low byte. (In the upstream PLU-SLU session statistics for an LU served by PU concentration, this parameter is reserved.) odai Origin Destination Assignor Indicator.
NOF API Verbs QUERY_DOWNSTREAM_LU downstream_lu_detail.allow_timeout Specifies whether this downstream LU allows its session with the upstream LU to timeout. Possible values are: AP_YES This downstream LU allows its session with the upstream LU to timeout. AP_NO This downstream LU does not allow its session with the upstream LU to timeout. This field is ignored if the downstream LU is used to communicate with a SNAplus2 Primary RUI application instead of a host. downstream_lu_detail.
NOF API Verbs QUERY_DOWNSTREAM_PU Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.117.
NOF API Verbs QUERY_DOWNSTREAM_PU unsigned char pu_sscp_sess_active; unsigned char dspu_services; SESSION_STATS pu_sscp_stats; unsigned char reserva[20]; } DOWNSTREAM_PU_DATA; typedef struct session_stats { AP_UINT16 rcv_ru_size; AP_UINT16 send_ru_size; AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsig
NOF API 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 Section 2.7, 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_DOWNSTREAM_PU downstream_pu_data.dspu_name Name of the downstream PU. 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_pu_data.description A null-terminated text string describing the LS to the downstream PU, as specified in the definition of the LS. downstream_pu_data.ls_name Name of the LS used to access the downstream PU.
NOF API 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.rcv_fmd_data_frames Number of normal flow FMD data frames received.
NOF API Verbs QUERY_DSPU_TEMPLATE 3.118.5 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 PU concentration or DLUR; this is defined by the pu_conc_support and dlur_support parameters on the DEFINE_NODE verb. 3.118.
NOF API Verbs QUERY_DSPU_TEMPLATE } DSPU_TEMPLATE_DATA; 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_DSPU_TEMPLATE template_name Name of the DSPU template for which information is required, or the name to be used as an index into the list. This is an 8-byte string in a locally displayable character set. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. 3.119.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 buffer.
NOF API Verbs QUERY_DSPU_TEMPLATE C sizeof() operator. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. dslu_template_data.min_nau Minimum NAU address in the range of DSLU templates. dslu_template_data.max_nau Maximum NAU address in the range of DSLU templates. dslu_template_data.
NOF API Verbs QUERY_EMULATOR_USER_DEF 3.119.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.120 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.
NOF API Verbs QUERY_EMULATOR_USER_DEF AP_UINT16 sub_overlay_offset; /* /* unsigned char user_name[32]; /* AP_UINT32 num_filtered_sessions; /* /* unsigned char reserv4[4]; /* EMULATOR_USER_DEF_DATA def_data; /* } EMULATOR_USER_DETAIL; typedef struct emulator_user_def_data { unsigned char description[32]; unsigned char reserv3[16]; unsigned char style_file[9]; unsigned char AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char reserv1[3]; num_sessions; max_act_sessions
NOF API Verbs QUERY_EMULATOR_USER_DEF unsigned char mode_name[8]; unsigned char session_type; } SESSION_5250_DEF_DATA; /* Mode name /* Session type - display or printer */ */ 3.120.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_EMULATOR_USER_DEF 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_EMULATOR_USER_DEF session_name To return information starting with a specific session name for the specified user, set this parameter to the session name. To return information starting at the first session for the specified user, set this parameter to 8 binary zeros. emulator_type Specify whether to filter the returned information by session type. Possible values are: AP_3270_SESSION Return only information about 3270 sessions.
NOF API Verbs QUERY_EMULATOR_USER_DEF 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. At least one session structure is included, but there are further session structures that are not included in the data buffer. The num_last_sessions parameter indicates how many session structures have been returned; the application can issue further verbs to obtain the remaining data.
NOF API Verbs QUERY_FOCAL_POINT • The num_sessions parameter in the def_data structure defines the total number of sessions (3270, 5250, or both) defined for the user. • If the session_name parameter was set to a nonzero value, the data for the first user will contain only the remaining session structures (starting from the requested entry), without the def_data structure.
NOF API Verbs QUERY_FOCAL_POINT AP_UINT32 buf_size; AP_UINT32 total_buf_size; AP_UINT16 num_entries; AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char ms_category[8]; } QUERY_FOCAL_POINT; /* /* /* /* /* /* /* typedef struct fp_data { AP_UINT16 overlay_size; unsigned char ms_appl_name[8]; unsigned char ms_category[8]; unsigned char description[32]; unsigned char reserv1[16]; unsigned char fp_fqcp_name[17]; unsigned char unsigned char unsigned char unsigned char
NOF API 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 Section 2.7, List Options For QUERY_* Verbs. ms_category Management Services category.
NOF API Verbs QUERY_FOCAL_POINT fp_data.ms_category Management Services category. This is either one of the category names specified in the Systems Network Architecture: Management Services Reference (see Related Publications), or an EBCDIC string, using type1134 characters, padded on the right with spaces if the name is shorter than 8 characters. fp_data.description A null-terminated text string describing the focal point, as specified in the definition of the focal point. fp_data.
NOF API Verbs QUERY_FOCAL_POINT AP_PENDING The focal point is pending active. This occurs after an implicit request has been sent to the focal point and before the response has been received. AP_NEVER_ACTIVE No focal point information is available for the specified category although application registrations for the category have been accepted. fp_data.fp_routing Specifies whether applications should use default or direct routing to route traffic to the focal point.
NOF API Verbs QUERY_GLOBAL_LOG_TYPE 3.121.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.122 QUERY_GLOBAL_LOG_TYPE This verb allows a NOF application to determine the types of information that SNAplus2 records in log files.
NOF API Verbs QUERY_GLOBAL_LOG_TYPE AP_QUERY_GLOBAL_LOG_TYPE 3.122.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. audit This parameter indicates whether audit messages are recorded. Possible values are: AP_YES Audit messages are recorded. AP_NO Audit messages are not recorded. exception This parameter indicates whether exception messages are recorded.
NOF API Verbs QUERY_ISR_SESSION primary_rc AP_PARAMETER_CHECK secondary_rc AP_NOT_CENTRAL_LOGGER The verb was issued to a node that is not the central logger. 3.122.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.123 QUERY_ISR_SESSION QUERY_ISR_SESSION returns list information about the sessions for which a network node is providing intermediate session routing.
NOF API Verbs QUERY_ISR_SESSION typedef struct isr_session_detail { AP_UINT16 overlay_size; AP_UINT16 sub_overlay_size; FQPCID fqpcid; /* size of returned entry /* offset to appended RSCV /* fully qualified procedure /* correlator ID unsigned char trans_pri; /* Transmission priority: unsigned char cos_name[8]; /* Class of Service name unsigned char ltd_res; /* Session spans a limited resource unsigned char reserv1[2]; /* reserved EXTENDED_SESSION_STATS pri_ext_sess_stats; /* primary hop session stats EXTE
NOF API Verbs QUERY_ISR_SESSION AP_UINT32 rcv_data_bytes; AP_UINT32 rcv_fmd_data_bytes; unsigned char sidh; unsigned char sidl; unsigned char odai; unsigned char ls_name[8]; unsigned char pacing_type; unsigned char reserv1[100]; } EXTENDED_SESSION_STATS; /* /* /* /* /* /* /* /* number of data bytes received number of fmd data bytes received session ID high byte (from LFSID) session ID low byte (from LFSID) ODAI bit set link station name type of pacing in use reserved */ */ */ */ */ */ */ */ 3.123.
NOF API Verbs QUERY_ISR_SESSION DLUR-maintained sessions are being queried. AP_ISR_SESSIONS Regular ISR sessions are being queried. fqpcid.pcid Procedure Correlator ID. This is an 8-byte hexadecimal string. This value is ignored if list_options is set to AP_FIRST_IN_LIST. fqpcid.fqcp_name Fully qualified control point name of the session for which information is required, or the name to be used as an index into the list of sessions. This value is ignored if list_options is set to AP_FIRST_IN_LIST.
NOF API Verbs QUERY_ISR_SESSION isr_session_detail.overlay_size The size of the returned isr_session_detail structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each isr_session_detail 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_ISR_SESSION Send residual pacing count. max_rcv_pac_win Maximum size of the receive pacing window. cur_rcv_pac_win Current size of the receive pacing window. rcv_rpc Receive residual pacing count. 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. send_fmd_data_bytes Number of normal flow FMD data bytes sent.
NOF API Verbs QUERY_ISR_SESSION The following parameters are also returned (these parameters are not part of the session_stats structure): isr_session.detail.sess_lu_type The LU type of the session specified on the BIND. Possible values are (LU type 5 is intentionally omitted): AP_LU_TYPE_0 AP_LU_TYPE_1 AP_LU_TYPE_2 AP_LU_TYPE_3 AP_LU_TYPE_4 AP_LU_TYPE_6 AP_LU_TYPE_7 AP_LU_TYPE_UNKNOWN isr_session.detail.sess_lu_level The LU level of the session.
NOF API Verbs QUERY_ISR_SESSION isr_session.detail.sec_lu_name The secondary LU name of the session. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. The name consists of a network ID of 1–8 A-string characters, an EBCDIC dot (period) character, and an LU name of 1–8 A-string characters. If this name is not available, all binary zeros are returned in this field. All binary zeros are always returned unless collection of names has been enabled using DEFINE_ISR_STATS. isr_session.
NOF API Verbs QUERY_KERNEL_MEMORY_LIMIT 3.123.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.124 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.
NOF API Verbs QUERY_LOCAL_LU 3.124.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. limit The maximum amount of kernel memory, in bytes, that SNAplus2 is permitted to use at any time. If a SNAplus2 component attempts to allocate kernel memory that would take the total amount of memory currently allocated to SNAplus2 components above this limit, the allocation attempt will fail.
NOF API Verbs QUERY_LOCAL_LU AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char AP_UINT32 AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char } QUERY_LOCAL_LU; opcode; reserv2; format; primary_rc; secondary_rc; *buf_ptr; buf_size; total_buf_size; num_entries; total_num_entries; list_options; reserv3; lu_name[8]; lu_alias[8]; pu_name[8]; typedef struct local_lu_summary { AP_UINT16 overlay_size; unsigned char lu_name[8]; unsigned char lu_
NOF API Verbs QUERY_LOCAL_LU unsigned char unsigned char SESSION_STATS unsigned char } LOCAL_LU_DET_DATA; appl_conn_active; reserv1[2]; lu_sscp_stats; sscp_id[6]; typedef struct session_stats { AP_UINT16 rcv_ru_size; AP_UINT16 send_ru_size; AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 cur_rcv_pac_win; AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char
NOF API Verbs QUERY_LOCAL_LU 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_LOCAL_LU 3.125.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_LOCAL_LU Name of the security access list FINE_SECURITY_ACCESS_LIST verb). available for use by any user. used by this local LU (defined using the DEIf this parameter is set to 14 binary zeros, the LU is local_lu_detail.def_data.lu_alias LU alias. This is an 8-byte ASCII character string. local_lu_detail.def_data.nau_address Network accessible unit address of the LU. This is in the range 1–255 if the LU is a dependent LU, or zero if the LU is an independent LU. local_lu_detail.
NOF API Verbs QUERY_LOCAL_LU Specifies the ID of the SSCP permitted to activate this LU. It is a 6-byte binary field. This parameter is used only by dependent LUs, and is set to all binary zeros for independent LUs or if the LU can be activated by any SSCP. local_lu_detail.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 QUERY_LOCAL_LU local_lu_detail.det_data.lu_sscp_stats.max_rcv_btu_size Maximum BTU size that can be received. local_lu_detail.det_data.lu_sscp_stats.max_send_pac_win This parameter is always set to zero. local_lu_detail.det_data.lu_sscp_stats.cur_send_pac_win This parameter is always set to zero. local_lu_detail.det_data.lu_sscp_stats.max_rcv_pac_win This parameter is always set to zero. local_lu_detail.det_data.lu_sscp_stats.cur_rcv_pac_win This parameter is always set to zero.
NOF API Verbs QUERY_LOCAL_TOPOLOGY 3.125.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_alias parameter was not valid.
NOF API Verbs QUERY_LOCAL_TOPOLOGY unsigned char dest[17]; unsigned char dest_type; unsigned char tg_num; } QUERY_LOCAL_TOPOLOGY; typedef struct local_topology_summary { AP_UINT16 overlay_size; unsigned char dest[17]; unsigned char dest_type; unsigned char tg_num; } LOCAL_TOPOLOGY_SUMMARY; typedef struct local_topology_detail { AP_UINT16 overlay_size; unsigned char dest[17]; unsigned char dest_type; unsigned char tg_num; unsigned char reserv1; LINK_ADDRESS dlc_data; AP_UINT32 rsn; unsigned char status; TG_
NOF API Verbs QUERY_LOCAL_TOPOLOGY num_entries Maximum number of entries for which data should be returned. To request a specific entry 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_LOCAL_TOPOLOGY Number associated with the TG. This value is ignored if list_options is set to AP_FIRST_IN_LIST. 3.126.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.
NOF API Verbs QUERY_LOCAL_TOPOLOGY When your application needs to go through the returned buffer to find each local_topology_detail 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. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. local_topology_detail.
NOF API Verbs QUERY_LOCAL_TOPOLOGY The CP-CP session is active. AP_NO The CP-CP session is not active. AP_UNKNOWN The CP-CP session status is unknown. local_topology_detail.branch_link_type This parameter applies only if the node is a Branch Network Node; it is reserved otherwise. Specifies the branch link type of this TG. Possible values are: AP_UPLINK The TG is an uplink. AP_DOWNLINK The TG is a downlink to an End Node.
NOF API Verbs QUERY_LOG_FILE primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_TG The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the tg_num parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.126.
NOF API Verbs QUERY_LOG_FILE AP_AUDIT_FILE Audit log file (audit messages only). AP_ERROR_FILE Error log file (problem and exception messages). AP_USAGE_FILE Usage log file (information on current and peak usage of SNAplus2 resources). 3.127.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. file_name Name of the log file.
NOF API Verbs QUERY_LOG_TYPE Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.127.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_LOG_TYPE opcode AP_QUERY_LOG_TYPE 3.128.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK secondary_rc Not used. override Specifies whether the log types and succinct or full logging options returned on this verb are the global log types specified on SET_GLOBAL_LOG_TYPE, or local values specified on SET_LOG_TYPE.
NOF API Verbs QUERY_LS 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_LS unsigned char unsigned char unsigned char unsigned char unsigned char } LS_SUMMARY; det_adj_cp_name[17]; det_adj_cp_type; port_name[8]; adj_cp_name[17]; adj_cp_type; typedef struct ls_detail { AP_UINT16 overlay_size; unsigned char ls_name[8]; LS_DET_DATA det_data; LS_DEF_DATA def_data; } LS_DETAIL; typedef struct ls_det_data { AP_UINT16 act_sess_count; unsigned unsigned unsigned unsigned unsigned unsigned unsigned char char char char char char char unsigned char unsigned char LS_
NOF API Verbs QUERY_LS AP_UINT16 AP_UINT16 unsigned char react_timer_retry; /* retry count for failed LS */ activation_count; /* reserved */ restart_on_normal_deact; /* restart the link on any */ /* failure */ unsigned char reserv3[7]; /* reserved */ unsigned char port_name[8]; /* name of associated port */ unsigned char adj_cp_name[17]; /* adjacent CP name */ unsigned char adj_cp_type; /* adjacent node type */ LINK_ADDRESS dest_address; /* destination address */ unsigned char auto_act_supp; /* auto-activ
NOF API Verbs QUERY_LS unsigned char AP_UINT16 } LS_DEF_DATA; reserv4[13]; link_spec_data_len; /* reserved */ /* length of link specific data */ typedef struct link_address { unsigned char format; unsigned char reserve1; AP_UINT16 length; unsigned char address[32]; } LINK_ADDRESS; /* /* /* /* type of 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
NOF API Verbs QUERY_LS AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 } LS_STATS; /* received /* number of control frames /* sent reserved reserved reserved reserved reserved successful XID on LS count unsuccessful XID on LS count out_session_control_frames; echo_rsps; current_delay; max_delay; min_delay; max_delay_time; good_xids; bad_xids; /* /* /* /* /* /* /* */ */ */ */ */ */ */ */ */ */ For more details of the link-specific data, see Section 3.29, DEFINE_LS.
NOF API Verbs QUERY_LS 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. This value is ignored if list_options is set to AP_FIRST_IN_LIST. port_name Port name filter. To return information only on LSs associated with a specific port, specify the 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.
NOF API Verbs QUERY_LS AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI AP_IP Enterprise Extender (HPR/IP) 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_LS The node type is normally determined during activation; it is null if the LS is inactive. However, for an LS to a back-level LEN node (specified by the adj_cp_type parameter on DEFINE_LS), the node type is taken from the LS definition and is not determined during activation. ls_summary.port_name Name of the port associated with this link station. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 characters. ls_summary.
NOF API Verbs QUERY_LS ls_detail.det_data.act_sess_count The total number of active sessions (both endpoint and intermediate) using the link. ls_detail.det_data.dlc_type Type of DLC. This is one of the following: AP_SDLC SDLC AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI AP_IP Enterprise Extender (HPR/IP) ls_detail.det_data.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.
NOF API Verbs QUERY_LS Fully qualified name of the adjacent control point. 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. This name is normally determined during activation; it is null if the LS is inactive.
NOF API Verbs QUERY_LS ls_detail.det_data.ls_stats.in_xid_frames Total number of XID (Exchange Identification) frames received on this link station. ls_detail.det_data.ls_stats.in_msg_frames Total number of data frames received on this link station. ls_detail.det_data.ls_stats.out_xid_bytes Total number of XID (Exchange Identification) bytes sent on this link station. 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.
NOF API Verbs QUERY_LS The link station was deactivated as a result of an immediate STOP command from an operator. AP_DEACT_AUTOMATIC The link station was deactivated automatically, for example because there were no more sessions using the link station. AP_DEACT_FAILURE The link station was deactivated because of a failure. ls_detail.det_data.hpr_support Level of High Performance Routing (HPR) supported on this transmission group (TG), taking account of the capabilities of the local and adjacent nodes.
NOF API Verbs QUERY_LS AP_LS_DEFINED The link station was defined explicitly by a SNAplus2 administration program. AP_LS_DYNAMIC The link station was created when the local node connected to another node through a connection network. AP_LS_TEMPORARY The link station was created temporarily to process an incoming call, but has not yet become active. AP_LS_IMPLICIT The link station was defined implicitly when SNAplus2 received an incoming call that it could not match to a defined link station.
NOF API Verbs QUERY_LS ls_detail.det_data.local_address.address IP address of the local link station. This is a string of four bytes, each representing the numeric value of one element of a dotted-decimal IP address (such as 193.1.11.100). 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.det_data.
NOF API Verbs QUERY_LS ls_detail.def_data.react_timer_retry 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_LS AP_HOST_XID3 Host node; SNAplus2 responds to a polling XID from the node with a format 3 XID. AP_HOST_XID0 Host node; SNAplus2 responds to a polling XID from the node with a format 0 XID. AP_DSPU_XID Downstream PU; SNAplus2 includes XID exchange in link activation. AP_DSPU_NOXID Downstream PU; SNAplus2 does not include XID exchange in link activation. For SDLC: ls_detail.def_data.dest_address Address of the secondary link station.
NOF API Verbs QUERY_LS IP version for which this IP address is defined. This is set to IP_VERSION_4. ls_detail.def_data.dest_address.address IP address of link station on adjacent node. This is a string of four bytes, each representing the numeric value of one element of a dotted-decimal IP address (such as 193.1.11.100). 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_LS The PU name is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces. ls_detail.def_data.disable_remote_act Specifies whether the LS can be activated by a remote node. Possible values are: AP_YES The LS can only be activated by the local node; if the remote node attempts to activate it, SNAplus2 will reject the attempt. AP_NO The LS can be activated by the remote node. ls_detail.def_data.
NOF API Verbs QUERY_LS AP_NO HPR is not supported on this link. ls_detail.def_data.hpr_link_lvl_error For SDLC, this parameter is reserved. For other port types, this parameter specifies whether link-level error recovery is supported for HPR traffic on the link. This parameter is reserved if the ls_detail.def_data.hpr_supported parameter is set to AP_NO. Possible values are: AP_YES The HPR link-level error recovery tower is supported on this link.
NOF API Verbs QUERY_LS 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. AP_SUPPRESS_CP_NAME Do not include the Network name CV. If adj_cp_type is set to any other value, this parameter is reserved. ls_detail.def_data.adj_node_id Node ID of adjacent node.
NOF API Verbs QUERY_LS 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_LS Primary AP_LS_SEC Secondary 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.
NOF API Verbs QUERY_LS The adjacent node must not be a Branch Network Node. ls_detail.def_data.pu_can_send_dddlu_offline Specifies whether the local PU should send NMVT (power off) messages to the host. If the host system supports DDDLU (Dynamic Definition of Dependent LUs), SNAplus2 sends NMVT (power off) to the host when it has finished using a dynamically defined LU. This allows the host to save resources by removing the definition when it is no longer required.
NOF API Verbs QUERY_LS_ROUTING 3.130 QUERY_LS_ROUTING The QUERY_LS_ROUTING verb returns information for local LUs about the location of a partner LU using a link station. If information is requested about more than one local LU, the information is returned based on the Management Information Base (MIB) order of the local LU names, then on the MIB order of partner LU names associated with each local LU name. Wildcard partner LU names can be interspersed with entries that do not contain wildcards. 3.130.
NOF API Verbs QUERY_LS_ROUTING The position in the list of LS routing entries from which SNAplus2 begins to return data. Specify 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 lu_name and fq_partner_lu parameters. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of the lu_name, fq_partner_lu, and wildcard_fqplu parameters.
NOF API Verbs QUERY_LU_0_TO_3 Fully qualified name of the partner LU. wildcard_fqplu Flag indicating whether the fq_partner_lu parameter contains a full or partial wildcard. Possible values are: AP_YES The fq_partner_lu parameter contains a full or partial wildcard. AP_NO The fq_partner_lu parameter does not contain a full or partial wildcard. ls_name Name of the link station used for sessions between the LU specified in the lu_name parameter and the partner LU specified in the fq_plu_name parameter. 3.
NOF API Verbs QUERY_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. 3.131.
NOF API Verbs QUERY_LU_0_TO_3 unsigned char bind_lu_type; unsigned char compression; unsigned char cryptography; unsigned char reserva[10]; } LU_0_TO_3_DET_DATA; typedef struct session_stats { AP_UINT16 rcv_ru_size; AP_UINT16 send_ru_size; AP_UINT16 max_send_btu_size; AP_UINT16 max_rcv_btu_size; AP_UINT16 max_send_pac_win; AP_UINT16 cur_send_pac_win; AP_UINT16 max_rcv_pac_win; AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsig
NOF API Verbs QUERY_LU_0_TO_3 unsigned char reserv4[32]; } SESSION_USER_INFO; /* reserved */ If the app_type parameter in the lu_0_to_3_det_data structure is set to AP_RJE_WKSTN, the app_spec_det_data field contains the same structure as the 3270 structure above, except that the user_type and lu_model parameters are set to AP_RJE_WKSTN and the user_name parameter contains the RJE workstation name.
NOF API Verbs QUERY_LU_0_TO_3 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. AP_LIST_INCLUSIVE Start at the entry specified by the lu_name parameter.
NOF API Verbs QUERY_LU_0_TO_3 3.131.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_LU_0_TO_3 AP_YES An application is using the LU. AP_NO No application is using the LU. lu_0_to_3_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 inactive. 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.
NOF API Verbs QUERY_LU_0_TO_3 An application is using the LU. AP_NO 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_LU_0_TO_3 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 API Verbs QUERY_LU_0_TO_3 user_name If the user_type parameter below is set to AP_RJE_WKSTN, this parameter specifies the name of the RJE workstation program that is using the LU. This is an ASCII string of 1–4 characters; the remaining characters are filled with spaces. For other values of user_type, this parameter specifies the HP-UX user name with which the 3270 emulation program using this LU is running. This is an ASCII string of 1–32 characters.
NOF API Verbs QUERY_LU_0_TO_3 AP_NO The program is using an explicitly-defined record. 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_LU_0_TO_3 AP_FMI_APPLICATION The LU is being used by a 3270 emulation program or an RJE workstation; the user_type parameter in the session_user_info structure (described above) identifies the application type. AP_TN_SERVER 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_active is not AP_NO, this parameter will be all zeros.
NOF API Verbs QUERY_LU_0_TO_3 AP_3270_DISPLAY_MODEL_2 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_LU_LU_PASSWORD Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.131.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_LU_LU_PASSWORD AP_QUERY_LU_LU_PASSWORD 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 partner LUs for which password information should be returned. To request a specific entry rather than a range, specify the value 1.
NOF API Verbs QUERY_LU_LU_PASSWORD primary_rc AP_OK buf_size Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs QUERY_LU_POOL AP_BASIC Basic security protocols in use. AP_ENHANCED Enhanced security protocols in use. 3.132.4 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.
NOF API Verbs QUERY_LU_POOL AP_UINT16 unsigned char unsigned char unsigned char unsigned char } QUERY_LU_POOL; total_num_entries; list_options; reserv3; pool_name[8]; lu_name[8]; typedef struct lu_pool_summary { AP_UINT16 overlay_size; unsigned char pool_name[8]; unsigned char description[32]; unsigned char reserv1[16]; AP_UINT16 num_active_lus; AP_UINT16 num_avail_lus; } LU_POOL_SUMMARY; typedef struct lu_pool_detail { AP_UINT16 overlay_size; unsigned char pool_name[8]; unsigned char description[32]; un
NOF API Verbs QUERY_LU_POOL 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. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of the pool_name and lu_name parameters.
NOF API Verbs QUERY_LU_POOL operator. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. lu_pool_summary.pool_name Name of LU pool. This is an 8-byte EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. lu_pool_summary.
NOF API Verbs QUERY_LU62_TIMEOUT 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. 3.133.
NOF API Verbs QUERY_LU62_TIMEOUT 3. Partner LU timeouts 4. Mode timeouts For resource_name, the ordering is by: 1. Name length 2. By ASCII lexicographical ordering for names of the same length If the list_options parameter is set to AP_LIST_FROM_NEXT, the returned list starts for the next entry according to the defined ordering (whether or not the specified entry exists). 3.134.
NOF API Verbs QUERY_LU62_TIMEOUT list_options The position in the list of entries from which SNAplus2 begins to return data. The list is ordered by resource_type in the order AP_GLOBAL_TIMEOUT, AP_LOCAL_LU_TIMEOUT, AP_PARTNER_LU_TIMEOUT, AP_MODE_TIMEOUT, then by resource_name in order of the name length, then by ASCII lexicographical ordering for names of the same length.
NOF API Verbs QUERY_LU62_TIMEOUT 3.134.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_MDS_APPLICATION The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name and type, but the combination 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 B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.134.
NOF API Verbs QUERY_MDS_APPLICATION 3.135.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_MDS_APPLICATION 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 applications for which data should be returned. To request data for a specific application rather than a range, specify the value 1.
NOF API Verbs QUERY_MDS_APPLICATION 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: mds_application_data.overlay_size The size of the returned mds_application_data structure, and therefore the offset to the start of the next entry in the data buffer.
NOF API Verbs QUERY_MDS_STATISTICS 3.136 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. 3.136.
NOF API Verbs QUERY_MDS_STATISTICS 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. uncorrelated_errors_rcvd Number of error messages received by MDS indicating a delivery failure for a message containing an alert. Delivery failure occurs when the error message could not be correlated to an alert on the MDS send alert queue.
NOF API Verbs QUERY_MODE 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. 3.136.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.137 QUERY_MODE QUERY_MODE returns information about modes that a local LU is using, or has used, with partner LUs.
NOF API Verbs QUERY_MODE } MODE_SUMMARY; 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; unsigned char drain_partner; AP_UINT16 auto_act; AP_UINT16 AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 AP_UIN
NOF API Verbs QUERY_MODE 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 (the first partner LU and mode for the specified local LU). AP_LIST_INCLUSIVE 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.
NOF API Verbs QUERY_MODE AP_YES Return information only on modes for which sessions are currently active. AP_NO Return information about all modes for which sessions are active or have been active. 3.137.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.
NOF API Verbs QUERY_MODE The size of the returned mode_detail structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each mode_detail 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_MODE 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.sync_level Specifies the synchronization level supported by the mode. Possible values are: AP_CONFIRM The mode supports synchronization using the CONFIRM and CONFIRMED verbs.
NOF API Verbs QUERY_MODE_DEFINITION primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. AP_INVALID_LU_ALIAS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_alias parameter was not valid.
NOF API Verbs QUERY_MODE_DEFINITION AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char *buf_ptr; AP_UINT32 buf_size; AP_UINT32 total_buf_size; AP_UINT16 num_entries; AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char mode_name[8]; } QUERY_MODE_DEFINITION; typedef struct mode_def_summary { AP_UINT16 overlay_size; unsigned char mode_name[8]; unsigned char description[32]; unsigned char reserv1[1
NOF API Verbs QUERY_MODE_DEFINITION 3.138.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_MODE_DEFINITION buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of modes for which data should be returned. To request data for a specific mode rather than a range, specify the value 1.
NOF API Verbs QUERY_MODE_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_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_MODE_TO_COS_MAPPING AP_PARAMETER_CHECK secondary_rc Possible values are: 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 B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.138.
NOF API Verbs QUERY_MODE_TO_COS_MAPPING 3.139.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_MODE_TO_COS_MAPPING buf_ptr A pointer to a data buffer that SNAplus2 will use to return the requested information. buf_size Size of the supplied data buffer. num_entries Maximum number of modes for which data should be returned. To request data for a specific mode rather than a range, specify the value 1.
NOF API Verbs QUERY_MODE_TO_COS_MAPPING Number of entries returned in the data buffer. total_num_entries Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. Each entry in the data buffer consists of the following parameters: mode_to_cos_mapping_data.overlay_size The size of the returned mode_to_cos_mapping_data structure, and therefore the offset to the start of the next entry in the data buffer.
NOF API Verbs QUERY_NMVT_APPLICATION 3.140 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 Programmer’s 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. 3.140.
NOF API Verbs QUERY_NMVT_APPLICATION Maximum number of applications for which data should be returned. To request data for a specific application 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 of applications from which SNAplus2 should begin to return data.
NOF API Verbs QUERY_NN_TOPOLOGY_NODE 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. When the application registers for NMVT messages, it specifies which MS vector keys it will accept. nmvt_application_data.
NOF API Verbs QUERY_NN_TOPOLOGY_NODE 3.141.
NOF API Verbs QUERY_NN_TOPOLOGY_NODE Size of the supplied data buffer. num_entries Maximum number of nodes for which data should be returned. To request data for a specific node 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_NN_TOPOLOGY_NODE This parameter can be used to ensure that consistent information is obtained when the application needs to issue several verbs to obtain all the information. The application should take the following steps: To Obtain Consistent Information Using the frsn Parameter 1. Issue QUERY_NODE to get the node’s current FRSN. 2. Issue as many QUERY_NN_TOPOLOGY_NODE verbs as necessary to get all the database entries, with the frsn parameter set to zero. 3.
NOF API Verbs QUERY_NN_TOPOLOGY_NODE AP_END_NODE End node. AP_VRN Virtual routing node. nn_topology_node_detail.node_name Fully qualified name of the node. This 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. nn_topology_node_detail.node_type Type of the node. This is one of the following: AP_NETWORK_NODE Network node. AP_END_NODE End node.
NOF API Verbs QUERY_NN_TOPOLOGY_NODE 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. nn_topology_node_detail.function_support Specifies which functions are supported. This may be one or more of the following, combined using a logical OR.
NOF API Verbs QUERY_NN_TOPOLOGY_STATS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the node_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.141.
NOF API Verbs QUERY_NN_TOPOLOGY_STATS 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 /* /* /* /* /* /* /* tg_state_updates; /* tg_errors; /* tg_timer_updates; /* /* tg_purges; /* total_route_calcs; /* /* total_route_rejs; /* /* total_tree_cache_hits; /* total_tree_cache_misses; node_purges; tg_low_rsns; tg_equal_rsns; tg_good_high_rsns; tg_bad_high_rsns; AP_UINT32 total_tdu_wars; unsigned char reserva[16]; } QUERY_NN_TOPOL
NOF API Verbs QUERY_NN_TOPOLOGY_STATS node_equal_rsns Total number of topology node updates received by this node with RSN equal to the current RSN. Both even and odd RSNs are included in this count. (These TDUs are not errors, but result when TDUs are broadcast to all adjacent network nodes. No update to this node’s topology database occurs.) node_good_high_rsns Total number of topology node updates received by this node with RSN greater than the current RSN.
NOF API Verbs QUERY_NN_TOPOLOGY_TG tg_errors Total number of topology TG update inconsistencies detected by this node. This occurs when this node attempts to update its topology database and detects a data inconsistency. This node will create a TDU with the current RSN incremented to the next odd number and broadcast it to all adjacent network nodes. tg_timer_updates Total number of topology TG updates built for this node’s resource due to timer updates.
NOF API Verbs QUERY_NN_TOPOLOGY_TG This verb can be used to obtain either summary or detailed information, about a specific TG or about multiple TGs, depending on the options used. It can be issued only to a network node; it is not valid at an end node or a LEN node. This verb must be issued to a running node. 3.143.
NOF API Verbs QUERY_NN_TOPOLOGY_TG unsigned char intersubnet_tg; unsigned char cp_cp_session_active; unsigned char branch_tg; unsigned char multilink_tg; unsigned char appended_data_format; unsigned char appended_data_len; unsigned char reserva[9]; } TOPOLOGY_TG_DETAIL; typedef struct link_address { unsigned char format; unsigned char reserve1; AP_UINT16 length; unsigned char address[32]; } LINK_ADDRESS; /* /* /* /* /* /* /* TG between subnets Are CP-CP sessions active? TG branch aware? reserved format
NOF API Verbs QUERY_NN_TOPOLOGY_TG Start at the first entry in the list. AP_LIST_INCLUSIVE Start at the entry specified by the combination of owner, destination, TG number, and FRSN. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the combination of owner, destination, TG number, and FRSN.
NOF API Verbs QUERY_NN_TOPOLOGY_TG Number associated with the TG. frsn Flow Reduction Sequence Number (FRSN). Specify zero to return information about all TGs, or a nonzero value to return information about TGs with a FRSN greater than or equal to this value. This parameter can be used to ensure that consistent information is obtained when the application needs to issue several verbs to obtain all the information.
NOF API Verbs QUERY_NN_TOPOLOGY_TG topology_tg_summary.owner_type Type of the node that owns the TG. Possible values are: AP_NETWORK_NODE Network node. AP_END_NODE End node. AP_VRN Virtual routing node. topology_tg_summary.dest Name of the destination node for the TG. 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. topology_tg_summary.
NOF API Verbs QUERY_NN_TOPOLOGY_TG End node. AP_VRN Virtual routing node. topology_tg_detail.dest Name of the destination node for the TG. 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. topology_tg_detail.dest_type Type of the destination node for the TG. Possible values are: AP_NETWORK_NODE Network node. AP_END_NODE End node.
NOF API Verbs QUERY_NN_TOPOLOGY_TG AP_HPR AP_RTP topology_tg_detail.tg_chars TG characteristics. For details of these parameters, see Section 3.29, DEFINE_LS. topology_tg_detail.subarea_number If the owner of the destination of the TG is subarea capable, this parameter contains the subarea number of the type-4 or type-5 node that owns the link station associated with the TG on the subarea capable node. Otherwise, this parameter is set to all binary zeros. topology_tg_detail.tg_type Type of the TG.
NOF API Verbs QUERY_NN_TOPOLOGY_TG topology_tg_detail.appended_data_format Specifies the format of data appended to this NOF VCB structure. If the parameter topology_tg_detail.appended_data_len is set to a non-zero value, indicating that appended data is included, this parameter is set to the following value: AP_TG_DESCRIPTOR_CV The appended data contains a TG Descriptor CV, as defined by SNA Formats. If topology_tg_detail.
NOF API Verbs QUERY_NODE 3.144 QUERY_NODE QUERY_NODE returns information about the definition of a SNAplus2 node, and on its status if it is active. 3.144.
NOF API Verbs QUERY_NODE unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT16 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 unsigned char unsigned char unsi
NOF API Verbs QUERY_NODE opcode AP_QUERY_NODE 3.144.3 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.
NOF API Verbs QUERY_NODE cp_create_parms.max_locates Maximum number of locates that the node can process. cp_create_parms.dir_cache_size Network node only: Size of the directory cache. cp_create_parms.max_dir_entries Maximum number of directory entries. Zero indicates no limit. cp_create_parms.locate_timeout Specifies the time in seconds before a network search will time out. Zero indicates no timeout. cp_create_parms.
NOF API Verbs QUERY_NODE Network node: Maximum number of nodes that can be stored in Topology Database. A value of 0 (zero) indicates an unlimited number of nodes. For an end nodeor LEN node, this parameter is reserved. cp_create_parms.max_tdm_tgs Network node: Maximum number of TGs that can be stored in Topology Database. A value of 0 (zero) indicates an unlimited number of nodes. For an end nodeor LEN node, this parameter is reserved. cp_create_parms.
NOF API Verbs QUERY_NODE End Node or Branch Network Node: DLUR is supported, but will not be used to connect to a DLUS in another subnet.. This value is not supported for a Network Node. AP_NO DLUR is not supported. cp_create_parms.pu_conc_support Specifies whether PU concentration is supported (AP_YES or AP_NO). cp_create_parms.nn_rar The network node’s route additional resistance. cp_create_parms.hpr_support Specifies the level of HPR (High Performance Routing) support provided by the node.
NOF API Verbs QUERY_NODE 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”. AP_ALLOW_BB_RQE SNAplus2 normally rejects, with sense code 2003, any begin bracket (BB) exception (RQE) request from a host unless the host follows the SNA protocol that the request must also indicate change direction (CD).
NOF API Verbs QUERY_NODE Include APINGD support within the node (the normal processing). AP_EXTERNAL_APINGD Disable APINGD within the node. cp_create_parms.ptf[4] LU 0–3 RU checks. This byte is used to provide workarounds for host systems that send non-standard SNA data; it should be set to AP_NONE unless you have encountered the specific problem described below. The value AP_NONE indicates SNAplus2’s normal checking on LU 0–3 RUs.
NOF API Verbs QUERY_NODE cp_create_parms.ptf[8] Suppress PU name on REQACTPU. SNAplus2 normally identifies the PU name in the REQACTPU message when activating DLUR PUs. Possible values: AP_NONE Use the normal processing. AP_SUPPRESS_PU_NAME_ON_REQACTPU Suppress PU name when activating DLUR PUs. cp_create_parms.ptf[9] RUI bracket race options, limited resource override options for connection networks, and TCP/IP Information Control Vector options.
NOF API Verbs QUERY_NODE AP_YES Send a TERM_SELF on receipt of a CLOSE_PLU_SLU_SEC_RQ. AP_NO Send an UNBIND on receipt of a CLOSE_PLU_SLU_SEC_RQ. cp_create_parms.disable_branch_awareness This parameter applies only if node_type is AP_NETWORK_NODE; it is reserved for other node types. Specifies whether the local node supports branch awareness, APPN Option Set 1120. Possible values: AP_YES The local node does not support branch awareness.
NOF API Verbs QUERY_NODE nn_functions_supported Network node only: Specifies the network node functions supported. This may be one or more of the following, combined using a logical OR. AP_RCV_REG_CHAR Node supports receiving registered characteristics. AP_GATEWAY Node is a gateway node. AP_CDS Node supports Central Directory server function. AP_TREE_CACHING Node supports route tree cache. AP_TREE_UPDATES Node supports incremental tree updates.
NOF API Verbs QUERY_NODE AP_UNCONGESTED The number of ISR sessions is below the isr_sessions_upper_threshold value in the node’s configuration. AP_CONGESTED The number of ISR sessions exceeds the threshold value. AP_IRR_DEPLETED The number of ISR sessions has reached the maximum specified for the node. 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.
NOF API Verbs QUERY_NODE_ALL This parameter applies only if the local node is a Branch Network Node; it is reserved otherwise. Specifies whether the network node server supports option set 1123 - End Node Resource Registration With Different Owning CP Name NNS(BrNN) Support. AP_YES The network node server supports option set 1123. AP_NO The network node server does not support option set 1123. AP_UNKNOWN The node does not have a network node server. fq_nn_server_name End node only.
NOF API Verbs QUERY_NODE_ALL 3.145.
NOF API Verbs QUERY_NODE_ALL The list is not ordered by node name. However, the order remains the same for subsequent QUERY_NODE_ALL verbs, so the application can obtain a complete list in several sections by using multiple verbs in the normal way. For more information about how the application can obtain specific entries from the list, see Section 2.7, List Options For QUERY_* Verbs. node_name Name of the node to be used as an index into the list.
NOF API Verbs QUERY_NODE_LIMITS The server holds a backup configuration file. AP_ROLE_NONE The server does not share its copy of the configuration file. 3.145.
NOF API Verbs QUERY_NODE_LIMITS NODE_RESOURCE_LIMITS NODE_RESOURCE_LIMITS NODE_OPTIONS unsigned char NODE_RESOURCE_LIMITS } QUERY_NODE_LIMITS; max_limits; curr_usage; node_options; reserv4[4]; max_usage; /* /* /* /* /* max numbers of LUs/sessions/users */ current usage of LUs/sessions/users*/ permitted functions */ reserved */ highest usage counts */ typedef struct node_resource_limits { AP_INT32 lu62_tps; AP_INT32 lua_tps; AP_INT32 fmapi_tps; AP_INT32 link_stations; AP_INT32 tn3270_connections; AP_INT
NOF API Verbs QUERY_NODE_LIMITS max_limits.lua_tps The maximum number of LUA applications that your license allows you to have active at any one time. A value of zero indicates that you cannot use any LUA applications; a value of -1 indicates no limit. max_limits.fmapi_tps The maximum number of 3270 emulation programs and RJE workstations that your license allows you to have active at any one time. A value of zero indicates that you cannot use any of these programs; a value of -1 indicates no limit.
NOF API Verbs QUERY_NODE_LIMITS max_usage.link_stations The maximum number of link stations that have been active on this node at any time since the HP-UX computer was restarted. max_usage.tn3270_connections The maximum number of connections from TN3270 clients that have been active on this node at any time since the HP-UX computer was restarted. max_usage.data_sessions The maximum number of PLU-SLU sessions that have been active on this node at any time since the HP-UX computer was restarted.
NOF API Verbs QUERY_NODE_LIMITS 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.hpr_support Specifies whether your license allows you to use HPR (High Performance Routing) on this node. Possible values are: AP_YES HPR is supported. AP_NO HPR is not supported. node_options.
NOF API Verbs QUERY_PARTNER_LU 3.147 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_PARTNER_LU unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char } PLU_DETAIL; partner_cp_name[17]; partner_lu_located; plu_un_name[8]; parallel_sess_supp; conv_security; max_mc_ll_send_size; implicit; security_details; duplex_support; preference; reserva[16]; /* /* /* /* /* /* /* /* /* /* /* /* partner LU CP name CP name resolved? partner LU uninterpreted name parallel sessions supported?
NOF API Verbs QUERY_PARTNER_LU 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_PARTNER_LU Length of the information returned in the supplied buffer. total_buf_size Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned. num_entries Number of entries returned in the data buffer. total_num_entries Total number of entries available.
NOF API Verbs QUERY_PARTNER_LU The size of the returned plu_detail structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each plu_detail 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_PARTNER_LU AP_NO Conversation security information supplied by a local TP is not sent to the partner LU. AP_UNKNOWN No sessions are active with the partner LU. plu_detail.max_mc_ll_send_size Maximum logical record size, 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.
NOF API Verbs QUERY_PARTNER_LU_DEFINITION preference This parameter is reserved. 3.147.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters: primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_LU_ALIAS The list_options parameter was set to AP_LIST_INCLUSIVE to list all entries starting from the supplied name, but the lu_alias parameter was not valid.
NOF API Verbs QUERY_PARTNER_LU_DEFINITION AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char *buf_ptr; AP_UINT32 buf_size; AP_UINT32 total_buf_size; AP_UINT16 num_entries; AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char plu_alias[8]; unsigned char fqplu_name[17]; } QUERY_PARTNER_LU_DEFINITION; typedef struct partner_lu_def_summary { AP_UINT16 overlay_size; unsigned char plu_alias[8]; unsign
NOF API Verbs QUERY_PARTNER_LU_DEFINITION 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_PARTNER_LU_DEFINITION 3.148.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_PARTNER_LU_DEFINITION 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. 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. partner_lu_def_detail.plu_chars.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_PORT Possible values are: AP_INVALID_PLU_NAME 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 B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.148.
NOF API Verbs QUERY_PORT unsigned char } PORT_SUMMARY; dlc_name[8]; typedef struct port_detail { AP_UINT16 overlay_size; unsigned char port_name[8]; unsigned char reserv1[2]; PORT_DET_DATA det_data; PORT_DEF_DATA def_data; } PORT_DETAIL; typedef struct port_det_data { unsigned char port_state; unsigned char dlc_type; unsigned char port_sim_rim; unsigned char reserv1; AP_UINT16 def_ls_good_xids; AP_UINT16 def_ls_bad_xids; AP_UINT16 dyn_ls_good_xids; AP_UINT16 AP_UINT16 unsigned char unsigned char AP_UINT
NOF API Verbs QUERY_PORT unsigned char unsigned char AP_UINT16 AP_UINT16 implicit_dspu_services; /* reserved */ implicit_deact_timer; /* deact timer for implicit LSs */ act_xid_exchange_limit; /* activation XID exchange limit */ nonact_xid_exchange_limit; /* non-act.
NOF API Verbs QUERY_PORT 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 port_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the port_name parameter. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.
NOF API 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_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. 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.
NOF API Verbs QUERY_PORT AP_X25 QLLC AP_TR Token Ring AP_ETHERNET Ethernet AP_FDDI FDDI AP_IP Enterprise Extender (HPR/IP) port_detail.det_data.port_sim_rim Specifies whether Set Initialization Mode (SIM) and Receive Initialization Mode (RIM) are supported. Possible values are: AP_YES SIM and RIM are supported. AP_NO SIM and RIM are not supported. port_detail.det_data.
NOF API Verbs QUERY_PORT AP_YES ABM link stations are supported. AP_NO ABM link stations are not supported. AP_UNKNOWN Support for ABM link stations cannot be determined because the DLC associated with this port has not yet been started. port_detail.det_data.start_time The elapsed time, in hundredths of a second, between the time the node was started and the last time this port was started. If this port has not yet been started, this parameter is set to zero. port_detail.def_data.
NOF API Verbs QUERY_PORT port_detail.def_data.port_number Port number. port_detail.def_data.max_rcv_btu_size Maximum BTU size that can be received. port_detail.def_data.tot_link_act_lim Total link activation limit. port_detail.def_data.inb_link_act_lim Inbound link activation limit. port_detail.def_data.out_link_act_lim Outbound link activation limit. port_detail.def_data.ls_role Link station role.
NOF API Verbs QUERY_PORT Non-activation XID exchange limit. port_detail.def_data.ls_xmit_rcv_cap Specifies the link station transmit/receive capability. Possible values are: AP_LS_TWS Two-way simultaneous AP_LS_TWA Two-way alternating port_detail.def_data.max_ifrm_rcvd Maximum number of I-frames that can be received by local link stations before an acknowledgment is sent. Range: 1–127. port_detail.def_data.
NOF API Verbs QUERY_PU def_data.implicit_link_lvl_error For SDLC, this parameter is not used. For other link types, this parameter specifies whether HPR traffic should be sent on implicit links using linklevel error recovery (AP_YES or AP_NO). The parameter is reserved if implicit_hpr_support is set to AP_NO. def_data.default_tg_chars Default TG characteristics.
NOF API Verbs QUERY_PU 3.150.
NOF API Verbs QUERY_PU unsigned char unsigned char unsigned char } SESSION_STATS; odai; ls_name[8]; pacing_type; /* ODAI bit set /* Link station name /* type of pacing in use */ */ */ 3.150.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_PU 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 PUs for which data should be returned.
NOF API Verbs QUERY_PU Return information about all PUs regardless of host attachment. 3.150.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.
NOF API Verbs QUERY_PU AP_DIRECT_ATTACHED PU is directly attached to the host system. AP_DLUR_ATTACHED PU is supported by DLUR. pu_data.pu_sscp_stats.rcv_ru_size Reserved (always set to zero). 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.
NOF API Verbs QUERY_PU Origin Destination Assignor Indicator. When bringing up a session, the sender of the BIND sets this field to zero if the local node contains the primary link station, and sets it to one if the BIND sender is the node containing the secondary link station. pu_data.pu_sscp_stats.ls_name Link station name associated with statistics. This is an 8-byte ASCII character string, right-padded with spaces if the name is shorter than 8 characters. pu_data.pu_sscp_stats.
NOF API Verbs QUERY_RCF_ACCESS 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 pu_name parameter was not valid. AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.150.
NOF API Verbs QUERY_RCF_ACCESS AP_UINT16 AP_UINT32 unsigned char AP_UINT32 unsigned char } QUERY_RCF_ACCESS; primary_rc; secondary_rc; ucf_username[32]; spcf_permissions; reserv3[8]; /* /* /* /* /* primary return code secondary return code UCF username SPCF permissions Reserved */ */ */ */ */ 3.151.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_RCF_ACCESS 3.151.
NOF API Verbs QUERY_RJE_WKSTN 3.151.4 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.152 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.
NOF API Verbs QUERY_RJE_WKSTN AP_UINT32 AP_UINT32 unsigned char AP_UINT32 AP_UINT32 unsigned char } RJE_WKSTN_DETAIL; wkstn_uid; wkstn_gid; wkstn_gname[32]; wkstn_session_count; wkstn_start_time; reserv3[8]; /* /* /* /* /* /* user ID group ID group name count of RJE LU sessions time workstation was started reserved */ */ */ */ */ */ 3.152.
NOF API Verbs QUERY_RJE_WKSTN Return information about all RJE workstation programs running with the specified workstation name, or on all RJE workstations if no name is specified. AP_SYSTEM Return information about RJE workstation programs running on the specified computer. AP_USER_AT_SYSTEM Return information about the RJE workstation program with the specified workstation name running on the specified computer.
NOF API Verbs QUERY_RJE_WKSTN rje_wkstn_summary.system_name The computer name on which the workstation is running. This is an ASCII string, padded on the right with spaces. 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.
NOF API Verbs QUERY_RJE_WKSTN_DEF AP_INVALID_LIST_OPTION The list_options parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.152.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.
NOF API Verbs QUERY_RJE_WKSTN_DEF RJE_WKSTN_DEF_DATA def_data; } RJE_WKSTN_DEF_DETAIL; typedef struct rje_wkstn_def_data { unsigned char description[32]; unsigned char reserv1[16]; unsigned char primary_user[32]; unsigned char group_name[32]; unsigned char system_name[128]; 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 *
NOF API Verbs QUERY_RJE_WKSTN_DEF Start at the entry immediately following the entry specified by the supplied workstation name. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.7, List Options For QUERY_* Verbs. workstation_name The name of the workstation for which information is required, or the name to be used as an index into the list of workstations. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. 3.
NOF API Verbs QUERY_RTP_CONNECTION The details of the workstation, as defined in the configuration. The format of this information is the same as for the DEFINE_RJE_WKSTN verb. 3.153.
NOF API Verbs QUERY_RTP_CONNECTION } QUERY_RTP_CONNECTION; typedef struct rtp_connection_summary { AP_UINT16 overlay_size; unsigned char rtp_name[8]; unsigned char first_hop_ls_name[8]; unsigned char dest_node_name[17]; unsigned char connection_type; unsigned char cos_name[8]; AP_UINT16 num_sess_active; } RTP_CONNECTION_SUMMARY; typedef struct rtp_connection_detail { AP_UINT16 overlay_size; unsigned char rtp_name[8]; unsigned char first_hop_ls_name[8]; unsigned char dest_node_name[17]; unsigned char isr_bo
NOF API Verbs QUERY_RTP_CONNECTION AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_INT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 unsigned char unsigned char } RTP_STATISTICS; last_rtt; /* last round-trip time short_req_timer; /* SHORT_REQ timer duration short_req_timeouts; /* number of SHORT_REQ timeouts liveness_timeouts; /* number of liveness timeouts in_invalid_sna_frames; /* number of invalid SNA frames in_sc_frames; /* number
NOF API Verbs QUERY_RTP_CONNECTION 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 rtp_name parameter. AP_LIST_FROM_NEXT Start at the entry immediately following the entry specified by the rtp_name parameter. rtp_name Name of the RTP connection. This value is ignored if the list_options parameter is set to AP_FIRST_IN_LIST.
NOF API Verbs QUERY_RTP_CONNECTION Fully qualified name of the destination control point for the RTP portion of the 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. rtp_connection_summary.connection_type Specifies the type of sessions on the RTP connection.
NOF API Verbs QUERY_RTP_CONNECTION rtp_connection_detail.connection_type Specifies the type of sessions on the RTP connection. Possible values are: AP_RTP_CP_CP_SESSION The RTP connection carries CP-CP sessions. AP_RTP_LU_LU_SESSION The RTP connection carries LU-LU sessions. AP_RTP_ROUTE_SETUP The RTP connection is used for route setup. rtp_connection_detail.cos_name Name of the class of service used by the RTP connection. This name is an EBCDIC string padded on the right with EBCDIC spaces.
NOF API Verbs QUERY_RTP_CONNECTION rtp_connection_detail.rtp_stats.gaps_detected Total number of gaps detected by the local node. Each gap corresponds to one or more lost frames. rtp_connection_detail.rtp_stats.send_rate Current send rate on this RTP connection, measured in Kbits/second. This rate is the maximum allowed send rate as calculated by the ARB (adaptive rate-based) algorithm.
NOF API Verbs QUERY_RTP_CONNECTION rtp_connection_detail.rtp_stats.delay_change_sum Value of the delay change sum currently held by the ARB-R algorithm on this RTP connection. rtp_connection_detail.rtp_stats.current_receiver_threshold Value of the receiver threshold currently held by the ARB-R algorithm on this RTP connection. rtp_connection_detail.rtp_stats.minimum_receiver_threshold Value of the minimum receiver threshold currently held by the ARB-R algorithm on this RTP connection.
NOF API Verbs QUERY_RTP_TUNING The ARB mode has not yet been determined because the RTP connection is not yet established. 3.154.
NOF API Verbs QUERY_SECURITY_ACCESS_LIST 3.155.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK path_switch_attempts Number of path switch attempts to set on new RTP connections. short_req_retry_limit Number of times a Status Request is sent before SNAplus2 determines that an RTP connection is disconnected and starts Path Switch processing.
NOF API Verbs QUERY_SECURITY_ACCESS_LIST /* for last list is incomplete */ } QUERY_SECURITY_ACCESS_LIST; typedef struct security_access_detail { AP_UINT16 overlay_size; unsigned char list_name[14]; unsigned char reserv1[2]; AP_UINT32 num_filtered_users; SECURITY_LIST_DEF def_data; } 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_
NOF API Verbs QUERY_SECURITY_ACCESS_LIST AP_LIST_FROM_NEXT If a user name is specified, start at the user immediately following the specified user. If no user name is specified, start at the first user for the specified security access list. The list is ordered by security access list name, and then by user name within each security access list. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.7, List Options For QUERY_* Verbs.
NOF API Verbs QUERY_SECURITY_ACCESS_LIST buffer. The num_last_users parameter indicates how many user name structures have been returned; the application can issue further verbs to obtain the remaining data. AP_NO The data for the last list is complete. Each entry in the data buffer consists of the following: security_access_detail.list_name The name of the security access list. This is an ASCII string of 1–14 characters. security_access_detail.
NOF API Verbs QUERY_SESSION 3.157 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. 3.157.
NOF API Verbs QUERY_SESSION unsigned char unsigned char SESSION_STATS unsigned char unsigned char unsigned char AP_UINT32 AP_UINT16 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } SESSION_DETAIL; polarity; contention; sess_stats; reserv3a; sscp_id[6]; reserva; session_start_time; session_timeout; cryptography; reservb[5]; comp_in_series; plu_slu_comp_lvl; slu_plu_comp_lvl; rscv_len; /* /* /* /* /* /* /* /* /* /* /* /* /* /* Session polarity Session contention Sessio
NOF API Verbs QUERY_SESSION AP_QUERY_SESSION 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 sessions for which data should be returned. To request data for a specific session rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied data buffer.
NOF API Verbs QUERY_SESSION To return information about all sessions without filtering on the partner LU, set both of these parameters to binary zeros. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. To specify that the LU is identified by its LU name rather than its alias, set this parameter to 8 binary zeros and specify the LU name in the following parameter. fqplu_name Fully qualified network name for the partner LU.
NOF API Verbs QUERY_SESSION session_summary.plu_alias Partner LU alias. This is an 8-byte ASCII character string, right-padded with ASCII spaces. session_summary.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. session_summary.mode_name Mode name.
NOF API Verbs QUERY_SESSION Class of service name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 characters. session_detail.trans_pri Transmission priority. Possible values are: 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.
NOF API Verbs QUERY_SESSION Current size of the receive pacing window on this session. session_detail.sess_stats.send_data_frames Number of normal flow data frames sent. session_detail.sess_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. session_detail.sess_stats.send_data_bytes Number of normal flow data bytes sent. session_detail.sess_stats.rcv_data_frames Number of normal flow data frames received. session_detail.sess_stats.
NOF API Verbs QUERY_SESSION session_detail.session_timeout The timeout associated with this session This timeout is derived from: • The LU 6.2 timeout associated with the local LU • The LU 6.2 timeout associated with the remote LU • The mode timeout • The global timeout • The limited resource timeout (if this session is running over a limited resource link) session_detail.plu_slu_comp_lvl Specifies the compression level for data sent from the primary LU (PLU) to the secondary LU (SLU).
NOF API Verbs QUERY_SNA_NET Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.157.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.158 QUERY_SNA_NET QUERY_SNA_NET returns information about servers that can act as backup master servers, as defined in the sna.net file.
NOF API Verbs QUERY_SNA_NET opcode AP_QUERY_SNA_NET 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 server names for which data should be returned. To request a specific entry 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_SNA_NET Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned. domain_name The name of the TCP/IP domain containing the SNAplus2 LAN. This name was specified during installation of the master server. Each entry in the data buffer consists of the following parameters: backup_summary.
NOF API Verbs QUERY_STATISTICS 3.158.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.159 QUERY_STATISTICS QUERY_STATISTICS returns statistics on the usage of an LS or port. The QLLC link type does not support link statistics; do not issue this verb for a QLLC LS or port.
NOF API Verbs QUERY_STATISTICS AP_UINT32 remote_busies; AP_UINT32 iframes_in; AP_UINT32 AP_UINT32 iframes_out; retransmits_in; AP_UINT32 retransmits_out; /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* /* AP_UINT32 ioctets_in; AP_UINT32 ioctets_out; AP_UINT32 uiframes_in; AP_UINT32 uiframes_out; AP_UINT32 xids_in; AP_UINT32 xids_out; AP_UINT32 tests_in; AP_UINT32 tests_out; AP_UINT32 rejs_in; AP_UINT32 rejs_out; AP_UINT32 frmrs_in; AP_UINT32 frmrs
NOF API Verbs QUERY_STATISTICS unsigned char last_fail_ctrl_in[2]; /* control field of last frame rcvd*/ /* before last failure */ unsigned char last_fail_ctrl_out[2]; /* control field of last frame sent*/ /* before last failure */ unsigned char last_fail_frmr_info[5]; /* info field of FRMR frame if */ /* last failure was caused by */ /* invalid frame */ unsigned char sdoppad1; /* reserved */ AP_UINT32 last_fail_replyto_s; /* number of REPLYTO timeouts at */ /* time of last failure */ unsigned char g_pol
NOF API Verbs QUERY_STATISTICS unsigned char reserv2[3]; AP_UINT32 slow_poll_timer; unsigned char last_fail_cause; } SDL_PORT_OPER_TABLE; /* reserved /* slow poll timer /* reserved */ */ */ LS statistics for Token Ring, Ethernet, FDDI: typedef struct vdl_ls_statistics { V0_MUX_INFO mux_info; AP_UINT32 ls_st_mus_sent; AP_UINT32 ls_st_mus_received; AP_UINT32 ls_st_bytes_sent; AP_UINT32 ls_st_bytes_received; AP_UINT32 ls_st_test_cmds_sent; AP_UINT32 ls_st_test_cmds_rec; AP_UINT32 ls_st_data_pkt_resent; AP_
NOF API Verbs QUERY_STATISTICS AP_QUERY_STATISTICS name Name of the LS or port for which statistics are required (as specified by the stats_type parameter). This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. SNAplus2 uses this name to correlate the response to the correct link station or port. stats_type The type of resource for which statistics are requested. Allowed values for SDLC: AP_LS Return LS statistics. AP_PORT Return port statistics.
NOF API Verbs QUERY_STATISTICS Ethernet AP_FDDI Fiber distributed data interface AP_X25 X.25 packet switching AP_IP Enterprise Extender (also known as HPR/IP) 3.159.3 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.
NOF API Verbs QUERY_STATISTICS sdl_ls_stats_table.blus_out The total number of basic link units (frames) transmitted to the adjacent link station. sdl_ls_stats_table.octets_in The total number of bytes (not including FCSs) received from the adjacent link station. sdl_ls_stats_table.octets_out The total number of bytes (not including FCSs) transmitted to the adjacent link station. sdl_ls_stats_table.polls_out Total number of polls sent to the adjacent link station. sdl_ls_stats_table.
NOF API Verbs QUERY_STATISTICS sdl_ls_stats_table.frmrs_in The total number of Frame Reject frames received from the adjacent link station. sdl_ls_stats_table.frmrs_out The total number of Frame Reject frames transmitted to the adjacent link station. sdl_ls_stats_table.sims_in The total number of Set Initialization Mode frames received from the adjacent link station. sdl_ls_stats_table.sims_out The total number of Set Initialization Mode frames transmitted to the adjacent link station. sdl_ls_stats_table.
NOF API Verbs QUERY_STATISTICS 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. Possible values are: SDL_MIB_EIGHT 8 SDL_MIB_ONETWENTYEIGHT 128 sdl_ls_stats_table.retries_m The maximum number of frames in a retry sequence (a sequence of frames that the LS retransmits because it has not received a positive acknowledgment for them). sdl_ls_stats_table.
NOF API Verbs QUERY_STATISTICS SDL_MIB_YES LS supports SIM and RIM. SDL_MIB_NOLS does not support SIM and RIM. sdl_ls_stats_table.xmit_rcv_cap Specifies the LS’s transmit / receive capability. Possible values are: SDL_MIB_HALF Half-duplex SDL_MIB_FULL Full-duplex Port statistics for SDLC: sdl_port_stats_table.index The index value used internally by SNAplus2 to identify the port. sdl_port_stats_table.dwarf_frames The number of frames received by the port that were too short to be valid.
NOF API Verbs QUERY_STATISTICS The number of times that SNAplus2 has deactivated an LS using this port because the Remote Busy timer expired. sdl_port_stats_table.retries_exps The number of times that SNAplus2 has deactivated an LS using this port because a retry sequence has been exhausted. sdl_port_stats_table.retransmits_in The total number of retransmitted I-frames received from adjacent link stations. sdl_port_stats_table.
NOF API Verbs QUERY_STATISTICS sdl_port_oper_table.slow_poll_timer The timeout between polls for failed secondary link stations. This parameter applies only if the port is primary and operating in a multipoint topology; its value is undefined otherwise. LS statistics for Token Ring, Ethernet , FDDI: vdl_ls_statistics.ls_st_mus_sent Number of frames sent from SNAplus2 on this LS since the LS was started. vdl_ls_statistics.
NOF API Verbs QUERY_TN3270_ACCESS_DEF Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.159.5 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_LINK_DEACTIVATED The specified link is not currently active. AP_PORT_DEACTIVATED The specified port is not currently active.
NOF API Verbs QUERY_TN3270_ACCESS_DEF unsigned char AP_UINT32 AP_UINT32 AP_UINT16 AP_UINT16 unsigned char unsigned char AP_UINT16 unsigned char AP_UINT16 AP_UINT32 *buf_ptr; buf_size; total_buf_size; num_entries; total_num_entries; list_options; reserv3; default_record; client_address[68]; port_number; num_init_sessions; AP_UINT32 num_last_sessions; unsigned char last_user_incomplete; unsigned char reserv4[11]; } QUERY_TN3270_ACCESS_DEF; typedef struct tn3270_access_summary { AP_UINT16 overlay_size;
NOF API Verbs QUERY_TN3270_ACCESS_DEF unsigned char printer_lu_name[8]; /* /* unsigned char reserv1[6]; /* AP_UINT16 port_number; /* /* unsigned char lu_name[8]; /* /* unsigned char session_type; /* unsigned char model_override; /* unsigned char ssl_enabled; /* unsigned char reserv3[64]; /* AP_UINT32 reserv4; /* } TN3270_SESSION_DEF_DATA; Generic printer LU/pool accessed reserved TCP/IP port used to access server Generic display LU/pool accessed Unused in current version Unused in current version reserve
NOF API Verbs QUERY_TN3270_ACCESS_DEF If a port number is specified, start at the session immediately following the session with the specified port number. If no port number is specified, start at the first session for the specified client address. The list is ordered by client address and then by port number for each user. For more information about how the list is ordered and how the application can obtain specific entries from it, see Section 2.7, List Options For QUERY_* Verbs.
NOF API Verbs QUERY_TN3270_ACCESS_DEF 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. At least one session structure is included, but there are further session structures that are not included in the data buffer.
NOF API Verbs QUERY_TN3270_ACCESS_DEF tn3270_access_detail.default_record Specifies whether this entry is the default record. Possible values are: AP_YES This is the default record. The client_address parameter is reserved. AP_NO This is a normal TN3270 user record. tn3270_access_detail.client_address The TCP/IP address of the TN3270 user. This is a null-terminated ASCII string. tn3270_access_detail.num_filtered_sessions The number of sessions returned for this user. tn3270_access_detail.
NOF API Verbs QUERY_TN3270_ASSOCIATION 3.161 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. 3.161.
NOF API Verbs QUERY_TN3270_ASSOCIATION 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 associations for which data should be returned. To request data for a specific association 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_TN3270_DEFAULTS C sizeof() operator. This is because the size of the returned overlay may increase in future releases of SNAplus2; using the returned overlay size ensures that your application will continue to work with future releases. 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_TN3270_DEFAULTS AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; TN3270_DEFAULTS_DEF_DATA def_data; } QUERY_TN3270_DEFAULTS; typedef struct tn3270_defaults_def_data { AP_UINT16 force_responses; AP_UINT16 keepalive_method; AP_UINT32 keepalive_interval; unsigned char reserv2[32]; } TN3270_DEFAULTS_DEF_DATA; /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code TN3270 defaults */ */
NOF API Verbs QUERY_TN_SERVER_TRACE def_data.keepalive_interval Interval (in seconds) between consecutive keep-alive messages. The interval should be long enough to minimize network traffic, especially if there are typically many idle client connections. The shorter the keepalive interval, the quicker failures are detected, but the more network traffic is generated. If the keep-alive interval is too short and there are many clients, this traffic can be significant.
NOF API Verbs QUERY_TP trace_flags The types of tracing currently active. 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_TP unsigned char unsigned char unsigned char } QUERY_TP; lu_name[8]; lu_alias[8]; tp_name[64]; typedef struct tp_data { AP_UINT16 overlay_size; unsigned char tp_name[64]; unsigned char description[32]; unsigned char reserv1[16]; AP_UINT16 instance_limit; AP_UINT16 instance_count; AP_UINT16 locally_started_count; AP_UINT16 unsigned char } TP_DATA; remotely_started_count; reserva[20]; /* LU name /* LU alias /* TP name */ */ */ /* /* /* /* /* /* /* /* /* /* /* */ */ */ */ */ */ */ *
NOF API Verbs QUERY_TP 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. This is an 8-byte ASCII string, 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 8 binary zeros; it is ignored otherwise.
NOF API Verbs QUERY_TP_DEFINITION 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). 3.164.
NOF API Verbs QUERY_TP_DEFINITION unsigned char *buf_ptr; AP_UINT32 buf_size; AP_UINT32 total_buf_size; AP_UINT16 num_entries; AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char tp_name[64]; } QUERY_TP_DEFINITION; typedef struct tp_def_summary { AP_UINT16 overlay_size; unsigned char tp_name[64]; unsigned char description[32]; unsigned char reserv1[16]; } TP_DEF_SUMMARY; typedef struct tp_def_detail { AP_UINT16 overlay_size; unsigned char tp_name[64]; TP_CHARS tp_c
NOF API Verbs QUERY_TP_DEFINITION num_entries Maximum number of TPs for which data should be returned. To request data for a specific TP 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_TP_DEFINITION tp_def_summary.overlay_size The size of the returned tp_def_summary structure, and therefore the offset to the start of the next entry in the data buffer. When your application needs to go through the returned buffer to find each tp_def_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_TP_DEFINITION Specifies the values of synchronization level supported by the TP. Possible values are: AP_NONE The TP supports only sync_level NONE. AP_CONFIRM_SYNC_LEVEL The TP supports only sync_level CONFIRM. AP_EITHER The TP supports either sync_level NONE or CONFIRM. AP_SYNCPT_REQUIRED The TP supports only sync_level SYNCPT (syncpoint is required). AP_SYNCPT_NEGOTIABLE The TP supports any of the three sync_level values NONE, CONFIRM, and SYNCPT. tp_def_detail.tp_chars.
NOF API Verbs QUERY_TP_LOAD_INFO 3.165.4 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_TP_LOAD_INFO unsigned char unsigned char TP_LOAD_INFO_DEF_DATA } TP_LOAD_INFO; tp_name[64]; lu_alias[8]; def_data; typedef struct tp_load_info_def_data { unsigned char description[32]; unsigned char reserv1[16]; unsigned char user_id[64]; unsigned char group_id[64]; unsigned shor timeout; unsigned char type; unsigned char reserv2; AP_UINT16 reserv3; AP_UINT16 ltv_length; } TP_LOAD_INFO_DEF_DATA; /* TP name /* LU alias /* defined data */ */ */ /* /* /* /* /* /* /* /* /* */ */ */ */
NOF API Verbs QUERY_TP_LOAD_INFO lu_alias The LU alias to query. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. Specify all binary zeroes to match on all LUs. This parameter can be used only if the TP is an APPC application; it is reserved if the TP is a CPI-C application. 3.166.
NOF API Verbs QUERY_TRACE_FILE def_data.timeout Timeout in seconds after the TP is loaded. def_data.type Indicates the TP type. Possible values are: AP_TP_TYPE_QUEUED AP_TP_TYPE_QUEUED_BROADCAST AP_TP_TYPE_NON_QUEUED def_data.ltv_length Length of the LTV data buffer appended to this structure. 3.166.
NOF API Verbs QUERY_TRACE_FILE unsigned char unsigned char AP_UINT32 unsigned char unsigned char unsigned char } QUERY_TRACE_FILE; trace_file_type; dual_files; trace_file_size; reserv3[4]; file_name[81]; file_name_2[81]; /* /* /* /* /* /* type of trace file dual trace files trace file size reserved file name second file name */ */ */ */ */ */ 3.167.2 Supplied Parameters The application supplies the following parameters: opcode AP_QUERY_TRACE_FILE trace_file_type The type of trace file.
NOF API Verbs QUERY_TRACE_TYPE trace_file_size The maximum size of the trace file. If dual_files is set to AP_YES, tracing will switch between the two files when the current file reaches this size. If dual_files is set to AP_NO, this parameter is ignored; the file size is not limited. file_name Name of the trace file, or of the first trace file if dual_files is set to AP_YES. This parameter is an ASCII string of 1–80 characters, followed by a NULL character (binary zero).
NOF API Verbs QUERY_TRACE_TYPE unsigned char AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT32 AP_UINT16 AP_UINT32 } QUERY_TRACE_TYPE; format; primary_rc; secondary_rc; trace_flags; truncation_length; internal_level; api_flags; /* /* /* /* /* /* /* reserved */ primary return code */ secondary return code */ trace flags */ truncate each msg to this size */ reserved */ reserved */ 3.168.2 Supplied Parameters The application supplies the following parameter: opcode AP_QUERY_TRACE_TYPE 3.168.
NOF API Verbs QUERY_USERID_PASSWORD AP_DLPI_MSG DLPI messages AP_SDLC_MSG SDLC messages AP_NLI_MSG NLI messages AP_IPDL_MSG Enterprise Extender (HPR/IP) 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_USERID_PASSWORD AP_UINT16 num_entries; AP_UINT16 total_num_entries; unsigned char list_options; unsigned char reserv3; unsigned char user_id[10]; } QUERY_USERID_PASSWORD; typedef struct userid_info { AP_UINT16 overlay_size; unsigned char user_id[10]; USERID_PASSWORD_CHARS password_chars; } USERID_INFO; typedef struct userid_password_chars { unsigned char description[32]; unsigned char reserv2[16]; AP_UINT16 profile_count; AP_UINT16 reserv1; unsigned char password[10]; unsigned char prof
NOF API Verbs QUERY_USERID_PASSWORD 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. The user ID is ignored if list_options is set to AP_FIRST_IN_LIST. 3.169.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.
NOF API Verbs REGISTER_INDICATION_SINK primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: 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 B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.169.
NOF API Verbs REGISTER_INDICATION_SINK 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; /* /* /* /* /* /* reserved primary return code secondary return code reserved reserved opcode of indication to be sunk */ */ */ */ */ */ 3.170.
NOF API Verbs REMOVE_DLC_TRACE • The indication_opcode parameter specified an indication type that does not apply to the specified target. If the target handle identifies the domain configuration file, only configuration indications are valid; if the target handle identifies the sna.net file, only SNA network file indications are valid; and if the target handle specifies a running node, all indications except SNA network file indications are valid.
NOF API Verbs REMOVE_DLC_TRACE unsigned char unsigned char SNA_LFSID unsigned char } DLC_TRACE_FILTER; resource_type; resource_name[8]; lfsid; message_type; typedef struct sna_lfsid { union { AP_UINT16 struct { unsigned char unsigned char } s; } uu; AP_UINT16 odai; } SNA_LFSID; /* /* /* /* type of name of session type of resource resource identifier messages */ */ */ */ session_id; sidh; sidl; 3.171.
NOF API Verbs REMOVE_DLC_TRACE Modify tracing for the port named in resource_name and its implicit LSs. resource_name The name of the DLC, port, LS, or RTP connection 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. This is only valid for resource_type AP_LS, and indicates that only messages on this session are to be removed.
NOF API Verbs REMOVE_DLC_TRACE primary_rc AP_OK secondary_rc Not used. 3.171.4 Returned Parameters: Parameter Check If the verb does not execute because of a parameter error, SNAplus2 returns one of the following. primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_RESOURCE_TYPE The resource_type parameter specified a value that was not valid. AP_INVALID_MESSAGE_TYPE The message_type parameter specified a value that was not valid.
NOF API Verbs RESET_SESSION_LIMIT 3.172 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. 3.172.
NOF API Verbs RESET_SESSION_LIMIT 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. To indicate that the partner LU is defined by its fully qualified LU name instead of its LU alias, set this parameter to 8 binary zeros. fqplu_name Fully qualified LU name for the partner LU, as defined to SNAplus2. This parameter is used only if the plu_alias field is set to zeros; it is ignored if plu_alias is specified.
NOF API Verbs RESET_SESSION_LIMIT Waiting session requests are satisfied. AP_NO Waiting session requests are not satisfied. drain_target Specifies whether the target LU satisfies waiting session requests before deactivating a session. Possible values are: AP_YES Waiting session requests are satisfied. AP_NO Waiting session requests are not satisfied. force Specifies whether session limits will be set to zero even if CNOS negotiation fails. Possible values are: AP_YES Session limits will be set to zero.
NOF API Verbs RESET_SESSION_LIMIT AP_INVALID_LU_ALIAS The lu_alias parameter did not match any defined local LU alias. AP_INVALID_LU_NAME The lu_name parameter did not match any defined local LU name. AP_INVALID_MODE_NAME The mode_name parameter did not match any defined mode name. AP_INVALID_PLU_NAME The fqplu_name parameter did not match any defined partner LU name. AP_INVALID_MODE_NAME_SELECT The mode_name_select parameter was not set to a valid value.
NOF API Verbs SET_BCK_CS_TRACE A session could not be allocated because of a condition that requires corrective action. Check the sense_data parameter and any logged messages to determine the reason for the failure, and take any action required. Do not attempt to retry the verb until the condition has been corrected. sense_data The SNA sense data associated with the allocation failure. 3.172.
NOF API Verbs SET_BCK_CS_TRACE unsigned char unsigned char AP_UINT16 AP_UINT32 AP_UINT32 unsigned char unsigned char reserv2; format; primary_rc; secondary_rc; trace_flags; init_flags; set_flags; unsigned char reserv3[6]; } SET_BCK_CS_TRACE; /* /* /* /* /* /* /* /* /* reserved reserved primary return code secondary return code trace flags YES if initializing flags YES if setting flags NO if unsetting flags Reserved */ */ */ */ */ */ */ */ */ 3.173.
NOF API Verbs SET_BUFFER_AVAILABILITY Tracing is being initialized. The trace_flags parameter defines the required state of tracing at all interfaces. AP_NO 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.
NOF API Verbs SET_CENTRAL_LOGGING 3.174.1 VCB Structure typedef struct set_buffer_availability { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; AP_UINT32 buf_avail; unsigned char reserv3[8]; } SET_BUFFER_AVAILABILITY; /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code maximum buffer space available reserved */ */ */ */ */ */ */ 3.174.
NOF API Verbs SET_CENTRAL_LOGGING unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char enabled; unsigned char reserv3[3]; } SET_CENTRAL_LOGGING; /* /* /* /* /* /* reserved reserved primary return code secondary return code is central logging enabled? reserved */ */ */ */ */ */ 3.175.2 Supplied Parameters The application supplies the following parameters: opcode AP_SET_CENTRAL_LOGGING enabled Specify whether central logging is enabled or disabled.
NOF API Verbs SET_CS_TRACE 3.176 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 must be issued to a running node. 3.176.
NOF API Verbs SET_CS_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. AP_CS_ADMIN_MSG Internal messages relating to client-server topology AP_CS_DATAGRAM Datagram messages AP_CS_DATA Data messages trace_direction Specifies the direction(s) in which tracing is required. This parameter is ignored if trace_flags is set to AP_NO_TRACE.
NOF API Verbs SET_GLOBAL_LOG_TYPE The trace_direction parameter was not set to a valid value. AP_INVALID_TARGET The verb was issued on a standalone server. This verb can only be issued on a client-server system. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.176.
NOF API Verbs SET_GLOBAL_LOG_TYPE unsigned char succinct_errors; unsigned char reserv3[4]; } SET_GLOBAL_LOG_TYPE; /* use succinct logging in error file?*/ /* reserved */ 3.177.2 Supplied Parameters The application supplies the following parameters: opcode AP_SET_GLOBAL_LOG_TYPE audit Specify whether audit messages are recorded. Possible values are: AP_YES Audit messages are recorded. AP_NO Audit messages are not recorded. AP_LEAVE_UNCHANGED Leave audit logging unchanged from the existing definition.
NOF API Verbs SET_KERNEL_MEMORY_LIMIT 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 SET_LOG_FILE AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; AP_UINT32 limit; unsigned char reserv3[8]; } SET_KERNEL_MEMORY_LIMIT; /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code kernel memory limit, 0 => no limit Reserved */ */ */ */ */ */ */ 3.178.
NOF API Verbs SET_LOG_FILE 3.179.
NOF API Verbs SET_LOG_FILE Name of the new log file. To create the file in the default directory for diagnostics files, /var/opt/sna, specify the file name with no path. To create the file in a different directory, specify either 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.
NOF API Verbs SET_LOG_TYPE AP_PARAMETER_CHECK secondary_rc Possible values are: AP_INVALID_FILE_ACTION The action parameter was not set to a valid value. AP_INVALID_FILE_TYPE The log_file_type parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.179.
NOF API Verbs SET_LOG_TYPE AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } SET_LOG_TYPE; secondary_rc; override; audit; exception; succinct_audits; succinct_errors; reserv3[3]; /* /* /* /* /* /* /* secondary return code */ override global defaults? */ audit logging on or off */ exception logging on or off */ use succinct logging in audit file?*/ use succinct logging in error file?*/ reserved */ 3.180.
NOF API Verbs SET_LOG_TYPE 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 SET_PROCESSING_MODE 3.181 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. This verb applies only to NOF applications running on a server.
NOF API Verbs SET_PROCESSING_MODE and then reset its processing mode to one of the other options, in order to release the file so that other NOF API applications or SNAplus2 components can access it. Note To obtain read/write access to the file, your NOF application must be running with a user ID that is a member of the SNA administrators group sna. If the user ID is not a member of this group, the only valid processing mode is AP_MODE_READ_ONLY. 3.181.
NOF API Verbs SET_TN_SERVER_TRACE AP_NOT_AUTHORIZED The NOF application cannot obtain read/write access to the file because it is running on a client, or because it is running with a user ID that is not a member of the SNA administrators group sna. If the user ID is not a member of this group, the only valid processing mode is AP_MODE_READ_ONLY.
NOF API Verbs SET_TRACE_FILE AP_TN_SERVER_NO_TRACE No tracing. AP_TN_SERVER_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 SET_TRACE_FILE AP_UINT16 unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char unsigned char AP_UINT32 unsigned char unsigned char unsigned char } SET_TRACE_FILE; opcode; reserv2; format; primary_rc; secondary_rc; trace_file_type; dual_files; trace_file_size; reserv3[4]; file_name[81]; file_name_2[81]; /* /* /* /* /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code type of trace file dual trace files trace file size reserved file nam
NOF API Verbs SET_TRACE_FILE trace_file_size The maximum size of the trace file, in bytes. To continue using the existing file size definition, specify zero. If dual_files is set to AP_YES, tracing will switch between the two files when the current file reaches this size. If dual_files is set to AP_NO, this parameter is ignored; the file size is not limited.
NOF API Verbs SET_TRACE_TYPE Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.183.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.184 SET_TRACE_TYPE This verb specifies tracing options for SNAplus2 kernel components.
NOF API Verbs SET_TRACE_TYPE 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 Section 3.184.6, Trace Types. If init_flags is set to AP_YES, select the values corresponding to the interfaces where you want tracing to be active, and do not select the values corresponding to the interfaces where you want it to be inactive.
NOF API Verbs SET_TRACE_TYPE 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. This allows you to record the most important information for each message but avoid filling up the file with long messages. To specify no truncation (all the data from each message is written to the file), set this parameter to zero.
NOF API Verbs SET_TRACE_TYPE 3.184.5 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.184.6 Trace Types Figure 3–1, Overall Structure of SNAplus2, shows the overall structure of SNAplus2. Each kernel-space trace type, relating to data transferred across a particular interface between SNAplus2 components, is shown in the diagram at the interface where it is traced.
NOF API Verbs START_DLC LUA messages Messages between the LUA library and the node NOF messages Messages between the NOF library and the node MS messages Messages between the MS library and the node DLC line trace 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
NOF API Verbs START_INTERNAL_PU Name of the DLC to be started. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes, which must match the name of a defined DLC. 3.185.
NOF API Verbs START_INTERNAL_PU This verb must be issued to a running node. 3.186.
NOF API Verbs START_INTERNAL_PU primary_rc AP_PARAMETER_CHECK secondary_rc Possible values are: 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. 3.186.5 Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs START_LS 3.186.7 Returned Parameters: Function Not Supported If the verb does not execute because the node’s configuration does not support it, SNAplus2 returns the following parameter: primary_rc AP_FUNCTION_NOT_SUPPORTED The node does not support DLUR; this is defined by the dlur_supported parameter on DEFINE_NODE. 3.186.8 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF API Verbs START_LS Name of the link station to be started. 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. enable Specifies the action to be taken for the LS. To start the LS, set this parameter to AP_ACTIVATE.
NOF API Verbs START_LS AP_ACTIVATION_LIMITS_REACHED The activation limits have been reached. AP_LINK_DEACT_IN_PROGRESS The specified LS is currently being deactivated. You cannot start it until the deactivation process has finished. AP_ALREADY_STARTING The specified LS is already starting. AP_PARALLEL_TGS_NOT_SUPPORTED A link to the remote system is already active. The adjacent node does not support parallel transmission groups.
NOF API Verbs START_PORT secondary_rc Possible values are: AP_NO_SECONDARY_RC A STOP_LS verb was issued before the START_LS verb had completed. The START_LS verb was cancelled. AP_LINK_DEACTIVATED The DLC or port used by the LS was stopped before the START_LS verb had completed. The START_LS verb was cancelled. react_kicked Specifies whether SNAplus2 will retry the attempt to activate the LS (based on the react_timer_retry parameter in the LS definition).
NOF API Verbs START_PORT port_name Name of port to be started. 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_PORT verb. 3.188.3 Returned Parameters: Successful Execution If the verb executes successfully, SNAplus2 returns the following parameters: primary_rc AP_OK 3.188.
NOF API Verbs STOP_DLC A STOP_PORT verb was issued before this verb had completed. The START_PORT verb was cancelled. 3.188.7 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs. 3.189 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. 3.189.
NOF API Verbs STOP_INTERNAL_PU AP_OK 3.189.4 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. AP_UNRECOGNIZED_DEACT_TYPE The stop_type parameter was not set to a valid value.
NOF API Verbs STOP_INTERNAL_PU This verb must be issued to a running node. 3.190.1 VCB Structure typedef struct stop_internal_pu { AP_UINT16 opcode; unsigned char reserv2; unsigned char format; AP_UINT16 primary_rc; AP_UINT32 secondary_rc; unsigned char pu_name[8]; unsigned char stop_type; } STOP_INTERNAL_PU; /* /* /* /* /* /* /* verb operation code reserved reserved primary return code secondary return code internal PU name type of stop requested */ */ */ */ */ */ */ 3.190.
NOF API Verbs STOP_LS 3.190.5 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_DEFINED The supplied PU name did not match the name of a defined internal PU. AP_PU_ALREADY_DEACTIVATING The PU is already in the process of being stopped. AP_PU_NOT_ACTIVE The PU is not active. 3.190.
NOF API Verbs STOP_LS unsigned char unsigned char } STOP_LS; disable; reserved[3]; /* disable remote or auto activation? */ /* reserved */ 3.191.2 Supplied Parameters The application supplies the following parameters: opcode AP_STOP_LS stop_type Type of stop processing required. Possible values are: AP_ORDERLY_STOP SNAplus2 will perform cleanup operations before stopping the LS. AP_IMMEDIATE_STOP SNAplus2 will stop the LS immediately. ls_name Name of LS to be stopped.
NOF API Verbs STOP_PORT secondary_rc Possible values are: AP_LINK_NOT_DEFD The ls_name parameter did not match the name of a defined LS. AP_UNRECOGNIZED_DEACT_TYPE The stop_type parameter was not set to a valid value. Appendix B, Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs. 3.191.5 Returned Parameters: State Check If the verb does not execute because of a state error, SNAplus2 returns the following parameters.
NOF API Verbs STOP_PORT unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char unsigned char } STOP_PORT; reserv2; format; primary_rc; secondary_rc; stop_type; port_name[8]; /* /* /* /* /* /* reserved reserved primary return code secondary return code Stop Type name of port */ */ */ */ */ */ 3.192.2 Supplied Parameters The application supplies the following parameters: opcode AP_STOP_PORT stop_type Type of stop processing required.
NOF API Verbs TERM_NODE 3.192.5 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_STOP_PORT_PENDING The specified port is already in the process of being deactivated. Appendix B, Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs. 3.192.
NOF API Verbs UNREGISTER_INDICATION_SINK opcode AP_TERM_NODE stop_type Specifies how SNAplus2 should stop the node. Possible values are: AP_ABORT Stop immediately without attempting any cleanup processing. This value should be used only in serious error conditions, because it may cause problems for other programs using the node’s resources. AP_SHUTDOWN Deactivate all LSs associated with the node before stopping.
NOF API Verbs UNREGISTER_INDICATION_SINK 3.194.1 VCB Structure typedef struct unregister_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; /* } UNREGISTER_INDICATION_SINK; verb operation code reserved reserved primary return code secondary return code reserved reserved opcode of indication to be unsunk */ */ */ */ */ */ */ */ 3.194.
NOF API Verbs UNREGISTER_INDICATION_SINK 3.194.6 Returned Parameters: Other Conditions Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.
NOF Indications CONFIG_INDICATION 4 NOF Indications 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 /usr/include/sna/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 Section 3.170, REGISTER_INDICATION_SINK. 4.
NOF Indications DIRECTORY_INDICATION Running node The application can receive VCBs for any verbs that modify node resources, TERM_NODE VCBs, and START_* and STOP_* VCBs for DLCs, ports, and LSs. Inactive node The application can receive VCBs for any verbs that modify node resources and also INIT_NODE VCBs. 4.2 DIRECTORY_INDICATION This indication is generated when an entry is added to or removed from the local directory database. 4.2.
NOF Indications DIRECTORY_INDICATION AP_NO No previous directory indications were lost. removed Specifies whether the indicated resource has been removed from the directory or added to it. Possible values are: AP_YES The entry has been removed. AP_NO The entry has been added. resource_name Fully qualified name of the resource. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF Indications DIRECTORY_INDICATION Local resource. AP_CACHE Cached entry. AP_REGISTER Registered resource (NN only) parent_type Specifies the parent type of the resource being registered. If resource_type is AP_NNCP_RESOURCE, this parameter is not used. Possible values are: AP_NNCP_RESOURCE Network node. AP_ENCP_RESOURCE End node. description A null-terminated text string describing the resource, as specified in the definition of the resource.
NOF Indications DLC_INDICATION of the local node, the BrNN is the supplier because it registers the resource with the local node, but the real owning CP is the End Node. supplier_cp_name This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved otherwise.
NOF Indications DLUR_LU_INDICATION deactivated Specifies whether the DLC has become inactive or become active. Possible values are: AP_YES The DLC has become inactive. AP_NO The DLC has become active. dlc_name Name of DLC. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. description A null-terminated text string describing the DLC, as specified in the definition of the DLC. 4.
NOF Indications DLUR_PU_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. reason Reason for this indication. Possible values are: AP_ADDED The DLUR has just been activated by the DLUS. AP_REMOVED The DLUR has been deactivated, either explicitly by the DLUS or implicitly by a link failure or the deactivation of the PU. lu_name Name of the logical unit (LU).
NOF Indications DLUR_PU_INDICATION 4.5.2 Parameters opcode AP_DLUR_PU_INDICATION primary_rc AP_OK data_lost Specifies whether any previous directory 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 directory indications were lost.
NOF Indications DLUS_INDICATION AP_RESET_NO_RETRY The PU is in reset state and will not be retried. AP_RESET_RETRY The PU is in reset state and will be retried. AP_PEND_ACTPU The PU is waiting for an ACTPU from the host. AP_PEND_ACTPU_RSP Having forwarded an ACTPU to the PU, DLUR is now waiting for the PU to respond to it. AP_ACTIVE The PU is active. AP_PEND_DACTPU_RSP Having forwarded a DACTPU to the PU, DLUR is now waiting for the PU to respond to it.
NOF Indications DLUS_INDICATION AP_UINT16 AP_UINT32 unsigned char unsigned char unsigned char unsigned char PIPE_STATS unsigned char unsigned char unsigned char } DLUS_INDICATION; primary_rc; secondary_rc; data_lost; deactivated; dlus_name[17]; reserv1; pipe_stats; persistent_pipe_support; persistent_pipe; reserva[18]; 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
NOF Indications DLUS_INDICATION The pipe has become inactive. AP_NO The pipe has become active. dlus_name Name of the DLUS 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. If the pipe was deactivated, a pipe_stats structure is included. The fields in this structure are as follows: pipe_stats.
NOF Indications DOWNSTREAM_LU_INDICATION pipe_stats.sscp_lu_mus_sent Number of SSCP-LU MUs sent to DLUS over the pipe. 4.7 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. 4.7.
NOF Indications DOWNSTREAM_LU_INDICATION unsigned char unsigned char } SESSION_STATS; ls_name[8]; reserve; /* Link station name /* reserved */ */ 4.7.2 Parameters opcode AP_DOWNSTREAM_LU_INDICATION primary_rc AP_OK data_lost Specifies whether any previous downstream LU indications have been lost.
NOF Indications DOWNSTREAM_LU_INDICATION AP_NO The session is not active. dspu_services Specifies the services provided by the local node to the downstream LU. Possible values are: AP_PU_CONCENTRATION Downstream LU is served by PU concentration. AP_DLUR Downstream LU is served by DLUR.
NOF Indications DOWNSTREAM_PU_INDICATION rcv_fmd_data_frames Number of normal flow FMD data frames received. rcv_data_bytes Number of normal flow data bytes received. sidh Session ID high byte. (In the upstream PLU-SLU session statistics, this parameter is reserved.) sidl Session ID low byte. (In the upstream PLU-SLU session statistics, this parameter is reserved.) odai Origin Destination Assignor Indicator.
NOF Indications DOWNSTREAM_PU_INDICATION 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; 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_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; reserve; /* /
NOF Indications DOWNSTREAM_PU_INDICATION The session is not active. dspu_services Specifies the services provided by the local node to the downstream PU. Possible values are: AP_PU_CONCENTRATION Downstream LU is served by PU concentration. AP_DLUR Downstream LU is served by DLUR. pu_sscp_stats.rcv_ru_size Reserved (always set to zero). pu_sscp_stats.send_ru_size Reserved (always set to zero). pu_sscp_stats.max_send_btu_size Maximum BTU size that can be sent. pu_sscp_stats.
NOF Indications FOCAL_POINT_INDICATION pu_sscp_stats.sidl Session ID low byte. 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_sscp_stats.ls_name Link station name associated with statistics.
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 ISR_INDICATION 4.10 ISR_INDICATION This indication is generated when an intermediate session routing (ISR) session is activated or deactivated. When the session is deactivated, the returned data includes statistics on the session’s usage. 4.10.
NOF Indications ISR_INDICATION unsigned char unsigned char unsigned char } SESSION_STATS; odai; ls_name[8]; reserve; /* ODAI bit set /* Link station name /* reserved */ */ */ 4.10.2 Parameters opcode AP_ISR_INDICATION primary_rc AP_OK data_lost Specifies whether any previous ISR indications have been lost.
NOF Indications ISR_INDICATION cos_name COS name for this session; this parameter is reserved if deactivated is set to AP_YES. This is an 8-byte type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces. transmission_priority The transmission priority associated with the session. This parameter is reserved if deactivated is set to AP_YES. sense_data The sense data sent or received on the UNBIND request. This parameter is reserved if deactivated is set to AP_NO.
NOF Indications LOCAL_LU_INDICATION sidh Session ID high byte. sidl Session ID low byte. odai Origin Destination Assignor Indicator. When bringing up a session, the sender of the BIND sets this field to zero if its local node contains the primary link station, and sets it to one if its local node contains the secondary link station. ls_name Link station name associated with statistics.
NOF Indications LOCAL_LU_INDICATION 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_data_frames; /* number of data frames sent */ send_fmd_data_frames; /* num of fmd data frames sent */ send_data_bytes; /* number of data bytes sent */ rcv_data_frames; /* number of data frames received */ rcv_fmd_data_frames; /* num of fmd data frames received */ rcv_data_bytes; /* number of data bytes received */ sidh;
NOF Indications LOCAL_LU_INDICATION lu_alias Locally defined LU alias. This is an 8-byte string in a locally displayable character set. All eight bytes are significant. nau_address Network accessible unit (NAU) address of the LU. This value must be in the range 1–255. A nonzero value implies that the LU is a dependent LU. The value 0 (zero) implies that the LU is an independent LU. pu_name Name of the physical unit (PU) that this LU uses.
NOF Indications LOCAL_TOPOLOGY_INDICATION Number of normal flow data frames received. lu_sscp_stats.rcv_fmd_data_frames Number of normal flow function management data (FMD) frames received. lu_sscp_stats.rcv_data_bytes Number of normal flow data bytes received. lu_sscp_stats.sidh Session ID high byte. lu_sscp_stats.sidl Session ID low byte. lu_sscp_stats.odai Origin Destination Assignor indicator.
NOF Indications LOCAL_TOPOLOGY_INDICATION unsigned char dest_type; /* unsigned char tg_num; /* unsigned char cp_cp_session_active; unsigned char branch_link_type; unsigned char branch_tg; unsigned char reserva[17]; } LOCAL_TOPOLOGY_INDICATION; TG TG /* /* /* /* destination node type number CP-CP sessions active? Up or down link? Branch TG? reserved */ */ */ */ */ */ 4.12.
NOF Indications LS_INDICATION AP_YES The CP-CP session is active. AP_NO The CP-CP session is not active. AP_UNKNOWN The CP-CP session status is unknown. branch_link_type This parameter applies only if the node is a Branch Network Node; it is reserved otherwise. Specifies the branch link type of this TG. Possible values are: AP_UPLINK The TG is an uplink. AP_DOWNLINK The TG is a downlink to an End Node.
NOF Indications LS_INDICATION AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char AP_UINT16 unsigned char LS_STATS unsigned char AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } LS_INDICATION; secondary_rc; data_lost; deactivated; ls_name[8]; description[32]; reserv1[16]; adj_cp_name[17]; adj_node_type; act_sess_count; indication_cause; ls_stats; tg_num; sense_data; brnn_link_type; adj_cp_is_brnn; mltg_m
NOF Indications LS_INDICATION AP_YES One or more previous LS indications were lost. Later fields in this VCB may be set to zeros. AP_NO No previous LS indications were lost. deactivated Specifies whether the LS has been deactivated or activated. Possible values are: AP_YES The LS has been deactivated. AP_NO The LS has been activated. ls_name Name of the link station. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes.
NOF Indications LS_INDICATION 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. AP_ACTIVATION_FAILED The LS supports auto-activation, but the attempt to start it automatically when required has failed.
NOF Indications LS_INDICATION ls_stats.bad_xids 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 AP_LS_DLUS_DEFINED The link station is a dynamic link station to a DLUR-served downstream PU, and was defined when the local node received an ACTPU from a DLUS. 4.14 LU_0_TO_3_INDICATION This indication is generated when the session status of a type 0–3 LU changes. 4.14.
NOF Indications LU_0_TO_3_INDICATION } SESSION_STATS; 4.14.2 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. 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 LU 0–3 indications were lost.
NOF Indications LU_0_TO_3_INDICATION AP_YES The session is active. AP_NO The session is not active. 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 sscp_id For dependent LU sessions, this parameter is the SSCP ID received in the ACTPU from the host for the PU to which the local LU is mapped. For independent LU sessions, this parameter is set to 0 (zero).
NOF Indications MODE_INDICATION 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. sidl Session ID low byte. odai Origin Destination Assignor Indicator.
NOF Indications NN_TOPOLOGY_NODE_INDICATION } MODE_INDICATION; 4.15.2 Parameters opcode AP_MODE_INDICATION primary_rc AP_OK data_lost Specifies whether any previous mode 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 mode indications were lost.
NOF Indications NN_TOPOLOGY_NODE_INDICATION 4.16.
NOF Indications NN_TOPOLOGY_TG_INDICATION Virtual routing node. branch_aware Specifies whether the node supports branch awareness, APPN Option Set 1120. AP_NO The node does not support option set 1120. AP_YES The node supports option set 1120. 4.17 NN_TOPOLOGY_TG_INDICATION This indication is generated when a TG entry in a network node’s topology database is activated or deactivated. 4.17.
NOF Indications NN_TOPOLOGY_TG_INDICATION AP_NO No previous NN topology TG 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 owner Name of the TG’s originating node (the SNAplus2 local node name). The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces.
NOF Indications NOF_STATUS_INDICATION The TG type is unknown. 4.18 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).
NOF Indications PLU_INDICATION This value is returned only when the application is connected to the master configuration file (specified by the requested_role parameter on OPEN_FILE). Another server has now taken over as master, so the target file is no longer the master configuration file. If the application needs to make further changes to the running configuration, it must use CLOSE_FILE to end its connection with the file, and then issue OPEN_FILE again to access the new master configuration file.
NOF Indications PORT_INDICATION 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. lu_alias Local 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 PU_INDICATION unsigned char unsigned char AP_UINT16 AP_UINT32 unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char } PORT_INDICATION; reserv2; format; primary_rc; secondary_rc; data_lost; deactivated; port_name[8]; description[32]; reserv1[16]; reserva[20]; /* /* /* /* /* /* /* /* /* /* reserved reserved primary return code secondary return code previous indication lost has session been deactivated? port name resource description reserved reserved */ */ */
NOF Indications PU_INDICATION 4.21.
NOF Indications PU_INDICATION One or more previous PU indications were lost. Later fields in this VCB may be set to zeros. AP_NO No previous PU indications were lost. pu_name Name of the PU (specified on the DEFINE_LS verb). 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 PU, as specified in the definition of the PU.
NOF Indications REGISTRATION_FAILURE pu_sscp_stats.max_rcv_pac_win Reserved (always set to zero). pu_sscp_stats.cur_rcv_pac_win Reserved (always set to zero). pu_sscp_stats.send_data_frames Number of normal flow data frames sent. pu_sscp_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. pu_sscp_stats.send_data_bytes Number of normal flow data bytes sent. pu_sscp_stats.rcv_data_frames Number of normal flow data frames received. pu_sscp_stats.
NOF Indications REGISTRATION_FAILURE unsigned char data_lost; unsigned char resource_name[17]; AP_UINT16 resource_type; unsigned char description[32]; unsigned char reserv1[16]; unsigned char reserv2b[2]; AP_UINT32 sense_data; unsigned char reserva[20]; } REGISTRATION_FAILURE; /* /* /* /* /* /* /* /* previous indication lost */ network qualified resource name */ resource type */ resource description */ reserved */ reserved */ sense data */ reserved */ 4.22.
NOF Indications RTP_INDICATION 4.23 RTP_INDICATION This indication is generated when one of the following occurs: • An RTP connection is connected or disconnected. • The active session count changes. • The connection performs a path-switch. When the connection is disconnected, final RTP statistics are returned. At other times the rtp_stats parameter is reserved. 4.23.
NOF Indications RTP_INDICATION AP_UINT32 AP_UINT32 AP_INT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT32 AP_UINT16 unsigned char unsigned char } RTP_STATISTICS; /* received in_sc_frames; /* number of SC frames received out_sc_frames; /* number of SC frames sent delay_change_sum; /* delay change sum current_receiver_threshold; /* current ARB-R receiver threshold minimum_receiver_threshold; /* minimum ARB-R receiver threshold maximum_receiver_threshold; /* maximum ARB-R re
NOF Indications RTP_INDICATION Number of sessions currently active on the connection. indication_cause Cause of the indication. Possible values are: AP_ACTIVATED The connection has become active. AP_DEACTIVATED The connection has become inactive. AP_PATH_SWITCHED The connection has successfully completed a path switch. AP_SESS_COUNT_CHANGING The number of active sessions using the connection has changed. AP_SETUP_FAILED The connection has failed before becoming fully active.
NOF Indications RTP_INDICATION Total number of packets sent by the other end of the RTP connection that were discarded as duplicates of data already received. rtp_stats.gaps_detected Total number of gaps detected by the local node. Each gap corresponds to one or more lost frames. rtp_stats.send_rate Current send rate on this RTP connection, measured in kilobits per second. This is the maximum allowed send rate as calculated by the ARB algorithm. rtp_stats.
NOF Indications SERVER_INDICATION Total number of session control frames sent on this RTP connection. rtp_stats.delay_change_sum Value of the delay change sum currently held by the ARB-R algorithm on this RTP connection. rtp_stats.current_receiver_threshold Value of the receiver threshold currently held by the ARB-R algorithm on this RTP connection. rtp_stats.minimum_receiver_threshold Value of the minimum receiver threshold currently held by the ARB-R algorithm on this RTP connection. rtp_stats.
NOF Indications SERVER_INDICATION and flags parameters for changes; it can ignore any server indications where these parameters do not indicate a change. The REGISTER_INDICATION_SINK verb used to register for server indications should be issued with a null target handle; it is not associated with any particular target. 4.24.
NOF Indications SESSION_INDICATION Name of the server on which the SNA software has been started or stopped. 4.25 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. 4.25.
NOF Indications SESSION_INDICATION 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_data_frames; send_fmd_data_frames; send_data_bytes; rcv_data_frames; rcv_fmd_data_frames; rcv_data_bytes; sidh; sidl; odai; ls_name[8]; pacing_type; /* /* /* /* /* /* /* /* /* /* /* /* /* size */ number of data frames sent */ num fmd data frames sent */ number of data bytes sent */ number of data frames received */ num
NOF Indications SESSION_INDICATION Fully qualified LU name for the partner LU, as defined to SNAplus2. 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 an LU name of 1–8 A-string characters. mode_name 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.
NOF Indications SNA_NET_INDICATION Current size of the receive pacing window on this session. sess_stats.send_data_frames Number of normal flow data frames sent. sess_stats.send_fmd_data_frames Number of normal flow FMD data frames sent. sess_stats.send_data_bytes Number of normal flow data bytes sent. sess_stats.rcv_data_frames Number of normal flow data frames received. sess_stats.rcv_fmd_data_frames Number of normal flow FMD data frames received. sess_stats.
NOF Indications SNA_NET_INDICATION TER_INDICATION_SINK. When a change is made to the SNA network file, SNAplus2 then reports this to the application’s callback routine by sending a copy of the VCB from the NOF verb (ADD_BACKUP or DELETE_BACKUP) that made the change. To enable the application to distinguish between SNA network indications and asynchronous responses to its own NOF verbs issued to the SNA network file, SNAplus2 changes the primary_rc parameter in the VCB for an indication.
Appendix AReturn Code Values AppendixA Return Code Values This appendix lists all the possible return codes in the NOF interface in numerical order. The values are defined in the header file values_c.h. You can use this appendix as a reference to check the meaning of a return code received by your application. A.1 Primary Return Codes The following primary return codes are used in NOF applications.
Appendix AReturn Code Values AP_OPERATION_INCOMPLETE AP_OPERATION_NOT_ACCEPTED AP_CONVERSATION_ENDED AP_ERROR_INDICATION AP_EXPD_NOT_SUPPORTED_BY_LU AP_BUFFER_TOO_SMALL AP_MEMORY_ALLOCATION_FAILURE AP_INVALID_VERB 0x4000 0x4100 0x4200 0x4300 0x4400 0x4500 0x4600 0xFFFF A.2 Secondary Return Codes The following secondary return codes are used in NOF applications.
Appendix AReturn Code Values AP_BAD_ERROR_DIRECTION AP_INVALID_DATA_TYPE AP_TG_ROW_WGT_LESS_THAN_LAST AP_DUPLICATE_PORT_NUMBER AP_PU_ALREADY_ACTIVE AP_BAD_TP_TYPE AP_SEC_BAD_PASSWORD_MISSING AP_INVALID_STATS_TYPE AP_DUPLICATE_PORT_NAME AP_PU_NOT_ACTIVE AP_ALREADY_REGISTERED AP_SEC_BAD_GROUP_INVALID AP_AS_NEGOTIATED AP_INVALID_TABLE_TYPE AP_INVALID_DLC_NAME AP_DLUS_REJECTED AP_SEC_BAD_UID_REVOKED_IN_GRP AP_PORT_DEACTIVATED AP_INVALID_DLC_TYPE AP_DLUS_CAPS_MISMATCH AP_SEC_BAD_UID_NOT_DEFD_TO_GRP AP_ALLOCATE_
Appendix AReturn Code Values AP_BAD_SECURITY AP_INVALID_NN_SESSION_TYPE AP_LINK_DEACTIVATED AP_PARTNER_NOT_FOUND AP_PARTNER_NOT_RESPONDING AP_ERROR AP_DSPU_ALREADY_DEFINED AP_BAD_RETURN_CONTROL AP_INVALID_MAX_NEGOT_SESS_LIM AP_INVALID_SET_COLLECT_STATS AP_LINK_ACT_BY_REMOTE AP_INVALID_SOLICIT_SSCP_SESS AP_INVALID_BACK_LEVEL_SUPPORT AP_INVALID_MODE_NAME AP_INVALID_SET_COLLECT_NAMES AP_LINK_ACT_BY_LOCAL AP_INVALID_TG_NUMBER AP_MISSING_CP_NAME AP_MISSING_CP_TYPE AP_INVALID_CP_TYPE AP_DUPLICATE_TG_NUMBER AP_TG
Appendix AReturn Code Values AP_CPSVCMG_ALREADY_DEFD AP_INVALID_CN_NAME AP_INVALID_DRAIN_TARGET AP_TP_NAME_NOT_RECOGNIZED AP_INVALID_MIN_CONLOSERS AP_BAD_DUPLEX_TYPE AP_INVALID_BYPASS_SECURITY AP_DEF_LINK_INVALID_SECURITY AP_INVALID_FORCE AP_SYSTEM_TP_CANT_BE_CHANGED AP_INVALID_MAX_RU_SIZE_LOW AP_FDX_NOT_SUPPORTED_BY_LU AP_TEST_INVALID_FOR_FDX AP_INVALID_IMPLICIT_PLU_FORBID AP_INVALID_PROPAGATION_DELAY AP_SYSTEM_TP_CANT_BE_DELETED AP_INVALID_MAX_RECV_PACING_WIN AP_SEND_EXPD_INVALID_LENGTH AP_INVALID_SPECIF
Appendix AReturn Code Values AP_CONFIRM_NOT_LL_BDY AP_NO_PROFILES AP_INVALID_HPR_SUPPORT AP_CONFIRM_INVALID_FOR_FDX AP_CONVERSATION_TYPE_MISMATCH AP_INVALID_LU_MODEL AP_INVALID_MODEL_NAME AP_TOO_MANY_PROFILES AP_INVALID_CRYPTOGRAPHY AP_INVALID_UPDATE_TYPE AP_INVALID_CLU_CRYPTOGRAPHY AP_DIR_ENTRY_PARENT AP_INVALID_RESOURCE_TYPES AP_NODE_ALREADY_STARTED AP_CHECKSUM_FAILED AP_NODE_FAILED_TO_START AP_DATA_CORRUPT AP_LU_ALREADY_DEFINED AP_INVALID_RETRY_FLAGS AP_IMPLICIT_LU_DEFINED AP_DELAYED_VERB_PENDING AP_POR
Appendix AReturn Code Values AP_INVALID_FQPCID AP_MLTG_LINK_PROPERTIES_DIFFER AP_INVALID_POOL_NAME AP_INVALID_ADJ_CP_NAME AP_BAD_TYPE AP_INVALID_NAU_ADDRESS AP_INVALID_ENABLE_POOL AP_INVALID_SEND_TERM_SELF AP_DEALLOC_BAD_TYPE AP_LU_NAME_POOL_NAME_CLASH AP_SECURITY_NOT_VALID AP_INVALID_TERM_METHOD AP_DEALLOC_FLUSH_BAD_STATE AP_INVALID_PRIORITY AP_INVALID_DISABLE_BRANCH_AWRN AP_DEALLOC_CONFIRM_BAD_STATE AP_INVALID_DNST_LU_NAME AP_INVALID_SHARING_PROHIBITED AP_INVALID_HOST_LU_NAME AP_INVALID_LINK_SPEC_FORMAT
Appendix AReturn Code Values AP_COS_TABLE_FULL AP_INCONSISTENT_IMPLICIT AP_INVALID_DAYS_LEFT AP_INVALID_PREFER_ACTIVE_DLUS AP_ANYNET_NOT_SUPPORTED AP_INVALID_PERSIST_PIPE_SUPP AP_INVALID_DISCOVERY_SUPPORT AP_ACTIVATION_PROHIBITED AP_SESSION_FAIL_ALREADY_REGD AP_INVALID_NULL_ADDR_MEANING AP_CANT_MODIFY_VISIBILITY AP_INVALID_CPLU_SYNCPT_SUPPORT AP_CANT_MODIFY_WHEN_ACTIVE AP_INVALID_CPLU_ATTRIBUTES AP_INVALID_BASE_NUMBER AP_INVALID_REG_LEN_SUPPORT AP_DEACT_CG_INVALID_CGID AP_INVALID_NAME_ATTRIBUTES AP_LUNAME_
Appendix AReturn Code Values AP_INVALID_LINK_ENABLE AP_INVALID_CLU_COMPRESSION AP_INVALID_DLUR_SUPPORT AP_ALREADY_STARTING AP_RCV_IMMD_BAD_STATE AP_INVALID_LINK_NAME AP_INVALID_USER_DEF_1 AP_RCV_IMMD_BAD_FILL AP_INVALID_USER_DEF_2 AP_INVALID_NODE_TYPE AP_INVALID_USER_DEF_3 AP_INVALID_NAME_LEN AP_INVALID_NETID_LEN AP_INVALID_NODE_TYPE_FOR_HPR AP_INVALID_MAX_DECOMPRESS_LVL AP_INVALID_CP_NAME AP_INVALID_COMP_IN_SERIES AP_INVALID_LIMITED_RESOURCE AP_RCV_AND_POST_BAD_STATE AP_INVALID_BYTE_COST AP_RCV_AND_POST_N
Appendix BCommon Return Codes AppendixB Common Return Codes 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 3, NOF API Verbs. B.
Appendix BCommon Return Codes 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.
Appendix BCommon Return Codes AP_INVALID_VERB_SEGMENT The verb control block extended beyond the end of a data segment. The verb did not execute. A secondary return code is not returned. B.5 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.
Appendix BCommon Return Codes AP_FILE_LOCK_FAILED The application issued SET_PROCESSING_MODE to change to commit mode, but SNAplus2 failed to get a lock on the configuration file. This can be because another NOF API application or SNAplus2 component is already accessing the file. AP_FILE_UNLOCK_FAILED The application issued SET_PROCESSING_MODE to change from commit mode to one of the other modes, but SNAplus2 failed to release its lock on the configuration file.
Index 3270 emulation program diagnostics parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 A access list, conversation security ACTIVATE_SESSION . . . . activating a session . . . . . ADD_BACKUP . . . . . . ADD_DLC_TRACE . . . . . APING . . . . . . . . . . APPN node . . . . . . . . asynchronous entry point callback routine . . . . . callback routine, Windows . HP-UX . . . . . . . . . overview . . . . . . . . Windows . . . . . . . . audit log file . . . . . . . . . . . . . . .
opening . . . . . . configuration indication . configuration, node . . CONNECT_NODE . . corr (correlator) . . . . Windows . . . . . COS defining . . . . . . getting information . node row . . . . . TG row . . . . . . CPI-C, side information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DEFINE_TN3270_DEFAULTS . . . . DEFINE_TP . . . . . . . . . . . . DEFINE_TP_LOAD_INFO . . . . . . DEFINE_USERID_PASSWORD . . . . DELETE_ADJACENT_LEN_NODE . . DELETE_BACKUP . . . . . . . . . DELETE_CN . . . . . . . . . . . DELETE_COS . . . . . . . . . . . DELETE_CPIC_SIDE_INFO . . . . . DELETE_DIRECTORY_ENTRY . . . . DELETE_DLC . . . . . . . . . . . DELETE_DOWNSTREAM_LU . . . . DELETE_DOWNSTREAM_LU_RANGE DELETE_DSPU_TEMPLATE . . . . . DELETE_EMULATOR_USER . . . . . DELETE_FOCAL_POINT . . . . . .
DLUR_LU_INDICATION . . . . DLUR_PU_INDICATION . . . . DLUS . . . . . . . . . . . . DLUS_INDICATION . . . . . . documentation set . . . . . . . . domain configuration . . . . . . domain configuration file . . . . . on multiple servers . . . . . . domain resources, configuration file . downstream computer . . . . . . downstream LU . . . . . . . . . downstream PU . . . . . . . . . DOWNSTREAM_LU_INDICATION DOWNSTREAM_PU_INDICATION DSPU template . . . . . . . . . E end node . entry points HP-UX .
querying . . . . . . . . . . list options for QUERY_* verbs . . local LU conversations . . . . . . . . defining . . . . . . . . . . . querying . . . . . . . . . . sessions . . . . . . . . . . . local topology . . . . . . . . . LOCAL_LU_INDICATION . . . . LOCAL_TOPOLOGY_INDICATION log file . . . . . . . . . . . . log message type . . . . . . . . log messages central logging . . . . . . . . log messages, central logging . . . LS defining . . . . . . . . . . . querying . . . . . . . . . . starting . . . . . .
restrictions . . . . . . . . . . . topology . . . . . . . . . . . . network topology querying . . . . . . . . . . . . statistics . . . . . . . . . . . . NN_TOPOLOGY_NODE_INDICATION . NN_TOPOLOGY_TG_INDICATION . . node connecting to . . . . . . . . . . defining . . . . . . . . . . . . . implementation of . . . . . . . . . limits . . . . . . . . . . . . . . options . . . . . . . . . . . . . querying . . . . . . . . . . . . resource usage . . . . . . . . . . starting . . . . . . . . . . . . . stopping . . . .
method of locating defining . . . . deleting . . . . querying . . . . password conversation security LU-LU . . . . . . session-level security PATH_SWITCH . . . PLU_INDICATION . . pool, LU . . . . . . port defining . . . . . . querying . . . . . starting . . . . . . statistics . . . . . stopping . . . . . PORT_INDICATION . prerequisite knowledge . primary return codes . . processing mode . . . PU . . . . . . . . . PU concentration . . . PU concentration support PU_INDICATION . . . . . . . . . . . . . . . .
QUERY_DLUR_DEFAULTS . . . . QUERY_DLUR_LU . . . . . . . . QUERY_DLUR_PU . . . . . . . . QUERY_DLUS . . . . . . . . . . QUERY_DOMAIN_CONFIG_FILE . . QUERY_DOWNSTREAM_LU . . . QUERY_DOWNSTREAM_PU . . . QUERY_DSPU_TEMPLATE . . . . QUERY_EMULATOR_USER_DEF . . QUERY_FOCAL_POINT . . . . . . QUERY_GLOBAL_LOG_TYPE . . . QUERY_ISR_SESSION . . . . . . QUERY_KERNEL_MEMORY_LIMIT QUERY_LOCAL_LU . . . . . . . QUERY_LOCAL_TOPOLOGY . . . QUERY_LOG_FILE . . . . . . . . QUERY_LOG_TYPE . . . . . . . QUERY_LS . . . . . . . . .
R RCF access . . . . . . . . . . defining . . . . . . . . . . preventing access . . . . . . REGISTER_INDICATION_SINK registering for indications . . . . REGISTRATION_FAILURE . . related publications . . . . . . REMOVE_DLC_TRACE . . . . RESET_SESSION_LIMIT . . . resources . . . . . . . . . . return codes primary . . . . . . . . . . secondary . . . . . . . . . return codes, common . . . . . RJE workstation . . . . . . . RTP connections parameters . . . . . . . . querying . . . . . . . . . switching path . . .
START_LS . . . . . START_PORT . . . . statistics LS . . . . . . . . network topology . . port . . . . . . . status indication . . . STOP_DLC . . . . . STOP_INTERNAL_PU . STOP_LS . . . . . . STOP_PORT . . . . . STREAMS buffers . . STREAMS components synchronous entry point HP-UX . . . . . . Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
