TCPDEF Resource Table

A CICS® Definition that describes a TCP⁄IP Service.

The Primary key field for this resource class is NAME.

The Secondary key field for this resource class is DEFVER.

The Tertiary key field for this resource class is CSDGROUP.

The following actions are supported:
INSTALL
Install a TCP⁄IP Service Definition.

The parameter data for the INSTALL action is described in Parameters for installing CICS definitions using BAS.

External resource name
CICSDefinitionTCPIPService
Length
560
Usage
API or Batch Utility or WUI or CICS Management Client Interface
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
No
Object type
CICS Definition
Copybook identifier
EYUt3823
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   CICSSYS(value) No
    CSDGROUP(value) No
    RESGROUP(value) No
CREATE   CSD No
    RESGROUP(value) No
UPDATE   CSD No
REMOVE   CSD No
PERFORM SET INSTALL FORCEINS(YES, NO) No
    MODE(value) No
    NOTIFY(NO, INACTIVE, RELEASE, FULL) No
    OVERRIDE No
    OVERTYPE(TARGET, RELATED, BOTH, NONE) No
    RELATED(value) No
    STATECHK(YES, NO) No
    TARGET(value) Yes
    USAGE(LOCAL) Yes
  ADDTOGRP RESGROUP(value) Yes
  CSDINSTALL None N/A
  CSDCOPY AS_RESOURCE(value) No
    DUPACTION(DUPERROR, DUPNOREPLACE, DUPREPLACE) No
    TO_CSDGROUP(value) No
Table 2. TCPDEF FEEDBACK error codes
Value Code Description
1 TCPDEF_INV_DATA Attribute data invalid
2 TCPDEF_REC_NOT_FOUND Requested resource not found
4 TCPDEF_REC_EXISTS Resource already exists
5 TCPDEF_REC_CHANGED Resource definition already changed
6 TCPDEF_INV_RESTYPE Invalid resource type
7 TCPDEF_INV_VER Invalid resource version
11 TCPDEF_NON_MP Maintenance point CMAS not available
12 TCPDEF_INV_CONTEXT Context not found
13 TCPDEF_INCONSISTENT_SET Inconsistent set condition
14 TCPDEF_INV_RESGROUP Resource group not found
21 TCPDEF_INV_ACTION Invalid action
22 TCPDEF_INV_RECADDR Invalid record address
23 TCPDEF_INV_RECLEN Invalid record length
24 TCPDEF_DIFF_VERSION Different version
25 TCPDEF_EARLY_NAMELIST_END Early name list end
26 TCPDEF_INV_NAMELIST Invalid name list
27 TCPDEF_INV_NAME Invalid name
28 TCPDEF_INV_MINNAME Invalid minor name
29 TCPDEF_NOTIFY Notify
30 TCPDEF_PARTIAL_INSTALL Partial install
31 TCPDEF_NOTHING_INSTALLED Nothing installed
32 TCPDEF_NO_TARGETS No targets
33 TCPDEF_NO_RELATED No related systems
34 TCPDEF_INV_TSCOPE Invalid target scope
35 TCPDEF_INV_RSCOPE Invalid related scope
36 TCPDEF_INV_USAGE Invalid usage
37 TCPDEF_INV_MODE Invalid mode
38 TCPDEF_INV_STATECHK Invalid state check
39 TCPDEF_INV_FORCEINS Invalid force install
40 TCPDEF_INV_NOTIFY Invalid notify
41 TCPDEF_INV_OVERTYPE Invalid overtype
42 TCPDEF_INV_OVRBLOCK Invalid override block
43 TCPDEF_INV_ORSTRING Invalid override string
44 TCPDEF_INV_STRNGTERM Invalid string terminator
45 TCPDEF_INV_EMBEDTERM Invalid embedded terminator
46 TCPDEF_INV_ATTRIBUTE Invalid attribute
47 TCPDEF_INV_LITERAL Invalid literal
48 TCPDEF_INV_ORSTGNA Invalid override string
49 TCPDEF_SCOPE_REQUIRED Scope required
50 TCPDEF_USAGE_CONFLICT Usage conflict
51 TCPDEF_NODEFS_SELECTED No definitions selected
52 TCPDEF_MORE_THAN_1_RELSYS More than one related system
53 TCPDEF_MISSING_RELSYSID Missing related system identifier
54 TCPDEF_SCOPE_CONFLICT Scope conflict
55 TCPDEF_INV_CSDGROUP Invalid CSD group
56 TCPDEF_REC_NOT_REMOVED Record not removed
57 TCPDEF_INV_RESOURCE Invalid resource
58 TCPDEF_INV_CICS_RESTYPE Invalid CICS restype
59 TCPDEF_PARTIAL_ACTION Partial action
60 TCPDEF_NOTHING_ACTIONED Nothing actioned
61 TCPDEF_INV_BOTHTOAS TO_CSDGROUP and AS_RESOURCE are mutually exclusive
62 TCPDEF_INV_NOTTOAS Either TO_CSDGROUP or AS_RESOURCE is required
63 TCPDEF_CSD_ERROR CSD access error
64 TCPDEF_INV_MAXPERSIST Invalid maxpersist value
Table 3. TCPDEF resource table attributes
Name Datatype Source Len Req Sum Set Description Default Value Range Get Invalid Attr ID
ATTACHSEC EYUDA CPSM 4 No LIKE No Attach-time security NOTAPPLIC     30
ATTACHSEC Input/output valid values LOCAL, VERIFY, NOTAPPLIC
AUTHENTICATE EYUDA CPSM 4 Yes LIKE No Authentication level NO     25
AUTHENTICATE Input/output valid values NO, BASIC, CERTIFICATE, AUTOREGISTER, AUTOMATIC, NOTAPPLIC, ASSERTED
BACKLOG CHAR CPSM 8 Yes DIFF No Queue backlog limit   0-32767   12
CERTIFICATE CHAR CPSM 56 No DIFF No Certificate       15
CHANGEAGENT CVDAS CPSM 4 No LIKE No Last modification agent     E640 E650 36
CHANGEAGENT Input/output valid values DREPAPI
CHANGEAGREL CHAR CPSM 4 No DIFF No Last modification agent release     E640 E650 38
CHANGETIME DATETIME CPSM 8 Yes MAX No Last modification time       1
CHANGEUSRID CHAR CPSM 8 No DIFF No Last modification user ID     E640 E650 37
CIPHERS CHAR CPSM 56 No LIKE No SSL cipher suite codes       32
CREATETIME DATETIME CPSM 8 Yes MAX No Time created       16
 CSDGROUP-3  CHAR CPSM 8 Yes DIFF Yes CSD group     E640 E650 41
 DEFVER-2  BINARY CPSM 1 Yes AVG Yes Version 0 0-15   5
DESCCODEPAGE BINARY CPSM 4 No DIFF No Description code page 37 0-99999999   34
DESCRIPTION CHAR CPSM 58 No DIFF No Description       20
DNSGROUP CHAR CPSM 18 No DIFF No Domain name service (DNS) group     E690+ 27
GRPCRITICAL EYUDA CPSM 4 No LIKE No Critical domain name service (DNS) group member NOTAPPLIC   E690+ 29
GRPCRITICAL Input/output valid values NO, YES, NOTAPPLIC
HOST CHAR CPSM 116 Yes DIFF No Incoming connections listening address     E640 E650 40
IPADDRESS CHAR CPSM 15 No DIFF No IPv4 address       22
MAXDATALEN CHAR CPSM 6 No DIFF No Maximum length of data to be received or sent 32 3-524288   33
MAXPERSIST CHAR CPSM 5 No DIFF No Maximum number of persistent connections NO 0-65535 E640 E650 E660 42
MAXPERSIST Input/output valid values NO
 NAME-1  CHAR CPSM 8 Yes DIFF Yes Name       7
PORTNUMBER CHAR CPSM 8 Yes DIFF No Port number   1-65535   8
PRIVACY CVDAS CPSM 4 No LIKE No Privacy NOTAPPLIC   E640+ 31
PRIVACY Input/output valid values REQUIRED, SUPPORTED, NOTSUPPORTED, NOTAPPLIC
PROTOCOL CVDAS CPSM 4 No LIKE No Protocol       26
PROTOCOL Input/output valid values HTTP, IIOP, ECI, USER, NOTAPPLIC, IPIC
REALM CHAR CPSM 56 No DIFF No Basic authentication realm name     E640 35
SOCKETCLOSE CHAR CPSM 6 No DIFF No Timeout for socket close (HHMMSS)       23
SPECIFTCPS CHAR CPSM 8 No DIFF No Specific TCPIPService     E640 E650 E660 E670 E680 43
SSL EYUDA CPSM 4 Yes LIKE No Secure sockets layer (SSL) type NO     13
SSL Input/output valid values YES, NO, CLIENTAUTH
STATUS CVDAS CPSM 4 Yes LIKE No TCP/IP service status OPEN     9
STATUS Input/output valid values OPEN, CLOSED
TRANSACTION CHAR CPSM 4 Yes DIFF No CICS transaction ID       10
TSQPREFIX CHAR CPSM 6 No DIFF No TS queue prefix       21
URM CHAR CPSM 8 No DIFF No User-replaceable module name       11
USERDATA1 CHAR CPSM 8 No DIFF No User data area 1       17
USERDATA2 CHAR CPSM 8 No DIFF No User data area 2       18
USERDATA3 CHAR CPSM 8 No DIFF No User data area 3       19