TCP/IP services - TCPIPS

The TCP/IP service name (TCPIPS) views display information about CICS internal sockets support.

Supplied views

To access from the main menu, click:

CICS operations views > TCP/IP service operations views > TCP/IP services

Table 1. Views in the supplied TCP/IP service (TCPIPS) view set
View Notes
TCP/IP service

EYUSTARTTCPIPS.CLOSE

Close a TCP/IP service. When this action command is used, a managed CICS system no longer accepts input from this TCP/IP service definition. Output operations from transactions in a managed CICS system that use this TCP/IP service definition are allowed to complete.
TCP/IP service

EYUSTARTTCPIPS.DETAIL1

Detailed SSL cipher suite code information for a selected TCP/IP service definition.
TCP/IP service

EYUSTARTTCPIPS.DETAIL2

Detailed information about the resource signature.
TCP/IP service

EYUSTARTTCPIPS.DETAILED

Detailed information about a selected TCP/IP service definition.
TCP/IP service

EYUSTARTTCPIPS.DISCARD

Discard a TCP/IP service definition from the CICS system where it is installed.
TCP/IP service

EYUSTARTTCPIPS.IMMCLOSE

Requests a TCP/IP service definition to be closed immediately. When this action command is used, a managed CICS system no longer accepts input from this TCP/IP service definition. If a managed CICS system has transactions that are using the TCP/IP service definition, when this action command is used these transactions may be abnormally terminated.
TCP/IP service

EYUSTARTTCPIPS.OPEN

Open a TCP/IP service. When this action command is used, a managed CICS system will accept input from this TCP/IP service definition.
TCP/IP service

EYUSTARTTCPIPS.SET

Set attributes according new values specified in input fields.
TCP/IP service

EYUSTARTTCPIPS.TABULAR

Tabular information about currently installed TCP/IP service definitions.

Actions

Table 2. Actions available for TCPIPS views
Action Description
CLOSE Close a TCP/IP service. When this action command is used, a managed CICS system no longer accepts input from this TCP/IP service definition. Output operations from transactions in a managed CICS system that use this TCP/IP service definition are allowed to complete.
DEREGISTER This is obsolete from CICS TS Version 5 Release 2. Deregister a TCP/IP service definition.
DISCARD Discard a TCP/IP service definition from the CICS system where it is installed.
IMMCLOSE Requests a TCP/IP service definition to be closed immediately. When this action command is used, a managed CICS system no longer accepts input from this TCP/IP service definition. If a managed CICS system has transactions that are using the TCP/IP service definition, when this action command is used these transactions may be abnormally terminated.
OPEN Open a TCP/IP service. When this action command is used, a managed CICS system will accept input from this TCP/IP service definition.
SET Set attributes according new values specified in input fields.

Fields

Table 3. Fields in TCPIPS views
Field Attribute name Description
Attach-time security ATTACHSEC Indicates, for ECI over TCP/IP services, the level of attach-time security used by connections to CICS Clients:
  • LOCAL - CICS does not require a user ID or password from clients.
  • VERIFY - Incoming attach requests must specify a user identifier and a user password.
Authentication level AUTHENTICATE The level of authentication used by this TCP/IP resource.
Queue backlog setting BACKLOG The setting for the maximum number of requests which can be queued in TCP/IP waiting to be processed.

Input Values: 0 - 32767.

If the value of BACKLOG is greater than the TCP/IP configuration value for SOMAXCONN, TCP/IP uses the value specified by the SOMAXCONN attribute.
BAS resource definition version BASDEFINEVER The BAS version number of this definition.
Number of bytes received across all sockets BYTERCVD The total number of bytes received across all sockets in this TCP/IP Service.
Number of bytes sent across all sockets BYTESENT The total number of bytes sent across all sockets in this TCP/IP Service.
Certificate CERTIFICATE The name of a certificate within the key ring file that is to be used in the SSL handshake for this TCP/IP service.
Last modification agent CHANGEAGENT The change agent identifier that made the last modification.
  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
  • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
  • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
  • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
  • NOTAPPLIC - This is not applicable for this resource.
Last modification agent release CHANGEAGREL The CICS release level of the agent that made the last modification to the resource definition.
Last modification time CHANGETIME The local date and time when the definition was last changed.
Last modification user ID CHANGEUSRID The user ID that made the last modification to the resource definition.
SSL cipher suite codes CIPHERS A value specifying up to 28 cipher suites, in the form of hexadecimal pairs. From CICS Transaction Server 5.1 this field can alternatively specify the name of an XML file residing on zFS which contains a list of ciphers. An XML file can be up to 28 characters.
Timeout for socket close (seconds) CLOSETIMEOUT The period in seconds after which the managed CICS system will close the socket if no data is received. This value applies when the socket close parameter is TIMEOUT.
Current maximum backlog CMAXBACKLOG The maximum value currently being used as the backlog for the TCP/IP service over all stacks. This may be greater than the value specified using the TCP/IP service's BACKLOG attribute as TCP/IP may increase this if e.g. it thinks there is a SYN flood.
Number of connections CONNECTIONS The current number of socket connections associated with this service.
Time connection last dropped CONNLASTDROP The time that a connection was last rejected due to the TCP/IP service's backlog queue being full.
Connections dropped CONNSDROPPED The total number of connections dropped due to the TCP/IP service's backlog queue being full, summed over all appropriate stacks if the TCP/IP service is listening on multiple stacks.
Current backlog CURRBACKLOG The current number of connection requests in the backlog, summed over all appropriate stacks if the TCP/IP service is listening on multiple stacks.
Source of the resource definition DEFINESOURCE The source of the definition, depending on which agent made the last change.
Creation time DEFINETIME The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
Times disconnected a persistent connection at task limit DISCATTLIM The number of times an existing persistent HTTP connection was closed because the number of tasks in the region has exceeded the limit.
Times disconnected an connection at max uses DISCATUSELIM The number of times a persistent HTTP connection was disconnected because its number of uses had exceeded the limit.
Domain name service (DNS) group DNSGROUP This is obsolete from CICS TS Version 5 Release 2. The DNS Group Name.
Domain name service (DNS) status DNSSTATUS This is obsolete from CICS TS Version 5 Release 2. The current state of WLM/DNS registration for this TCP/IP service:
  • NOTAPPLIC - This service is not using DNS connection optimization. No DNSGROUP attribute was specified when the resource was installed.
  • UNAVAILABLE - Registration is not supported by OS/390
  • UNREGISTERED - Registration has not yet occurred (this is the initial state of any service).
  • REGISTERED - Registration has completed successfully.
  • REGERROR - Registration has failed with an error.
  • DEREGISTERED - Deregistration has completed successfully.
  • DEREGERROR - Deregistration has failed with an error.
Generic TCPIPService GENERICTCPS The name of the generic TCP/IP Service that this TCP/IP Service uses. When named, this TCPIPSERVICE is a specific TCP/IP Service.
GMT service open time GMTSERVOPN The Greenwich mean time at which this TCP/IP service was opened.
Critical domain name service (DNS) group member GRPCRITICAL This is obsolete from CICS TS Version 5 Release 2. Whether or not this TCP/IP service is a critical member of the DNS group:
  • CRITICAL - If this TCPIPSERVICE is closed, or abnormally stops listening for any reason, the group name specified in the DNSGROUP attribute is deregistered from WLM.
  • NONCRITICAL - If this TCPIPSERVICE is closed, or abnormally stops listening for any reason, the group name specified in the DNSGROUP attribute is not deregistered from WLM, unless this is the last service in a set with the same group name.
Server address to listen on HOST The host name or IP address of the server this TCPIPSERVICE should listen on for incoming requests, ANY or DEFAULT. The HOSTTYPE option gives the format of this value, as either a host name, an IPv4 address, an IPv6 address, ANY, DEFAULT or NOTAPPLIC.

IPRESOLVED has the numerical IP address actually used.

The listening server's address format HOSTTYPE The format of the address in the HOST field that this service should listen on.
  • ANY - The ANY option has been specified for the server's address
  • DEFAULT - The DEFAULT option has been specified for the server's address
  • HOSTNAME - The server's address is a character host name. The IP address that corresponds to the host name is looked up in a domain name server
  • IPV4 - The server's address is an IPv4 address specified in dotted decimal address format
  • IPV6 - The server's address is an IPv6 address specified in colon hexadecimal address format
  • NOTAPPLIC - The server's host name or address is incorrect
Installation agent INSTALLAGENT The install agent identifier that made the installation.
  • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
  • GRPLIST - The resource was installed by GRPLIST INSTALL.
  • BUNDLE - The resource was installed by a bundle deployment.
Installation time INSTALLTIME The local date and time when the definition was installed.
Installation user ID INSTALLUSRID The user ID that installed the resource definition.
IPv4 address of the service IPADDRESS The IPv4 dotted-decimal address of the server this TCPIPSERVICE is listening on, ANY, INADDR_ANY or DEFAULT.
Resolved IP address format IPFAMILY The format of this service's resolved IP address shown in IPRESOLVED.
  • IPV4 - IPRESOLVED contains an IPv4 address specified in dotted decimal address format.
  • IPV6 - IPRESOLVED contains an IPv6 address specified in colon hexadecimal address format.
  • UNKNOWN - IPRESOLVED is not yet in use, or the address cannot be resolved. This is the default when IPRESOLVED is 0.0.0.0
Resolved IP address IPRESOLVED The resolved IPv4 or IPv6 address this TCPIPSERVICE is listening on, or 0.0.0.0 if it is unavailable or unknown.

If the address given in HOST is ANY or DEFAULT the resolved IP address is dynamically selected from the list of IP addresses associated with the IP stack that is in use by the application. This IP address changes depending on which socket is used and what server or current IP address is used for the listener.

IPFAMILY gives the format of this IP address.

Maximum length of data that may be received MAXDATALEN The maximum length of data that may be received on this TCP/IP service.
Maximum persistent connections MAXPERSIST The maximum number of persistent connections the CICS will accept. The value is in the range 0-65535, or will have the standard null value of -1 if MAXPERSIST(NO) is specified on the MAXPERSIST definition.
TCP/IP service name NAME TCP/IP service name
Number of non-persisted connections NONPERSIST The number of non-persisted connections that have been made above the maxpersist limit.
Times a connection was made non-persistent because MAXPERSIST was reached NPERSATMAXP The number of times a new persistent connection was made non-persistent because MAXPERSIST was reached.
Times a connection made non-persistent at task limit NPERSATTLIM The number of times a new persistent HTTP connection was made non-persistent because the number of tasks in the region has exceeded the limit.
Number of SSL cipher suite codes NUMCIPHERS The count of cipher suite codes, which are specified as hexadecimal pairs. A value of 0 could indicate the use of an XML cipher file.
TCP/IP service status OPENSTATUS The state of the TCP/IP service definition as follows:
  • OPEN - Input is accepted from this TCP/IP service definition.
  • OPENING - Input is not accepted from this TCP/IP service definition. The service is in the process of OPENING.
  • CLOSED - Input is not accepted from this TCP/IP service definition.
  • CLOSING - Input is not accepted from this TCP/IP service definition. The service is in the process of CLOSING.
  • IMMCLOSE - Input is not accepted from this TCP/IP service definition. If a managed CICS system has transactions that are using the TCP/IP service definition, these transactions may be abnormally terminated.
  • IMMCLOSING - Input is not accepted from this TCP/IP service definition. CICS internal sockets support is in the process of immediate termination.
Peak number of connections PEAKCONNS The peak number of socket connections in use across this TCP/IP Service.
Port number PORT The port number on which the managed CICS system is listening for incoming client requests.
Privacy for clients using this service PRIVACY This is obsolete from CICS TS Version 3 Release 1. Indicates the level of SSL encryption required for inbound connections to this service.
  • REQUIRED - Encryption must be used.
  • SUPPORTED - Encryption is used if both client and server support it.
  • NOTSUPPORTED - Encryption must not be used.
Protocol PROTOCOL The name of the protocol being used by this TCP/IP resource:
  • ECI - ECI over TCP/IP protocol.
  • HTTP - Hypertext Transfer protocol.
  • IIOP - This is obsolete from CICS TS Version 5 Release 1. Internet Inter-orb protocol.
  • IPIC - IP Interconnectivity protocol.
  • USER - User-defined protocol.
Basic authentication realm name REALM The realm that is provided when CICS requests basic authentication.
Number of receives across all sockets RECEIVES The total number of receives made across all sockets in this TCP/IP Service.
Requests REQUESTS The number of requests processed by the TCP/IP service.
Number of sends across all sockets SENDS The total number of sends made across all sockets in this TCP/IP Service.
Socket close action SOCKETCLOSE The action taken by the managed CICS system if no data is received from the socket.
  • WAIT - The managed CICS system waits and does not close the socket if no data is received.
  • TIMEOUT - The managed CICS system will close the socket if no data has been received after the period specified in the close timeout parameter.
Specific TCPIPService SPECIFTCPS The name of the specific TCP/IP Service that this TCP/IP Service uses. When named, this TCP/IP Service is a generic TCP/IP Service.
Secure sockets layer (SSL) type SSLTYPE Whether the service uses secure sockets layer.
  • NOSSL - The service does not use secure sockets layer.
  • SSL - Secure sockets layer is used by this service except for client authentication.
  • CLIENTAUTH - Secure sockets layer is used by this service including client authentication.
  • ATTLSAWARE - CICS expects AT-TLS to secure the client connections for this service. This may support client authentication.
Local service open time TIMEOPEN The local time at which this TCP/IP service was opened.
Total connections TOTALCONNS The total number of connections made for the TCP/IP service.
Number of transactions attached TRANATTACH The total number of transactions attached via this TCP/IP Service.
CICS transaction ID TRANSID The identifier of the transaction which is attached to process requests received for this service.
TS queue prefix TSQPREFIX This parameter is no longer required or used in CICS Transaction Server for z/OS, Version 3 Release 2 and later releases.
User-replaceable module name URM The name of the user-replaceable module to be invoked by this service.


eyua3v1.html | Timestamp icon Last updated: Sunday, 4 June 2017