Network management interfaces

z/OS® Communications Server provides information about network operations by supporting the following functions:
  • Systems Management Facilities (SMF) records
  • Programming interfaces that are called network management interfaces (NMIs)
For more information about the SMF record support, see SMF records.

Network monitor and management applications can use the network management interfaces to programmatically obtain information about both TCP⁄IP and VTAM® processing.

The z/OS Communications Server TCP⁄IP NMIs provide the following capabilities:

  • Programmatically obtain copies of TCP/IP packet, OSAENTA, and data trace buffers, in real time, based on global stack trace filters.
  • Programmatically obtain TCP/IP packet and data trace records in real-time, based on filters that are set by the network management application.
  • Format or filter the TCP/IP packet trace, OSAENTA packet trace, or data trace records that are collected.
  • Obtain the following information:
    • Activation and deactivation events that are buffered for TCP connections in SMF format
    • Information that is buffered by the TCP/IP stack's z/OS Encryption Readiness Technology in SMF format
    • Event information that is buffered for the FTP and TN3270 clients and servers in SMF format
    • Event information that is buffered for IP security in SMF format; information is provided from the IKE daemon and from the TCP/IP stack
    • Detailed information and statistics for IP filtering and IPSec security associations on local TCP⁄IP stacks
    • Detailed information and statistics for IP filtering and IPSec security associations on remote network security services (NSS) clients when using the NSS server
    • TCP/IP profile information and profile change information, which is buffered; this information is provided in SMF event records
    • TN3270E Telnet server profile information that is provided in SMF event records
    • CSSMTP information that is provided in SMF event records
    • Event information that is buffered for dynamic virtual IP addresses (DVIPAs) and sysplex distributor targets in SMF format
  • Control the following filters and associations:
    • IP filters and IPSec security associations on local TCP⁄IP stacks
    • IP filters and IPSec security associations on remote NSS clients when using the NSS server; see z/OS Communications Server: IP Configuration Guide for more information about network security services.
  • Monitor the following functions by using a callable API:
    • TCP connection and UDP endpoint activity
    • TCP⁄IP storage usage
    • TN3270E Telnet server connection performance
    • TCP/IP sysplex networking data
    • TCP/IP stack profile statement settings
    • TCP⁄IP interface attributes, statistics, and global stack statistics
    • TN3270E Telnet server profile statement settings
  • Drop one or multiple TCP connections or UDP endpoints.
The z/OS Communications Server VTAM NMIs provide the following functions:
  • The ability to collect Enterprise Extender (EE) summary and connection data
  • The ability to collect HPR endpoint data
  • Communication Storage Manager (CSM) storage statistics

Some of the information that is provided by these interfaces can be obtained from other types of documented interfaces that are provided by z/OS Communications Server such as SNMP, command display output, and VTAM exits. TCP⁄IP packet trace collection and formatting interfaces provide access to packet trace data that was not previously available through an authorized, real-time z/OS Communications Server interface. Some of the event information in SMF format is currently available through traditional SMF services, and can be collected by using an SMF user exit to monitor SMF records.

The interfaces that are described in this topic provide an alternative for collecting some of the TCP⁄IP SMF records and are expected to perform efficiently. Most of the data that is provided by the network management interface for monitoring TCP/UDP endpoints and TCP⁄IP storage described in TCP/IP callable NMI (EZBNMIFR) can be collected from supported SNMP MIBs. Storage usage information is available through displays and the VTAM Performance Monitor Interface (PMI). When used correctly, the interfaces documented in this document provide well-defined and efficient APIs to be used for obtaining management information related to the IP and SNA (VTAM) components of z/OS Communications Server. They also allow for easy application migration to subsequent z/OS Communications Server releases. They are targeted for use by responsible network management applications.

The following describe the programming interfaces for these functions in detail, and provide the information required to develop network management applications that use them. These interfaces have the following characteristics:
  • Use a client/server model or a called interface
  • Require all network management clients to be run locally on the same z/OS image as the Communications Server
  • Are provided for C/C++ and assembler, except as otherwise indicated

In this topic, the term TCP⁄IP represents the IP component of z/OS Communications Server and the term VTAM represents the SNA component of z/OS Communications Server.