SOTB gate, INQUIRE_TCPIPSERVICE function

The INQUIRE_TCPIPSERVICE function is called by CEMT and the SPI to inquire on a TCPIPSERVICE resource. It returns information about an installed TCPIPSERVICE resource.

Input Parameters

TCPIPSERVICE_NAME
The name of the TCP/IP service.

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • NOT_FOUND
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
ATTACHSEC
Optional Parameter
The level of attach-time user security specified in the TCPIPSERVICE definition.
AUTHENTICATION
Optional Parameter
The authentication and identification scheme to be used for inbound TCP/IP connections.
Values for the parameter are:
  • AUTOMATIC
  • AUTOREGISTER
  • BASIC
  • CERTIFICATE
  • KERBEROS
  • NONE
BACKLOG
Optional Parameter
The value of the backlog parameter passed to the TCP/IP listen function for this service. It specifies how many connection requests TCP/IP will queue for this service.
CERTIFICATE_LABEL
Optional Parameter
The certificate label associated with the service.
CIPHER_COUNT
Optional Parameter
The number of cipher suites encoded in the CIPHER_SUITES parameter.
CIPHER_SUITES
Optional Parameter
A binary representation of the cipher suites that are used to encrypt data.
CONNECTIONS
Optional Parameter
Either the number of connections for the service represented by the supplied TCPIPSERVICE name, or the total number of TCP/IP connections to all of the currently active services.
DNSGROUP
Optional Parameter
The group name with which CICS® registers to Workload Manager, for connection optimization.
DNSSTATUS
Optional Parameter
The Domain Name System (DNS) registration status of the service.
Values for the parameter are:
  • DEREGERROR
  • DEREGISTERED
  • NOTAPPLIC
  • REGERROR
  • REGISTERED
  • UNAVAILABLE
  • UNREGISTERED
GRPCRITICAL
Optional Parameter
A binary value indicating whether the TCPIPSERVICE resource is a critical member of the DNS group. When a critical TCPIPSERVICE resource closes or fails, CICS deregisters the group name from Workload Manager.
Values for the parameter are:
  • CRITICAL
  • NONCRITICAL
IPADDRESS
Optional Parameter
The IP address that the service is bound to.
MAXDATA_LENGTH
Optional Parameter
The maximum length of data that CICS will receive when operating as an HTTP server.
MAXPERSIST
Optional Parameter
The maximum number of persistent connections from web clients that the CICS region allows for this port at any one time.
PORT
Optional Parameter
The port number associated with the service.
PRIVACY
Optional Parameter
The level of SSL encryption required for inbound connections to this service.
Values for the parameter are:
  • NOTSUPPORTED
  • REQUIRED
  • SUPPORTED
PROTOCOL
Optional Parameter
The application level protocol used on the TCP/IP port.
Values for the parameter are:
  • ECI
  • HTTP
  • USER
SOCKETCLOSE
Optional Parameter
The interval from the time of the initial receive request for incoming data, after which CICS is to time out the socket.
SSL
Optional Parameter
The SSL setting for the service.
Values for the parameter are:
  • CLIAUTH
  • NO
  • YES
  • ATTLSAWARE
STATUS
Optional Parameter
The current status of the service.
Values for the parameter are:
  • CLOSED
  • CLOSING
  • IMMCLOSING
  • OPEN
  • OPENING
TRANSID
Optional Parameter
The transaction ID associated with the service.
URM
Optional Parameter
The name of the user-replaceable program associated with the service.
VALIDATION_HASH
Optional Parameter
A hash based on the contents of the listener table entry for the socket.


dfhs3_SOTBinquire_tcpipservice.html | Timestamp icon Last updated: Monday, 5 June 2017