TCPDEF Resource Table

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

The First key field for this resource is NAME.

The Second key field for this resource is DEFVER.

The Third key field for this resource is CSDGROUP.

The following actions are supported:
ADDTOGRP
Add to resource group
The parameter data for the ADDTOGRP action is: 
   PARM('RESGROUP(resgroup).')

     where:

     resgroup = The name of a RESGROUP definition.
CSDCOPY
Copy the CICS CSD resource definition in a CSD group into an different CSD group.
The parameter data for the CSDCOPY action is described in Managing CICS definitions in the CSD.
CSDINSTALL
Install the CICS CSD resource definition in a CSD group into an active system.
The parameter data for the CSDINSTALL action is described in Managing CICS definitions in the CSD.
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(CMCI)
CICSDefinitionTCPIPService
Object type
CICS Definition
Length
560
Usage
API, Batch Utility, WUI, CICS Management Client Interface(CMCI)
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
No
Copybook identifier
EYUt3823
CICS Commands subject to CICS Security
INQUIRE TCPIPSERVICE
Unsupported CICS Releases
None
Table 1. Valid CPSM operations
Operations Actions Parameters Required
CREATE   CSD No
    RESGROUP(value) No
GET   CICSGRP(value) No
    CICSSYS(value) No
    CSDGROUP(value) No
    RESGROUP(value) No
REMOVE   CSD No
UPDATE   CSD No
PERFORM SET, PERFORM OBJECT ADDTOGRP RESGROUP(value) Yes
  CSDCOPY AS_RESOURCE(value) No
    DUPACTION(DUPERROR, DUPNOREPLACE, DUPREPLACE) No
    TO_CSDGROUP(value) No
  CSDINSTALL None N/A
  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
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 Description Default Value Range Get Invalid Offset
 NAME-1  CHAR CPSM 8 Yes DIFF Name       25
 DEFVER-2  BINARY CPSM 1 Yes AVG Version 0 0-15   24
 CSDGROUP-3  CHAR CPSM 8 Yes DIFF CSD group       528
ATTACHSEC EYUDA CPSM 4 No LIKE Attach-time security NOTAPPLIC     280
ATTACHSEC Input/output valid values
  • LOCAL
  • VERIFY
  • NOTAPPLIC
AUTHENTICATE EYUDA CPSM 4 Yes LIKE Authentication level NO     248
AUTHENTICATE Input/output valid values
  • NO
  • BASIC
  • CERTIFICATE
  • AUTOREGISTER
  • AUTOMATIC
  • NOTAPPLIC
  • ASSERTED
BACKLOG CHAR CPSM 8 Yes DIFF Queue backlog limit   0-32767   60
CERTIFICATE CHAR CPSM 56 No DIFF Certificate       72
CHANGEAGENT CVDAS CPSM 4 No LIKE Last modification agent       8
CHANGEAGENT Input/output valid values
  • CSDAPI
  • CSDBATCH
  • DREPAPI
  • N_A
CHANGEAGREL CHAR CPSM 4 No DIFF Last modification agent release       20
CHANGETIME DATETIME CPSM 8 Yes MAX Last modification time       0
CHANGEUSRID CHAR CPSM 8 No DIFF Last modification user ID       12
CIPHERS CHAR CPSM 56 No LIKE SSL cipher suite codes       288
CREATETIME DATETIME CPSM 8 Yes MAX Time created       128
DESCCODEPAGE BINARY CPSM 4 No DIFF Description code page 37 0-99999999   352
DESCRIPTION CHAR CPSM 58 No DIFF Description       160
DNSGROUP CHAR CPSM 18 No DIFF Domain name service (DNS) group     E690+ 256
GRPCRITICAL EYUDA CPSM 4 No LIKE Critical domain name service (DNS) group member NOTAPPLIC   E690+ 276
GRPCRITICAL Input/output valid values
  • NO
  • YES
  • NOTAPPLIC
HOST CHAR CPSM 116 Yes DIFF Incoming connections listening address       412
IPADDRESS CHAR CPSM 15 No DIFF IPv4 address       224
MAXDATALEN CHAR CPSM 6 No DIFF Maximum length of data to be received or sent 32 3-524288   344
MAXPERSIST CHAR CPSM 5 No DIFF Maximum number of persistent connections NO 0-65535   536
MAXPERSIST Input/output valid values
  • NO
OPTIONSPGM CHAR CPSM 8 No DIFF HTTP OPTIONS handler program     E710-E720 549
PORTNUMBER CHAR CPSM 8 Yes DIFF Port number   1-65535   33
PRIVACY CVDAS CPSM 4 No LIKE Privacy NOTAPPLIC   E640+ 284
PRIVACY Input/output valid values
  • REQUIRED
  • SUPPORTED
  • NOTSUPPORTED
  • NOTAPPLIC
PROTOCOL CVDAS CPSM 4 No LIKE Protocol       252
PROTOCOL Input/output valid values
  • HTTP
  • IIOP
  • ECI
  • USER
  • NOTAPPLIC
  • IPIC
REALM CHAR CPSM 56 No DIFF Basic authentication realm name       356
SOCKETCLOSE CHAR CPSM 6 No DIFF Timeout for socket close (HHMMSS)       239
SPECIFTCPS CHAR CPSM 8 No DIFF Specific TCPIPService       541
SSL EYUDA CPSM 4 Yes LIKE Secure sockets layer (SSL) type NO     68
SSL Input/output valid values
  • YES
  • NO
  • CLIENTAUTH
  • ATTLSAWARE
STATUS CVDAS CPSM 4 Yes LIKE TCP/IP service status OPEN     44
STATUS Input/output valid values
  • OPEN
  • CLOSED
TRANSACTION CHAR CPSM 4 Yes DIFF CICS transaction ID       48
TSQPREFIX CHAR CPSM 6 No DIFF TS queue prefix       218
URM CHAR CPSM 8 No DIFF User-replaceable module name       52
USERDATA1 CHAR CPSM 8 No DIFF User data area 1       136
USERDATA2 CHAR CPSM 8 No DIFF User data area 2       144
USERDATA3 CHAR CPSM 8 No DIFF User data area 3       152