|
|
|
|
This chapter provides an introduction to the SNAP-IX NOF API. It includes the following information:
Purpose of the NOF API
SNAP-IX components and resources
Client-server operation
NOF verbs and indications
The SNAP-IX NOF API provides access to a standard set of commands, called NOF verbs, that can be used to administer the SNAP-IX system from within an application program. These verbs enable you to define and delete resources, specify SNAP-IX parameters such as diagnostics levels and file names, start and stop defined resources, query the definition or current status of resources, and manage which servers on the SNAP-IX LAN can act as backup masters if the master configuration file server is not available.
The NOF verbs provide the same functions as commands issued to the command-line administration program snaadmin, or as records in a SNAP-IX configuration file. For example, the NOF verb DEFINE_LOCAL_LU is equivalent both to a define_local_lu command issued to the snaadmin program, and to a define_local_lu record in a configuration file; all three of them perform the same function, which is to specify the parameters of a SNAP-IX local APPC LU.
You can use the Motif administration program xsnaadmin or the Web administration program to perform the same function as a NOF verb or an administration command (for example, to define a local APPC LU). However, this does not provide access to the full range of parameters included in some NOF verbs. For more information about using the Motif administration program or the Web administration program, refer to the SNAP-IX Administration Guide.
You can issue NOF verbs to any of the following targets:
A running SNAP-IX node-to manage its resources or to monitor its operation
A server where the node is not running-to query the stored configuration or to modify it for use when the node is next started
The SNAP-IX domain as a whole-to define, modify, or query the configuration of domain resources (resources used to support particular user programs, such as 3270 diagnostics parameters and CPI-C side information entries, which are not associated with a particular node).
The SNAP-IX invokable TP data file-to define information that SNAP-IX needs to start invokable (target) TPs, or to define other information relating to a TP (such as the level of security required to access the TP).
The NOF API enables you to do the following:
Develop your own application programs to manage the SNAP-IX system
Develop application programs that use the other SNAP-IX APIs so that they can also manage their own resources (for example, an APPC application can check that the communications link to its partner TP is active before attempting to allocate a conversation or can define the remote LU where its partner TP is located).
Configuration information for each SNAP-IX 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 SNAP-IX is started. When you start the node, the file provides an initial definition of the resources that are available; you can then use the NOF API or the SNAP-IX administration tools to modify the running node's resources as your requirements change.
You can set up multiple configuration files, to store different SNAP-IX configurations for use at different times, and select which of these files to use when starting the SNAP-IX software.
Configuration in an APPN network is a dynamic process; you can add, delete, or modify resources as necessary while the SNAP-IX software is running. The configuration file provides an initial definition of the available resources and stores the current definition so that you can use it again when you need to restart the node, but it is not necessary to define the entire configuration before starting the SNAP-IX software.
Configuration information for SNAP-IX domain resources is held in a single text file on the master server. You can set up multiple domain configuration files, to store different SNAP-IX configurations for use at different times, and select which of these files to use when starting the SNAP-IX software on the master server.
Configuration in an APPN network is a dynamic process; you can add, delete, or modify resources as necessary while the system is running. The domain configuration file provides an initial definition of the available domain resources and enables you to store the current definition so that you can use it again when you need to restart the system, but it is not necessary to define the entire domain configuration before starting the SNAP-IX software or to restart the software when you make changes.
Information that SNAP-IX needs to start invokable (target) TPs is held in the file /etc/opt/sna/sna_tps. This file can also provide other information (such as the level of security required to access the TP). The invokable TP data file resides on the computer where the TPs run.
|
|
|
 |
|