z/OS Communications Server: IP Programmer's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


SNA network monitoring NMI request format

z/OS Communications Server: IP Programmer's Guide and Reference
SC27-3659-02

All SNA NMI requests flow on the socket from the client application to the VTAM® server. The general format of an SNA NMI request is:
  • The request header includes the request type and the request section descriptors (triplets). The following request types can be made:
    • EE Connection Request — obtain information about some or all Enterprise Extender connections.
    • EE Summary Request — obtain summary information about all Enterprise Extender connections.
    • HPR Connection Request — obtain information about one or more HPR connections.
    • CSM Statistics Request — obtain information about global CSM statistics and optionally, about CSM storage owner statistics.

    A triplet consists of the offset (in bytes) of the request section relative to the beginning of the request header, the number of elements in the request section, and the length of a request section element.

  • The request sections. The only type of request section that can be specified is a filter element.
    • In an EE Connection Request, either zero or one filter element can be included. The set of all EE connections can be selected either by not including a filter element in the request or by supplying a filter element with no filter parameters specified. A subset of EE connections can be selected by supplying a filter element that includes any combination of the filter parameters in Table 1. z/OS® Communications Server does not perform name resolution (to an IP address) on any supplied host name, but simply looks for connections that were established using the given host name.
      Table 1. EE connection request filter parameters
      Parameter Description
      Local Hostname An EBCDIC name, right-padded with nulls or blanks if less than 64 characters long (applicable to CS for z/OS version V1R5 and later releases only). The Local Hostname parameter is ignored if Local IP Address is specified.
      Local IP Address A 32-bit IPv4 address or a 128-bit IPv6 address. (IPv6 address is applicable to z/OS Communications Server V1R5 and later releases only.)
      Remote Hostname An EBCDIC name, right-padded with nulls or blanks if less than 64 characters long. The Remote Hostname parameter is ignored if a Remote IP Address value is specified.
      Remote IP Address A 32-bit IPv4 address or a 128-bit IPv6 address. (IPv6 address is applicable to z/OS Communications Server V1R5 and later releases only).
    • An EE Summary Request cannot contain any filter elements; no filters are applicable to an EE summary request.
    • In an HPR Connection Request, you select a subset of HPR connections based on any combination of the following items that includes, at a minimum, either the RTP PU Name or the Partner CP Name (1 - 4 filter elements can be specified per request):
    • A CSM Statistics Request can contain 1 – 4 filter elements to request CSM storage ownership statistics. To request statistics about all users that own CSM storage, include a filter element in the request that has an ASID set to the value 0. To request statistics about a subset of users that own CSM storage, supply filter elements that include a nonzero value filter parameter in Table 2.

      If no filter element is provided on the CSM Statistics Request, no CSM storage ownership statistics are included in the response. The CSM Global Pool Output Section record and the CSM Summary Output Section record are always returned as part of a CSM Statistics Response, regardless of whether filters are included on the request or not.

      Restriction: ASID filter parameters are applicable only to z/OS Communications Server V1R11 and later. If the initialization record that was received by the client when the connection was opened specifies that CSM Statistics Request filters are not supported by this VTAM level (any VTAM level prior to z/OS V1R11), then the server rejects any request that contains a filter on the CSM Statistics Request.
Table 2 shows which filter parameters are required, optional, or not applicable (N/A) for each request type. If you specify inapplicable filters for a particular request type, an EE Connection Request, HPR Connection Request, or CSM Statistics Request, they are ignored. EE Summary Requests that contain filter elements are rejected by VTAM.
Table 2. Required filter parameters
Request Type Local IP Address or Hostname Remote IP Address or Hostname RTP PU name or Partner CP name COS name ASID
EE Connection Request Optional; Local Hostname ignored if local IP address is specified Optional; Remote Hostname is ignored if remote IP address is specified N/A N/A N/A
EE Summary Request N/A N/A N/A N/A N/A
HPR Connection Request N/A N/A One is required; Partner CP name ignored if RTP PU name is specified Optional; ignored if RTP PU name is specified N/A
CSM Statistics Request N/A N/A N/A N/A Optional; if a filter is provided, an ASID value is required
Every valid request record that is sent to VTAM by the client has the following general request format structure:

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014