SOAD gate, ADD_REPLACE_TCPIPSERVICE function

The ADD_REPLACE_TCPIPSERVICE function is called at RDO time to install a TCPIPSERVICE resource. If the status is OPEN then the service is also opened using the SORD REGISTER function. A catalog entry is written to record the installed resource.

Input Parameters

BACKLOG
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.
IPADDRESS
The specific IP address that the listener will bind to for this service.
MAXDATA_LENGTH
The maximum length of data that may be received by CICS®.
PORTNUMBER
The port number to listen on.
SOCKETCLOSE
The interval from the time of the initial receive request for incoming data, after which CICS is to time out the socket.
SSL
Whether or not connections to this service are to be secured using the Secure Sockets Layer (SSL) protocols.
Values for the parameter are:
  • CLIENTAUTH
  • NO
  • YES
  • ATTLSAWARE
STATUS
The status of the service.
Values for the parameter are:
  • CLOSED
  • OPEN
TCPIPSERVICE_NAME
The name of the TCPIPSERVICE resource.
URM_NAME
The name of the user-replaceable program.
ATTACHSEC
Optional Parameter
The level of attach-time security required for TCP/IP connections to CICS Clients.
AUTHENTICATION
Optional Parameter
The authentication and identification scheme to be used for inbound TCP/IP connections.
Values for the parameter are:
  • ASSERTED
  • AUTOMATIC
  • AUTOREGISTER
  • BASIC
  • CERTIFICATE
  • KERBEROS
  • NONE
CERTIFICATE_LABEL
Optional Parameter
The name of a certificate within the keyfile that this service will use to authenticate itself to clients with, if the SSL protocol is used.
CIPHER_SUITES
Optional Parameter
A string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes.
DNSGROUP
Optional Parameter
The group name with which CICS will register to Workload Manager, for connection optimization.
GRPCRITICAL
Optional Parameter
Whether or not the service is a critical member of the DNS group.
Values for the parameter are:
  • CRITICAL
  • NONCRITICAL
MAXPERSIST
Optional Parameter
The maximum number of persistent connections from web clients that the CICS region allows for this port at any one time.
NUMCIPHERS
Optional Parameter
The number of cipher suites specified in the CIPHER_SUITES parameter.
PRIVACY
Optional Parameter
The level of SSL encryption required for inbound connections to this service that is specified by the CIPHERS attribute.
Values for the parameter are:
  • NOTSUPPORTED
  • REQUIRED
  • SUPPORTED
PROTOCOL
Optional Parameter
The application level protocol used on the TCP/IP port.
TRANSACTION
Optional Parameter
The transaction ID of the transaction to attach for each connection to this service.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • CATALOG_ERROR
The following values are returned when RESPONSE is EXCEPTION:
  • AT_MAXSOCKETS
  • AUTHENTICATION_UNAVAILABLE
  • CERTIFICATE_INVALID
  • INVALID_NAME
  • INVALID_STATUS
  • PORT_IN_USE
  • PORT_NOTAUTH
  • SERVICE_OPEN
  • SSL_NOT_AVAILABLE
  • TCPIP_CLOSED
  • TCPIP_INACTIVE
  • UNKNOWN_IP_ADDRESS
  • UNSUPPORTED_CIPHER
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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