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


GetResolverConfig response contents

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

The GetResolverConfig response consists of two records:
  • A setup record
  • Optionally, a global TCPIP.DATA record

A global TCPIP.DATA record is provided whenever the GLOBALTCPIPDATA resolver setup statement is specified in the resolver setup file, unless the resolver is unable to access the file. For example, the global TCPIP.DATA record might be provided if the MVS™ sequential file specified on the GLOBALTCPIPDATA statement is being edited when the resolver attempts to read the file contents. The resolver notifies you of the failure to read the global TCPIP.DATA file contents by issuing message EZZ9297E UNABLE TO ACCESS FILE filename - RC returncode. See z/OS Communications Server: IP Messages Volume 4 (EZZ, SNM) for information about this message and for suggestions about how to correct the file access problems.

A setup record consists of a record header that contains six section descriptors (see Table 1 for details) and one section of resolver configuration data.

Table 1. Setup record (NMSSetupRecord) structure
Field Offset decimal Length in bytes Format Description
NMSSetupHeader 0 16 Binary Setup record heading mapping for setup record. See Table 4 for details.
NMSSetupDataSection 16 12 Binary Setup data record section descriptor. The server completes this field with information describing the setup record data section. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSSetupGlobalTcpipData 28 12 Binary Setup global TCPIP.DATA data record section descriptor. The server completes this field with information describing the setup file name section that maps the GLOBALTCPIPDATA statement. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSSetupDefaultTcpipData 40 12 Binary Setup default TCPIP.DATA data record section descriptor. The server completes this field with information describing the setup file name section that maps the DEFAULTTCPIPDATA statement. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSSetupGlobalIpnodes 52 12 Binary Setup global IPNODES record section descriptor. The server completes this field with information describing the setup file name section that maps the GLOBALIPNODES statement. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSSetupDefaultIpnodes 64 12 Binary Setup default IPNODES record section descriptor. The server completes this field with information describing the setup file name section that maps the DEFAULTIPNODES statement. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSSetupFile 76 12 Binary Resolver setup file name. The server completes this field with the name of the optional resolver setup file name (either an MVS data set or a z/OS® UNIX file) that contains resolver configuration statements. This descriptor is described by the NMSTriplet structure; see Table 2 for details.

Table 2 describes the fields in the setup record data section (NMSSetupData) structure.

Table 2. Setup record data section (NMSSetupData) structure
Field Offset decimal Length in bytes Format Description
NMSSOptions 0 4 Binary Options that were specified in the resolver setup file, if one is in use.
  • bit 0 = CACHE
  • bit 1 = NOCACHE
  • bit 2 = CACHESIZE
  • bit 3 = COMMONSEARCH
  • bit 4 = NOCOMMONSEARCH
  • bit 5 = DEFAULTIPNODES
  • bit 6 = DEFAULTTCPIPDATA
  • bit 7 = GLOBALIPNODES
  • bit 8 = GLOBALTCPIPDATA
  • bit 9 = MAXTTL
  • bit 10 = UNRESPONSIVETHRESHOLD
  • bit 11= AUTOQUIESCE (see Note)
NMSSDefaults 4 4 Binary Options that were not specified in the resolver setup file but that have default settings that were used.
  • bit 0 = CACHE
  • bit 2 = CACHESIZE
  • bit 4 = NOCOMMONSEARCH
  • bit 9 = MAXTTL
  • bit 10 = UNRESPONSIVETHRESHOLD
NMSSFlags 8 4 Binary Flag options that indicate which resolver functions are active, based on the contents of the resolver setup file.
  • bit 0 = CACHE
  • bit 1 = NOCACHE
  • bit 3 = COMMONSEARCH
  • bit 4 = NOCOMMONSEARCH
  • bit 11= AUTOQUIESCE (see Note)
Reserved 12 4 N/A N/A
NMSSetupCacheSize 16 8 Binary CACHESIZE value, in numbers of bytes
NMSSetupMaxTTL 24 4 Binary MAXTTL value, in seconds
NMSSetupUnresponsiveThreshold 28 4 Binary UNRESPONSIVETHRESHOLD value
Note: If the GLOBALTCPIPDATA statement is not coded, although the NMSSOptions field indicates that the AUTOQUIESCE operand is set in the resolver setup file, the NMSSFlags field will indicate that the AUTOQUIESCE function is not active.
There are zero to five instances of setup record file name section (NMSSetupFileNames) structure; see Table 3 for details about the fields. Each of the instances either maps the resolver setup file name or one of the following four resolver setup statements that specify a file name:
  • GLOBALTCPIPDATA
  • DEFAULTTCPIPDATA
  • GLOBALIPNODES
  • DEFAULTIPNODES

You must use the section descriptors that are described in Table 1 to identify the use of a given instance of the record file name section structure.

Table 3. Setup record file name section (NMSSetupFileNames) structure
Field Offset decimal Length in bytes Format Description
NMSSetupFileName 0 Variable EBCDIC Setup record file name
A global TCPIP.DATA record consists of the following sections:
  • A record header that contains four section descriptors; see Table 4 for details.
  • One section of TCPIP.DATA configuration information from the GLOBALTCPIPDATA file; see Table 5 for details.
  • Zero or more Domain Name System (DNS) name server IP addresses; see Table 6 for details.

    Each DNS address represents a value that is coded on either a NSINTERADDR or a NAMESERVER TCPIP.DATA statement. Use the settings in the NMSGOptions field to identify which TCPIP.DATA statement was used to code the addresses returned in the resolver NMI response. The resolver can return up to sixteen DNS address sections.

  • Zero or more domain search names; see Table 7 for details.

    Each domain search name represents a value coded on a DOMAIN, DOMAINORIGIN, or SEARCH TCPIP.DATA statement. Use the settings in the NMSGOptions field to identify which TCPIP.DATA statement was used to set the values mapped in the resolver NMI response. There can be up to six domain search name sections. Names shorter than the value specified for the NMSTLength in the NMSGtdNameSection field are padded with null characters.

  • Zero or more DCBS table names; see Table 8 for details.

    Each table name represents a value coded on the LOADDBCSTABLES TCPIP.DATA statement. The resolver can return up to nine table name sections. Table names shorter than 8 characters are padded with null characters.

Table 4. Global TCPIP.DATA record (NMSGtdRecord) structure
Field Offset decimal Length in bytes Format Description
NMSGtdHeader 0 16 Binary Record heading mapping for global TCPIP.DATA record. See Table 4 for details.
NMSGtdDataSection 16 12 Binary Resolver global TCPIP.DATA data section. The server completes the field with information describing the Network Management global TCPIP.DATA record data section. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSGtdNsadSection 28 12 Binary Resolver global TCPIP.DATA record NAMESERVER values section. The server completes the field with information describing the global TCPIP.DATA record DNS addresses section. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSGtdNameSection 40 12 Binary Resolver global TCPIP.DATA record SEARCH values section. The server completes the field with information describing the global TCPIP.DATA record domain search names section. This descriptor is described by the NMSTriplet structure; see Table 2 for details.
NMSGtdLoadDbcsTables 52 12 Binary Resolver global TCPIP.DATA record LOADDBCSTABLES values. The server completes the field with information describing global TCPIP.DATA record DCBS table names section. This descriptor is described by the NMSTriplet structure; see Table 2 for details.

Table 5 describes the fields in the global TCPIP.DATA record data section (NMSGtdData) structure.

Table 5. Global TCPIP.DATA record data section (NMSGtdData) structure
Field Offset decimal Length in bytes Format Description
NMSGOptions 0 8 Binary Options specified in the global TCPIP.DATA file.
  • Bit 0 = ALWAYSWTO NO
  • Bit 1 = ALWAYSWTO YES
  • Bit 2 = DATASETPREFIX
  • Bit 3 = DOMAIN
  • Bit 4 = DOMAINORIGIN
  • Bit 5 = HOSTNAME
  • Bit 6 = LOADDBCSTABLES
  • Bit 7 = LOOKUP DNS
  • Bit 8 = LOOKUP DNS LOCAL
  • Bit 9 = LOOKUP LOCAL
  • Bit 10 = LOOKUP LOCAL DNS
  • Bit 11 = MESSAGECASE MIXED
  • Bit 12 = MESSAGECASE UPPER
  • Bit 13 = NOCACHE
  • Bit 14 = NAMESERVER
  • Bit 15 = NSINTERADDR
  • Bit 16 = NSPORTADDR
  • Bit 17 = OPTIONS DEBUG
  • Bit 18 = OPTIONS NDOTS
  • Bit 19 = RESOLVERTIMEOUT
  • Bit 20 = RESOLVERUDPRETRIES
  • Bit 21 = RESOLVEVIA TCP
  • Bit 22 = RESOLVEVIA UDP
  • Bit 23 = SEARCH
  • Bit 24 = SOCKDEBUG
  • Bit 25 = SOCKNOTESTSTOR
  • Bit 26 = SOCKTESTSTOR
  • Bit 27 = SORTLIST
  • Bit 28 = TCPIPJOBNAME
  • Bit 29 = TCPIPUSERID
  • Bit 30 = TRACE RESOLVER
  • Bit 31 = TRACE SOCKET
NMSGDefaults 8 8 Binary The default values of the options specified in the global TCPIP.DATA file.
  • Bit 0 = ALWAYSWTO NO
  • Bit 2 = DATASETPREFIX
  • Bit 5 = HOSTNAME
  • Bit 8 = LOOKUP DNS LOCAL
  • Bit 11 = MESSAGECASE MIXED
  • Bit 13 = NOCACHE
  • Bit 16 = NSPORTADDR
  • Bit 18 = OPTIONS NDOTS
  • Bit 19 = RESOLVERTIMEOUT
  • Bit 20 = RESOLVERUDPRETRIES
  • Bit 22 = RESOLVEVIA UDP
  • Bit 25 = SOCKNOTESTSTOR
  • Bit 28 = TCPIPJOBNAME
NMSGFlags 16 8 Binary Flag options that indicate which capabilities are in effect, based on the contents of the global TCPIP.DATA file.
  • Bit 0 = ALWAYSWTO NO
  • Bit 1 = ALWAYSWTO YES
  • Bit 7 = LOOKUP DNS
  • Bit 8 = LOOKUP DNS LOCAL
  • Bit 9 = LOOKUP LOCAL
  • Bit 10 = LOOKUP LOCAL DNS
  • Bit 11 = MESSAGECASE MIXED
  • Bit 12 = MESSAGECASE UPPER
  • Bit 13 = NOCACHE
  • Bit 17 = OPTIONS DEBUG
  • Bit 21 = RESOLVEVIA TCP
  • Bit 22 = RESOLVEVIA UDP
  • Bit 24 = SOCKDEBUG
  • Bit 25 = SOCKNOTESTSTOR
  • Bit 26 = SOCKTESTSTOR
  • Bit 30 = TRACE RESOLVER
  • Bit 31 = TRACE SOCKET
NMSGtdHostName 24 64 EBCDIC HOSTNAME value. The name is padded with null characters.
NMSGtdOptionsNdots 88 2 Binary OPTIONS NDOTS value.
NMSGtdNsPortAddr 90 2 Binary NSPORTADDR value.
NMSGtdResolverTimeout 92 4 Binary RESOLVERTIMEOUT value, in seconds.
NMSGtdResolverTimeoutMsecs 96 4 Binary RESOLVERTIMEOUT value, in milliseconds.
NMSGtdResolverUdpRetries 100 4 Binary RESOLVERUDPRETRIES value
NMSGtdSortList (4) 104 32 Binary Up to four SORTLIST values.
Each individual SORTLIST entry contains the following two values:
  • Bits 0 - 31 = SORTLIST IPv4 address
  • Bits 32 - 63 = SORTLIST network mask
NMSGtdTcpipNames 136 9 EBCDIC TCPIPJOBNAME or TCPIPUSERID value. Use the settings in the NMSGOptions field or the NMSGDefaults field to identify which statement was used. The name is padded with null characters.
NMSGtdDatasetPrefix 145 27 EBCDIC DATASETPREFIX value. The name is padded with null characters.
Reserved 172 20 N/A N/A
Guideline: Do not specify OPTIONS DEBUG or TRACE RESOLVER in your global TCPIP.DATA file.

Table 6 describes the fields in the global TCPIP.DATA record DNS addresses (NMSGtdDnsAddresses) structure.

Table 6. Global TCPIP.DATA record DNS addresses (NMSGtdDnsAddresses) structure
Field Offset decimal Length in bytes Format Description
NMSGtdSockAddrs 0 28 Socket address DNS names server IP addresses.

Table 7 describes the fields in the global TCPIP.DATA record structure.

Table 7. Global TCPIP.DATA record structure
Field Offset decimal Length in bytes Format Description
NMSGtdSearchNameSize 0 2 Binary Length of domain search name.
NMSGtdSearchName 2 Variable EBCDIC Domain search name.

Table 8 describes the fields in the global TCPIP.DATA record DCBS table names section (NMSGtdDbcsNames).

Table 8. Global TCPIP.DATA record DCBS table names section (NMSGtdDbcsNames)
Field Offset decimal Length in bytes Format Description
NMSGtdDbcsName 0 8 EBCDIC DBCS table name.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014