Format and details for poll-type requests

The following poll-type requests are provided by EZBNMIFR. The request constant, which is specified in the NWMType field in the NWMHeader data structure, follows the request name. Some requests support filters. See Filter request section for a description of each filter and the information about which filters are supported by each request.

GetConnectionDetail (NWMTcpConnType)
Use this request to obtain information about active TCP connections, including SMC-R information for TCP connections that traverse SMC-R links.

Guideline: When you use filters with this request, you can experience a performance improvement in retrieving the connection details if every filter contains a 4-tuple (local address, local port, remote address and remote port) for a connection. Additional filter values can be specified in each filter along with the 4-tuple.
GetDVIPAConnRTab (NWMDvConnRTabType)
Use this request to obtain information about dynamic virtual IP addresses (DVIPA) connections. This call returns a list of IPv4 and IPv6 DVIPA TCP connections. Entries are returned for the following:
- All DVIPA interfaces for which MOVEABLE IMMEDIATE or NONDISRUPTIVE was specified.
- On a sysplex distributor routing stack, every connection that is being routed through this distributor.
- On a stack taking over a DVIPA, every connection to the DVIPA.
- On a sysplex distributor target stack or a stack that is in the process of giving up a DVIPA, every connection for which the stack is an endpoint.
If none of these apply, then an empty response buffer is returned with a successful reason value, return code, and reason code. If the invoked TCP/IP stack has not joined a sysplex, then return value -1, return code EAGAIN, and reason code JRMustBeSysplex are returned without any other data.
GetDVIPAList (NWMDvListType)
Use this request to obtain information about dynamic virtual IP addresses (DVIPAs). This request returns a list of all IPv4 and IPv6 DVIPAs for the invoked TCP/IP stack. For each DVIPA, the MVS™ system name, TCP/IP job name, and various status information are returned.
GetDVIPAPortDist (NWMDvPortDistType)
Use this request to obtain information about dynamic virtual IP address (DVIPA) port distribution. This request returns a list of IPv4 and IPv6 distributed DVIPAs and ports. For each distributed DVIPA and port pair, one or more entries are returned for each target TCP/IP stack. If the invoked TCP/IP stack has not joined a sysplex, then return value -1, return code EAGAIN, and reason code JRMustBeSysplex are returned without any other data. If the TCP/IP stack is not a distributing stack, then an empty response buffer is returned with a successful return value, return code, and reason code. If the same DVIPA and port pair are affected by more than one QOS Policy, then an entry with the same DVIPA and port is returned for each QOS policy.
GetDVIPARoute (NWMDvRouteType)
Use this request to obtain information about dynamic virtual IP address (DVIPA) routes. This request returns a list of information that is defined on VIPAROUTE profile statements. Each entry includes the dynamic XCF address of a target TCP/IP stack and the corresponding target IP address that is used to route connection requests to that TCP/IP stack. Output is returned only by a distributing TCP/IP stack, or by a backup TCP/IP stack for a distributed DVIPA when the backup TCP/IP stack is assuming ownership of the distributed DVIPA. If the invoked TCP/IP stack has not joined a sysplex, then return value -1, return code EAGAIN, and reason code JRMustBeSysplex are returned without any other data. If the invoked TCP/IP stack is neither a distributing stack nor a backup stack, then an empty response buffer is returned with a successful return value, return code, and reason code.
GetFTPDaemonConfig (NWMFTPDConfigType)
Use this request to obtain configuration data from one active FTP daemon.
Rules: You must supply only one filter when using this request type. If the filter number is not 1 in the request header, the following information is returned:
- Return value -1
- Return code EINVAL
- Reason code JRInvalidValue
The filter must contain the ASID of the specific FTP daemon for which you want to obtain the configuration data. If no ASID is specified in the filter, the following information is returned:
- Return value -1
- Return code EINVAL
- Reason code JRInvalidFilter
To obtain the ASID for the FTP daemon, take the following steps:
- Invoke EZBNMIFR for the GetTCPListener request to each TCP/IP stack to obtain the active FTP daemons.
- Specify a filter with the application data (NWMFilterApplData) value of EZAFTP0D in the first 8 bytes to filter the active FTP daemons from other listeners. A daemon might be listening on multiple stacks.
- Extract the ASID (NWMTCPLAsid) of each FTP daemon returned by the GetTCPListener request for which the GetFTPDaemonConfig request is issued.
- Invoke EZBNMIFR for the GetFTPDaemonConfig request.
- Specify a filter that contains the ASID of the FTP daemon to obtain the configuration data of the FTP daemon.
GetGlobalStats (NWMGlobalStatsType)
Use this request to obtain TCP/IP stack global statistics for IP, ICMP, TCP, SMC-R, and UDP processing. The statistics that are returned by the request are similar to those in the output of the Netstat STATS/-S report. This request does not support filtering.
GetIfs (NWMIfsType)
Use this request to obtain TCP/IP stack interface attributes and IP addresses. The attributes and IP address information that are returned by the request are similar to those in the output of the Netstat DEVLINKS/-d and HOME/-h reports. Detailed attribute information is supported only for strategic interface types. The strategic interface types are:
- Loopback
- OSA-Express QDIO Ethernet
- HiperSockets™
- Multipath Channel Point-to-Point
- Static VIPA
IBM® 10GbE RoCE Express® interfaces are also strategic interfaces. Some information about 10GbE RoCE Express interfaces is reported on this request, but the majority of the 10GbE RoCE Express attributes can be obtained from the GetRnics (NWMRnicType) NMI request.
Dynamic VIPA interfaces are also strategic interfaces but their attributes can be obtained from the dynamic VIPA (DVIPA) NMI requests that are previously described in this topic. For non-strategic interface types, only the following information is provided:
- Interface name from the LINK profile statement
- Interface index
- Associated device name from the DEVICE profile statement
- Interface type
- Interface status at the DEVICE and LINK level
- Time stamp of last interface status change at the LINK level
This request does not support filtering.
GetIfStats (NWMIfsStatsType)
Use this request to obtain TCP/IP stack interface statistics for all interface types except for 10GbE RoCE Express interfaces. See GetRnics (NWMRnicType) NMI request for information about 10GbE RoCE Express interfaces. The statistics that are returned by the request are similar to those in the output of the Netstat DEVLINKS/-d report with the addition of SNMP counters that are defined in the IF-MIB. For information about the IF-MIB, see RFC 2233. For information about how to access RFCs, see Related protocol specifications. Statistics are provided for all strategic interface types except for VIPA interfaces; the stack does not maintain counters for VIPA interfaces. This request also provides a time stamp of when the counters were last reset. This request does not support filtering.
GetIfStatsExtended (NWMIfsStatsExtType)
Use this request to obtain data link control (DLC) tuning statistics for datapath devices that are used by active OSA-Express QDIO Ethernet and HiperSockets interfaces. The statistics that are returned by the request are similar to those in the output of the VTAM® TNSTATS function and the SMF type 50 record. Counters are provided for each read and write queue for each datapath device. Because of performance considerations, the counters are not maintained by default as part of TCP/IP stack initialization. The first GetIfStatsExtended request causes the counters to be maintained for all active interfaces. Therefore, the read and write queue counters can be 0 in the response for the first request.

This request also provides a time stamp of when the counters were last reset. The counters are reset if all the interfaces that are using a datapath device are deactivated. This request does not support filtering.
GetProfile (NWMProfileType)
Use this request to obtain information about the current TCP/IP profile statement settings. This request does not support filtering. To detect changes to the profile statement settings, callers can use this callable request to obtain an initial set of current profile settings, and then do one of the following actions:
- Repeat the request, over a time interval, comparing returned data from a previous response to the returned data from the last response.
- Obtain the SMF Type 119 subtype 4 TCP/IP profile event records. These records provide information about changes to the profile settings that are made by using the VARY TCPIP,,OBEYFILE command processing.
  - If the records are requested on the SMFCONFIG or NETMONITOR profile statements, they are created.
  - If the records are requested on the SMFCONFIG profile statement, they are written to the MVS SMF data sets.
  - If the records are requested on the NETMONITOR profile statement, they can be obtained from the real-time SMF data network management interface (NMI).
  For more information about the real-time SMF NMI, see Real-time TCP/IP network monitoring NMI. For more information about the TCP/IP profile SMF record, see TCP/IP profile event record (subtype 4). The SMF record might be created even if some errors occurred during the VARY TCPIP,,OBEYFILE command processing. To determine whether profile changes actually occurred, application programs that process these records must compare the sections of changed information to the previous profile settings.
GetRnics (NWMRnicType)
Use this request to obtain information about 10GbE RoCE Express interfaces.
- The 10GbE RoCE Express interface information that the request returns is similar to the information that is provided in the Netstat DEvlinks/-d report.
- The VTAM tuning statistics that the request returns are for active 10GbE RoCE Express interfaces only. These statistics are similar to those in the output of the VTAM TNSTAT function and the SMF type 50 record. Considering the performance, the counters are not maintained by default as part of VTAM or TCP/IP stack initialization. The first GetRnics request causes the counters to be maintained for all active 10GbE RoCE Express interfaces. Therefore, the counters can be 0 in the response for the first request.
This request also provides a time stamp of the last time when the 10GbE RoCE Express interface counters and the VTAM tuning statistics were reset. The values are reset if the 10GbE RoCE Express interface is deactivated.
This request does not support filtering.
GetSmcLinks (NWMSmcLinkType)
Use this request to obtain information about SMC-R link groups and the SMC-R links in each group. The SMC-R link group and SMC-R link information that is returned by the request is similar to the information provided in the Netstat DEvlinks/-d report. This request does not support filtering.
GetStorageStatistics (NWMStgStatsType)
Use this request to obtain information about TCP⁄IP storage utilization and SMC-R send and receive buffer utilization. This request does not support filtering.
GetSysplexXCF (NWMSyXcfType)
Use this request to obtain information about all TCP/IP stacks in the subplex. This request returns a list of all TCP/IP stacks in the same subplex as the invoked TCP/IP stack. For each TCP/IP stack, the MVS system name and one or more dynamic XCF IP addresses are returned. There are no filters defined for this request. If the invoked TCP/IP stack has not joined a sysplex, then return value -1, return code EAGAIN, and reason code JRMustBeSysplex are returned without any other data.
GetTCPListeners (NWMTcpListenType)
Use this request to obtain information about active TCP listeners.
GetTnConnectionData (NWMTnConnType)
Use this request to obtain information about TN3270E Telnet server connection performance data.
GetTnMonitorGroups (NWMTnMonGrpType)
Use this request to obtain information about TN3270E Telnet server monitor groups.
GetTnProfile (NWMTnProfileType)
Use this request to obtain information about the current TN3270E Telnet server profile statement settings.
This request does not support filtering. To detect changes to the profile statement settings, callers can use this request to obtain an initial set of the current profile settings, and then do one of the following actions:
- Repeat the request, over a time interval, comparing returned data from a previous response to the returned data from the last response.
- Obtain the SMF Type 119 subtype 24 TN3270E Telnet server profile event records. These records provide information about changes to the profile settings that are made by using the VARY TCPIP,tnproc,OBEYFILE command processing.
  - If the records are requested by the TELNETGLOBALS SMFPROFILE profile statement or the TCP/IP stack NETMONITOR profile statement, they are created.
  - If the records are requested by the TELNETGLOBALS SMFCONFIG profile statement, they are written to the MVS SMF data sets.
  - If the records are requested by the NETMONITOR profile statement, they can be obtained from the real-time SMF data network management interface (NMI).
  For more information about the real-time SMF NMI, see Real-time TCP/IP network monitoring NMI. For more information about the TCP/IP profile SMF record, see TN3270E Telnet server profile event record (subtype 24). The SMF record might be created even if some errors occurred during the VARY TCPIP,tnproc,OBEYFILE command processing. To determine whether profile changes occurred, application programs that process these records must compare the sections of information in the new record with the previous profile settings.
- The NWMTnGrpDtl option flag allows the caller to obtain all the range data in the various groups that a Telnet profile defines. The call can return multiple entries and can use SMF119TN_xxRngNum to determine the number of ranges that are returned in each entry. If the flag is not set, the call returns one entry that contains only the first SMF119TN_xxRngMax ranges for a group. Based on the profile, specifying NWMTnGrpDtl can require a large amount of memory to hold the entire profile.
  Tip: Regardless of the number of entries that are returned for a group, the SMF119TN_xxRngCnt field indicates the total number of ranges that the group defines, and the SMF119TN_xxCount field indicates the total number of LUs or elements in the group.
GetUDPTable (NWMUdpConnType)
Use this request to obtain information about active UDP sockets.

The general format of the request consists of the request header and the request section descriptors (triplets), which define the input data. A triplet describes the input filters and contains the offset, in bytes, of the request section relative to the beginning of the request buffer, the number of elements in the request section, and the length of an element in the request section.