CEMT INQUIRE TCPIPSERVICE

Retrieve information about TCP/IP ports on which CICS internal TCP/IP support is listening on behalf of other CICS services.

In the CICS Explorer, the TCP/IP operations view provides a functional equivalent to this command.

Description

The INQUIRE TCPIPSERVICE command returns information about the state of a service by using CICS internal TCP/IP support.

The resource signature

You can use this command to display the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Auditing resources. The resource signature fields are CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Input

Press the Clear key to clear the screen. You can start this transaction in two ways:
  • Type CEMT INQUIRE TCPIPSERVICE (or suitable abbreviations for the keywords). The resulting display lists the status.
  • Type CEMT INQUIRE TCPIPSERVICE (or suitable abbreviations for the keywords), followed by as many of the other attribute settings that you want to view.
You can change various attributes in the following ways:
  • Move to the appropriate field on the INQUIRE screen and Type your changes.
  • Use the CEMT SET TCPIPSERVICE command.

CEMT INQUIRE TCPIPSERVICE

Read syntax diagramSkip visual syntax diagramINQUIRE TCPIPSERVICE ALL( value)BACKLOG( value)SPECIFTCPS( value)GENERICTCPS( value)CONNECTIONS( value)PORT( value)MAXDATALEN( value)ECIHTTPIPICUSERSSLNOSSLCLIENTAUTHNOAUTHENTICBASICCERTIFICATEREGISTERAUTOMATICREQUIREDSUPPORTEDNOTSUPPORTEDCIPHERS( value)OPENOPENINGCLOSEDCLOSINGIMMCLOSEIMMCLOSINGTRANSID( value)URM( value)IPADDRESS( value)WAITTIMEOUTCLOSETIMEOUT( value)MAXPERSIST( value)REALM( value)UNAVAILABLEUNREGISTEREDREGISTEREDREGERRORDEREGISTEREDDEREGERRORCERTIFICATE( value)NOTAPPLICLOCALVERIFYHOST( value)IPRESOLVED( value)HOSTNAMEANYDEFAULTIPV4HOSTIPV6HOSTUNKNOWNIPV4FAMILYIPV6FAMILYINSTALLTIME( date time)INSTALLUSRID( value)CREATESPICSDAPIGRPLISTDEFINESOURCE( value)DEFINETIME( date time)CHANGETIME( date time)CHANGEUSRID( value)CREATESPICSDAPICSDBATCHDREPAPISYSTEMCHANGEAGREL( value)

Displayed fields

ATTACHSEC(value)
Indicates the level of attach-time security that is used by the connection.
LOCAL
CICS does not require a user ID or password from clients.
NOTAPPLIC
This option has no meaning for the web interface.
VERIFY
Incoming attach requests must specify a user ID and a user password.
AUTHENTICATE(value)
Indicates the scheme that is used to authenticate clients.
BASIC
HTTP basic authentication is used to obtain a user ID and password from the client. This value is returned only when PROTOCOL has a value of HTTP.
CERTIFICATE
SSL client certificate authentication is used to authenticate and identify the client. This value is returned only when PROTOCOL has a value of HTTP.
NOAUTHENTIC
The client is not required to send authentication or identification information. However, if the client sends a valid certificate that is already registered to the security manager, and associated with a user ID, that user ID identifies the client. This value is returned only when PROTOCOL has a value of HTTP.
REGISTER
SSL client certificate authentication is used to authenticate the client. If the client certificate is not associated with a user ID, HTTP basic authentication is used to obtain the client user ID, and associate it with the certificate. This value is returned only when PROTOCOL has a value of HTTP.
AUTOMATIC
If the client does not send a certificate, HTTP basic authentication is used to obtain a user ID and password from the client. Otherwise, SSL client certificate authentication is used to authenticate the client. If the client certificate is not associated with a user ID, HTTP basic authentication is used to obtain the client user ID, and associate it with the certificate. This value is returned only when PROTOCOL has a value of HTTP.
For more information about authentication and identification of HTTP clients, see Identification and authentication.
BACKLOG(value)
Change the maximum number of requests that can be queued in TCP/IP waiting to be processed by the service. If the value of BACKLOG is less than the value of the TCP/IP attribute SOMAXCONN, the TCPIPSERVICE is opened with the backlog value specified by the BACKLOG attribute. If the value of BACKLOG is greater than SOMAXCONN, the TCPIPSERVICE is opened with the backlog value specified by SOMAXCONN. A value of zero means that the TCPIPSERVICE is opened with the backlog value specified by SOMAXCONN.
CERTIFICATE(value)
Specifies the label of an X.509 certificate that is to be used in the SSL handshake for the TCP/IP service. Certificate labels can be up to 32 bytes, and are specified for the CICS region user ID in a key ring that is defined in the database of the external security manager; for example, as defined by the RACDCERT command. If this attribute is omitted, the default certificate that is defined in the key ring for the CICS region user ID is used.
CHANGEAGENT(value)
Displays a value that identifies the agent that made the last change to the resource definition. You cannot use CEMT to filter on some of these values because they are duplicated. The possible values are as follows:
CREATESPI
The resource definition was last changed by an EXEC CICS CREATE command.
CSDAPI
The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
CSDBATCH
The resource definition was last changed by a DFHCSDUP job.
DREPAPI
The resource definition was last changed by a CICSPlex SM BAS API command.
SYSTEM
The resource definition was last changed by the CICS or CICSPlex system.
CHANGEAGREL(value)
Displays the 4-digit number of the CICS release that was running when the resource definition was last changed.
CHANGETIME(date time)
Displays the date and time when the resource definition was last changed. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
CHANGEUSRID(value)
Displays the 8-character user ID that ran the change agent.
CIPHERS(value)

Returns either a 56–character area that contains the list of cipher suites that is used to negotiate with clients during the SSL handshake or the name of the SSL cipher suite specification file, which is a z/OS® UNIX file in the security/ciphers subdirectory of the directory that is specified by the USSCONFIG system initialization parameter. For more information, see SSL cipher suite specification file.

If you do not specify a list, then this list is defaulted to a set of ciphers based on the ENCRYPTION system initialization parameter.

CLOSETIMEOUT(value)
Returns a fullword value containing the number of seconds specified for the timeout period. This value can be in the range 0 - 86400 (24 hours). For the HTTP protocol, do not specify 0 because this setting means that persistent connections cannot be maintained.
CONNECTION(value)
Returns the number of current sockets connections for this service.
DEFINESOURCE(value)
Displays the source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT option. For details, see Summary of the resource signature field values.
DEFINETIME(date time)
Displays the date and time when the resource was created. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
Start of changeGENERICTCPS(value)End of change
Start of changeReturns the 8-character generic TCPIPSERVICE name that this specific TCPIPSERVICE is associated with when used as part of the configuration within an IPIC high-availability cluster. This information will only be present when both TCPIPSERVICES are opened. It will be left blank when there is no generic TCPIPSERVICE or when this generic TCPIPSERVICE is closed.End of change
HOST(value)
Displays the host name, IPv4, or IPv6 address of the remote system. All IPv4 addresses are displayed as IPv4 dotted decimal addresses, for example, 1.2.3.4, regardless of the type of address format used. For information about accepted IPv4 formats, see IP addresses.
HOSTTYPE(value)
Displays the address format of the HOST option. The HOSTTYPE option is available by using an expanded query only. The possible values are as follows:
HOSTNAME
The HOST option contains a character host name.
ANY
The ANY option is specified for the HOST option.
DEFAULT
The DEFAULT option is specified for the HOST option.
IPV4HOST
The address is an IPv4 address.
IPV6HOST
The address is an IPv6 address.
INSTALLAGENT(value)
Displays a value that identifies the agent that installed the resource. You cannot use CEMT to filter on some of these values because they are duplicated. The possible values are as follows:
Start of changeBUNDLEEnd of change
Start of changeThe resource was installed by a bundle deployment.End of change
CREATESPI
The resource was installed by an EXEC CICS CREATE command.
CSDAPI
The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
GRPLIST
The resource was installed by GRPLIST INSTALL.
INSTALLTIME(date time)
Displays the date and time when the resource was installed. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
INSTALLUSRID(value)
Displays the 8-character user ID that installed the resource.
IPADDRESS(value)
Returns an IP address. If you specify an IP address in the TCPIPSERVICE definition, that address is returned; otherwise, the default IP address is returned. If a z/OS system has more than one IP address only the default is returned.
IPFAMILY(value)
Displays the address format of the IPRESOLVED option. The IPFAMILY option is available by using an expanded query only. Filtering interacts with the IPFAMILY option when you filter by using wildcard characters. For example, if the value in IPFAMILY is IPV6FAMILY, you must use the colon character to retrieve an IP address. The possible values are as follows:
IPV4FAMILY
The address is an IPv4 address.
IPV6FAMILY
The address is an IPv6 address.
UNKNOWN
The IPRESOLVED option is not yet in use, or the address cannot be resolved.
IPRESOLVED(value)
Displays the IPv4 or IPv6 address of the host. The IPRESOLVED option is available by using an expanded query only.
MAXDATALEN(value)
Returns a fullword value that contains the maximum length of data that can be received by CICS as an HTTP server. This value can be 3 KB through 524288 KB. The default is 32 KB.
MAXPERSIST(value)
Returns a fullword value that contains the maximum number of persistent connections from web clients that the CICS region allows for this port at any one time. This setting applies only for the HTTP protocol. NO means that there is no limit on the number of persistent connections. A zero setting means that no persistent connections are allowed. A zero setting is not compliant with the HTTP/1.1 specification and must not be set in a CICS region that is handling external requests.
OPENSTATUS(value)
Returns the state of the service.
OPEN
CICS internal sockets support is open.
OPENING
CICS internal sockets support is in the process of opening.
CLOSED
CICS internal sockets support is not yet activated, or has been terminated.
CLOSING
CICS internal sockets support is in the process of closing.
IMMCLOSE
CICS internal sockets support has immediately terminated for this service.
IMMCLOSING
CICS internal sockets support is in the process of immediate termination.
PORT(value)
Returns the number of the port on which CICS is listening on behalf of this service.
PRIVACY(value)
Returns the level of SSL encryption that is required for inbound connections to this service.
REQUIRED
Encryption must be used. During the SSL handshake, CICS advertises only supported cipher suites that provide encryption.
SUPPORTED
Encryption is used if both client and server support it. During the SSL handshake, CICS advertises all supported cipher suites.
NOTSUPPORTED
Encryption must not be used. During the SSL handshake, CICS advertises only supported cipher suites that do not provide encryption.
PROTOCOL(value)
Identifies to CICS the type of service to be provided on the TCP/IP port.
ECI
Connections are handled by CICS ECI over TCP/IP support.
HTTP
Connections are handled by CICS web support.
IPIC
IP interconnectivity.
USER
The user-defined protocol is used. Requests are passed to the analyzer program for the TCPIPSERVICE, and handled by using CICS web support facilities, but the HTTP specifications are not used to check the messages.
REALM (value)
Returns the 56-character realm that is used during the process of HTTP basic authentication.
SOCKETCLOSE(value)
Indicates whether a timeout value is in effect for the TCPIPSERVICE.
WAIT
NO was specified on the definition. Socket receives wait for data indefinitely.
TIMEOUT
A value was specified for the SOCKETCLOSE parameter on the definition.
Start of changeSPECIFTCPS(value)End of change
Start of changeDisplays the 8-character name of the specific TCPIPSERVICE name that this generic TCPIPSERVICE uses when receiving a high-availability IPIC connection request.End of change
SSLTYPE(value)
Indicates the status of SSL support for this service.
SSL
Nonclient authentication SSL flows are processed on this port.
NOSSL
Non-SSL flows are processed on this port.
CLIENTAUTH
SSL client authentication flows are processed on this port.
TCPIPSERVICE(value)
Returns an 8-character name that identifies this service.
TRANSID(value)
Returns a 4-character transaction ID used on the attach for the task started to process a new request.
URM(value)
Returns the 8-character name of the user-replaceable program to be started by the attached task.