SET TCPIPSERVICE

Modify the status of a service using CICS internal TCPIP support.

Read syntax diagramSkip visual syntax diagramSET TCPIPSERVICE
 
>>-SET TCPIPSERVICE(data-value)--BACKLOG(data-area)------------->
 
>--MAXDATALEN(data-area)--+------------------+------------------>
                          +-OPENSTATUS(cvda)-+
                          +-CLOSED-----------+
                          +-IMMCLOSE---------+
                          '-OPEN-------------'
 
>--+-----------------+--+-----------------+--------------------><
   +-DNSSTATUS(cvda)-+  '-URM(data-value)-'
   '-DEREGISTERED----'
 

Conditions: INVREQ, NOTAUTH, NOTFND

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

SET TCPIPSERVICE tells CICS to start or stop listening for incoming requests on the port associated with a service using CICS internal TCPIP support, and changes the attributes of the service.

Note:
This command has no effect on the sockets support provided by the TCPIP for OS/390 CICS Sockets Feature.

Options

BACKLOG(data-area)
changes the maximum number of requests that can be queued in TCP/IP waiting to be processed by the service. The service must be CLOSED before you can change this value. If you set BACKLOG to zero, CICS does not receive any connections.
DNSSTATUS
changes the Domain Name System (DNS) /Workload Manager (WLM) registration status of this service. This can be done independently of changing the open or closed status of the service.

To account for timing delays in the deregister request reaching the WLM and the DNS updating its tables, it is advisable to deregister a service before setting it closed. This ensures that client applications do not encounter "Connection Refused" situations during the time between the deregister call being issued and the DNS server actually updating its tables. The valid CVDA values are:

DEREGISTERED
causes CICS to deregister the group name specified by the DNSGROUP attribute of this TCPIPSERVICE. The OS/390 WLM macro IWMSRDRS is called and CICS will no longer be a part of the DNS connection optimization. Any other TCPIPSERVICEs that are in the same group (that is, share the same DNSGROUP attribute) are also deregistered.
OPENSTATUS(cvda)
Changes the status of the service. CVDA values are:
OPEN
CICS internal TCPIP support is to start listening for incoming requests on the specified port.
CLOSED
CICS internal sockets support is to stop listening for incoming work on the specified port.
IMMCLOSE
CICS internal sockets support is to stop listening for incoming work on the specified port. If it is currently active, CICS is to terminate abnormally any tasks using it.
Start of changeMAXDATALEN(data-area)End of change
Start of changechanges the maximum length of data, in kilobytes, that may be received by CICS as an HTTP server. The default value is 32. The minimum is 3, and the maximum is 524288.End of change
URM(cvda)
Specifies the 8-character name of the program to be used as the Service User-replaceable module. You can specify either an installation-specific program or the CICS-supplied default for the service. Some services may not allow this name to be changed.
Note:
This program and any programs it invokes must be installed before they can be used in the program autoinstall process. You can do this either with explicit PROGRAM definitions or by autoinstall when some other autoinstall program is in force. Otherwise the program autoinstall process fails when it is next used, and CICS makes it inactive.

Conditions

INVREQ
RESP2 values:
4
TCPIP is not available (TCPIP=NO)
5
TCPIP status is closed
7
Port is in use
8
CICS is not authorized to use this port
9
TCPIPSERVICE not closed
10
Unknown IP address
11
Invalid value specified in an operand of the SET command.
12
The requested action cannot be performed because the openstatus of the service does not allow it.
13
TCPIP is inactive.
14
The TCPIPSERVICE has not been opened because the MAXSOCKETS limit has been reached.
17
The TCPIPSERVICE cannot be opened because PROTOCOL(IIOP) was specified and the IIOPLISTENER system initialization parameter is set to NO.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values:
3
the named TCPIPSERVICE is not found.
[[ Contents Previous Page | Next Page Index ]]