A CICS® Definition that describes a TCP/IP Service.
The Primary key field for this resource class is NAME .
The following actions are supported:
The parameter data for the INSTALL action is described in Parameters for installing CICS Definitions.
API Actions
PARM(' [NOTIFY(value)] USAGE(value) [FORCEINS(value)] [STATECHK(value)] [MODE(value)] [OVERTYPE(value)] [OVERRIDE(override)] TARGET(value) [RELATED(value)] .')
PARM(' [ERRQUEUE] RESGROUP(value) .')
Code | Description | Code | Description |
DIFF_VERSION | Different version | INV_RESTYPE | Invalid resource type |
EARLY_NAMELIST_END | Early name list end | INV_RSCOPE | Invalid related scope |
INCONSISTENT_SET | Inconsistent set condition | INV_STATECHK | Invalid state check |
INV_ACTION | Invalid action | INV_STRNGTERM | Invalid string terminator |
INV_ATTRIBUTE | Invalid attribute | INV_TSCOPE | Invalid target scope |
INV_CONTEXT | Context not found | INV_USAGE | Invalid usage |
INV_DATA | Attribute data invalid | INV_VER | Invalid resource version |
INV_EMBEDTERM | Invalid embedded terminator | MISSING_RELSYSID | Missing related system identifier |
INV_FORCEINS | Invalid force install | MORE_THAN_1_RELSYS | More than one related system |
INV_LITERAL | Invalid literal | NODEFS_SELECTED | No definitions selected |
INV_MINNAME | Invalid minor name | NON_MP | Maintenance point CMAS not available |
INV_MODE | Invalid mode | NOTHING_INSTALLED | Nothing installed |
INV_NAME | Invalid name | NOTIFY | Notify |
INV_NAMELIST | Invalid name list | NO_RELATED | No related systems |
INV_NOTIFY | Invalid notify | NO_TARGETS | No targets |
INV_ORSTGNA | Invalid override string | PARTIAL_INSTALL | Partial install |
INV_ORSTRING | Invalid override string | REC_CHANGED | Resource definition already changed |
INV_OVERTYPE | Invalid overtype | REC_EXISTS | Resource already exists |
INV_OVRBLOCK | Invalid override block | REC_NOT_FOUND | Requested resource not found |
INV_RECADDR | Invalid record address | SCOPE_CONFLICT | Scope conflict |
INV_RECLEN | Invalid record length | SCOPE_REQUIRED | Scope required |
INV_RESGROUP | Resource group not found | USAGE_CONFLICT | Usage conflict |
Name | Datatype | Source | Len | Req | Sum | Description | Default | Value Range | Attr ID |
---|---|---|---|---|---|---|---|---|---|
CHANGETIME | DATETIME | CPSM | 8 | Yes | MAX | Last time the definition was changed | 1 | ||
DEFVER-2 | BINARY | CPSM | 1 | Yes | AVG | Definition version | 0 | 0-15 | 5 |
NAME-1 | CHAR | CPSM | 8 | Yes | DIF | TCP/IP service definition name | 7 | ||
PORTNUMBER | CHAR | CPSM | 8 | Yes | DIF | Port number | 1-65535 | 8 | |
STATUS | CVDAS | CPSM | 4 | Yes | LIKE | TCP/IP service status | OPEN | 9 | |
STATUS Input/Output Valid Values | OPEN CLOSED | ||||||||
TRANSACTION | CHAR | CPSM | 4 | Yes | DIF | CICS transaction ID | 10 | ||
URM | CHAR | CPSM | 8 | No | DIF | User-replaceable module name | 11 | ||
BACKLOG | CHAR | CPSM | 8 | Yes | DIF | Queue backlog limit | 00001 | 0-32767 | 12 |
SSL | EYUDA | CPSM | 4 | Yes | LIKE | Secure sockets layer (SSL) type | NO | 13 | |
SSL Input/Output Valid Values | YES NO CLIENTAUTH | ||||||||
CERTIFICATE | CHAR | CPSM | 56 | No | DIF | Certificate | 15 | ||
CREATETIME | DATETIME | CPSM | 8 | Yes | MAX | Definition create time | 16 | ||
USERDATA1 | CHAR | CPSM | 8 | No | DIF | User data area 1 | 17 | ||
USERDATA2 | CHAR | CPSM | 8 | No | DIF | User data area 2 | 18 | ||
USERDATA3 | CHAR | CPSM | 8 | No | DIF | User data area 3 | 19 | ||
DESCRIPTION | CHAR | CPSM | 58 | No | DIF | Definition description | 20 | ||
TSQPREFIX | CHAR | CPSM | 6 | No | DIF | TS queue prefix | 21 | ||
IPADDRESS | CHAR | CPSM | 15 | No | DIF | IP address | 22 | ||
SOCKETCLOSE | CHAR | CPSM | 6 | No | DIF | Timeout for socket close (HHMMSS) | 23 | ||
AUTHENTICATE | EYUDA | CPSM | 4 | Yes | LIKE | Authentication level | NO | 25 | |
AUTHENTICATE Input/Output Valid Values | NO BASIC CERTIFICATE AUTOREGISTER AUTOMATIC NOTAPPLIC ASSERTED | ||||||||
PROTOCOL | CVDAS | CPSM | 4 | No | LIKE | Protocol | 26 | ||
PROTOCOL Input/Output Valid Values | HTTP IIOP ECI USER NOTAPPLIC | ||||||||
DNSGROUP | CHAR | CPSM | 18 | No | DIF | Domain name service (DNS) group | 27 | ||
GRPCRITICAL | EYUDA | CPSM | 4 | No | LIKE | Critical domain name service (DNS) group member | NOTAPPLIC | 29 | |
GRPCRITICAL Input/Output Valid Values | NO YES NOTAPPLIC | ||||||||
ATTACHSEC | EYUDA | CPSM | 4 | No | LIKE | Attach-time security | NOTAPPLIC | 30 | |
ATTACHSEC Input/Output Valid Values | LOCAL VERIFY NOTAPPLIC | ||||||||
PRIVACY | CVDAS | CPSM | 4 | No | LIKE | Privacy | NOTAPPLIC | 31 | |
PRIVACY Input/Output Valid Values | REQUIRED SUPPORTED NOTSUPPORTED NOTAPPLIC | ||||||||
CIPHERS | CHAR | CPSM | 56 | No | LIKE | SSL cipher suite codes | 32 | ||
MAXDATALEN | CHAR | CPSM | 6 | No | DIF | Maximum length of data to be received or sent | 32 | 3-524288 | 33 |