SET TCPIP

Modify CICS® internal TCPIP support.

SET TCPIP

Read syntax diagramSkip visual syntax diagramSET TCPIP MAXSOCKETS( data-value)NEWMAXSOCKET( data-area)OPENSTATUS( data-value)CLOSEDIMMCLOSEOPEN

Conditions: INVREQ, IOERR, NOTAUTH, NOTSUPERUSER

This command is threadsafe.

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

Description

SET TCPIP allows you to open or close CICS internal sockets support.

Options

MAXSOCKETS(data-value)
specifies, as a fullword binary field, the maximum number of IP sockets that can be managed by the CICS sockets domain.

If the userid under which the CICS job is running has superuser authority, up to 65535 sockets can be managed by the sockets domain.

If the userid under which the CICS job is running does not have superuser authority, the maximum number of sockets that can be managed by the sockets domain is limited to the number specified in the MAXFILEPROC parameter in SYS1.PARMLIB member BPXPRMxx. If you specify a greater value, CICS sets the limit to MAXFILEPROC.

Note that sockets created by Java™ programs running on threads that are not managed by CICS do not count towards the MAXSOCKETS limit.

If you reduce the limit to less than the number of sockets currently active, CICS prevents new sockets from being created until the number of active sockets falls below the limit.

NEWMAXSOCKET(data-area)
returns, in a fullword binary field, the new value of MAXSOCKETS.

If the userid under which the CICS job is running does not have superuser authority, CICS may set the MAXSOCKETS limit to a smaller value than requested. NEWMAXSOCKET tells you the limit that CICS has set.

OPENSTATUS(cvda)
specifies whether TCPIP is to be enabled (that is, able to process new incoming work, and complete ongoing work), and if TCPIP support is to be disabled, how the disable should be done. CVDA values are:
OPEN
CICS internal TCPIP support is to be opened.
CLOSED
CICS internal sockets support is to be closed. If it is currently open, CICS is to quiesce all internal sockets activity and then close any sockets on which CICS is listening for incoming CICS Web Interface work. Tasks using CICS internal sockets are allowed to complete.
IMMCLOSE
CICS internal sockets is to be closed. If it is currently enabled, CICS is to terminate abnormally any tasks using it and then close the socket on which CICS is listening for incoming work.

Conditions

INVREQ
RESP2 values:
4
TCPIP not available (TCPIP=NO)
6
TCPIP already open (for SET OPEN)
11
STATUS has an invalid CVDA value.
12
The OPEN request did not complete because another task subsequently requested a CLOSE of CICS internal sockets support.
16
MAXSOCKETS is not in the range 1 to 65535
NORMAL
RESP2 value:
14
TCPIP has been opened, but some TCPIPSERVICEs have not been opened because the MAXSOCKETS limit has been reached.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
NOTSUPERUSER
RESP2 values:
15
CICS was unable to set the MAXSOCKETS limit to the value requested, because the userid which the CICS job is running under does not have superuser authority. CICS has set the limit to the value of the MAXFILEPROC parameter specified in the SYS1.PARMLIB member BPXPRMxx.