TCPIPS Resource Table
A CICS® Resource that describes a TCP⁄IP Service in an active CICS system being managed by CICSPlex® SM.
The Primary key field for this resource class is NAME.
The following actions are supported:
- CLOSE
- Close a TCP⁄IP Service
- DISCARD
- Discard a TCP⁄IP Service
- IMMCLOSE
- Close a TCP⁄IP Service immediately
- OPEN
- Open a TCP⁄IP Service
These actions require no unique parameter data.
- External resource name
- CICSTCPIPService
- Length
- 624
- Usage
- API or WUI or CICS Management Client Interface or EVALDEF
- API view
- Yes
- CMAS context
- No
- SCOPE applies
- Yes
- Only query CMASs in workload
- No
- Object type
- CICS Resource
- Copybook identifier
- EYUt0103
| Operations | Actions | Parameters | Required |
|---|---|---|---|
| GET | None | N/A | |
| SET | None | N/A | |
| PERFORM SET | DISCARD | None | N/A |
| OPEN | None | N/A | |
| CLOSE | None | N/A | |
| IMMCLOSE | None | N/A | |
| DEREGISTER | None | N/A |
| Name | Datatype | Source | Len | Sum | Set | Description | Default | Get Invalid | Attr ID |
|---|---|---|---|---|---|---|---|---|---|
| EYU_CICSNAME | CHAR | CPSM | 8 | DIFF | No | CICS System Name | |||
| EYU_CICSREL | CHAR | CPSM | 4 | DIFF | No | CICS Release | |||
| EYU_RESERVED | CHAR | CPSM | 4 | N/A | No | Reserved | |||
| ATTACHSEC | CVDAS | INQ | 4 | LIKE | No | Attach-time security | 32 | ||
| ATTACHSEC Input/output valid values | NOTAPPLIC | ||||||||
| ATTACHSEC Output valid values | LOCAL, VERIFY | ||||||||
| AUTHENTICATE | CVDAS | INQ | 4 | LIKE | No | Authentication level | 24 | ||
| AUTHENTICATE Output valid values | AUTOAUTH, AUTOREGISTER, BASICAUTH, CERTIFICAUTH, NOAUTHENTIC, ASSERTED | ||||||||
| BACKLOG | BINARY | INQ | 4 | AVG | Yes | Queue backlog setting | 3 | ||
| BASDEFINEVER | BINARY | CPSM | 1 | AVG | No | BAS resource definition version | 0 | E640 E650 | 48 |
| BYTERCVD | BINARY | STAT | 8 | AVG | No | Number of bytes received across all sockets | 21 | ||
| BYTESENT | BINARY | STAT | 8 | AVG | No | Number of bytes sent across all sockets | 19 | ||
| CERTIFICATE | CHAR | INQ | 32 | DIFF | No | Certificate | 25 | ||
| CHANGEAGENT | CVDAS | INQ | 4 | LIKE | No | Last modification agent | E640 E650 | 40 | |
| CHANGEAGENT Input/output valid values | CSDAPI, CSDBATCH, DREPAPI, DREPBATCH, SYSTEM, CREATESPI, NOTAPPLIC | ||||||||
| CHANGEAGREL | CHAR | INQ | 4 | DIFF | No | Last modification agent release | E640 E650 | 41 | |
| CHANGETIME | DATETIME | INQ | 8 | MAX | No | Last modification time | E640 E650 | 43 | |
| CHANGEUSRID | CHAR | INQ | 8 | DIFF | No | Last modification user ID | E640 E650 | 39 | |
| CIPHERS | CHAR | INQ | 56 | LIKE | No | SSL cipher suite codes | 34 | ||
| CLOSETIMEOUT | BINARY | INQ | 4 | AVG | No | Timeout for socket close (seconds) | 23 | ||
| CMAXBACKLOG | BINARY | STAT | 4 | AVG | No | Current maximum backlog | E640 E650 E660 E670 E680 E690 E700 | 65 | |
| CONNECTIONS | BINARY | INQ | 4 | AVG | No | Number of connections | 8 | ||
| CONNLASTDROP | TIMESTP | STAT | 8 | MAX | No | Time connection last dropped | E640 E650 E660 E670 E680 E690 E700 | 64 | |
| CONNSDROPPED | BINARY | STAT | 4 | AVG | No | Connections dropped | E640 E650 E660 E670 E680 E690 E700 | 63 | |
| CURRBACKLOG | BINARY | STAT | 4 | AVG | No | Current backlog | E640 E650 E660 E670 E680 E690 E700 | 62 | |
| DEFINESOURCE | CHAR | INQ | 8 | DIFF | No | Source of the resource definition | E640 E650 | 44 | |
| DEFINETIME | DATETIME | INQ | 8 | MAX | No | Creation time | E640 E650 | 45 | |
| DISCATTLIM | BINARY | STAT | 4 | AVG | No | Times disconnected a persistent connection at task limit | E640 E650 E660 E670 E680 E690 E700 | 60 | |
| DISCATUSELIM | BINARY | STAT | 4 | AVG | No | Times disconnected an connection at max uses | E640 E650 E660 E670 E680 E690 E700 | 61 | |
| DNSGROUP | CHAR | INQ | 18 | DIFF | No | Domain name service (DNS) group | E690+ | 28 | |
| DNSSTATUS | CVDAS | INQ | 4 | LIKE | Yes | Domain name service (DNS) status | E690+ | 30 | |
| DNSSTATUS Input/output valid values | DEREGISTERED | ||||||||
| DNSSTATUS Output valid values | UNAVAILABLE, UNREGISTERED, REGISTERED, REGERROR, DEREGERROR, NOTAPPLIC | ||||||||
| GENERICTCPS | CHAR | INQ | 8 | DIFF | No | Generic TCPIPService | E640 E650 E660 E670 E680 | 56 | |
| GMTSERVOPN | DATETIME | STAT | 8 | MAX | No | GMT service open time | 14 | ||
| GRPCRITICAL | CVDAS | INQ | 4 | LIKE | No | Critical domain name service (DNS) group member | E690+ | 31 | |
| GRPCRITICAL Output valid values | NONCRITICAL, CRITICAL | ||||||||
| HOST | CHAR | INQ | 116 | DIFF | No | Server address to listen on | E640 E650 | 52 | |
| HOSTTYPE | CVDAS | INQ | 4 | LIKE | No | The listening server's address format | E640 E650 | 50 | |
| HOSTTYPE Output valid values | ANY, DEFAULT, HOSTNAME, IPV4, IPV6, NOTAPPLIC | ||||||||
| INSTALLAGENT | CVDAS | INQ | 4 | LIKE | No | Installation agent | E640 E650 | 42 | |
| INSTALLAGENT Input/output valid values | CSDAPI, CREATESPI, GRPLIST, BUNDLE | ||||||||
| INSTALLTIME | DATETIME | INQ | 8 | MAX | No | Installation time | E640 E650 | 47 | |
| INSTALLUSRID | CHAR | INQ | 8 | DIFF | No | Installation user ID | E640 E650 | 46 | |
| IPADDRESS | CHAR | INQ | 15 | DIFF | No | IPv4 address of the service | 10 | ||
| IPFAMILY | CVDAS | INQ | 4 | LIKE | No | Resolved IP address format | E640 E650 | 51 | |
| IPFAMILY Output valid values | IPV4, IPV6, UNKNOWN | ||||||||
| IPRESOLVED | CHAR | INQ | 39 | DIFF | No | Resolved IP address | E640 E650 | 49 | |
| MAXDATALEN | BINARY | INQ | 4 | AVG | Yes | Maximum length of data that may be received | 37 | ||
| MAXPERSIST | BINARY | INQ | 4 | DIFF | No | Maximum persistent connections | E640 E650 E660 | 53 | |
| NAME-1 | CHAR | INQ | 8 | DIFF | No | TCP/IP service name | 1 | ||
| NONPERSIST | BINARY | STAT | 4 | DIFF | No | Number of non-persisted connections | E640 E650 E660 | 54 | |
| NPERSATMAXP | BINARY | STAT | 4 | AVG | No | Times a connection was made non-persistent because MAXPERSIST was reached | E640 E650 E660 E670 E680 E690 E700 | 58 | |
| NPERSATTLIM | BINARY | STAT | 4 | AVG | No | Times a connection made non-persistent at task limit | E640 E650 E660 E670 E680 E690 E700 | 59 | |
| NUMCIPHERS | BINARY | INQ | 2 | LIKE | No | Number of SSL cipher suite codes | 35 | ||
| OPENSTATUS | CVDAS | INQ | 4 | LIKE | Yes | TCP/IP service status | 4 | ||
| OPENSTATUS Input/output valid values | OPEN, CLOSED, IMMCLOSE | ||||||||
| OPENSTATUS Output valid values | OPENING, CLOSING, IMMCLOSING | ||||||||
| PEAKCONNS | BINARY | STAT | 4 | AVG | No | Peak number of connections | 13 | ||
| PORT | BINARY | INQ | 4 | MAX | No | Port number | 2 | ||
| PRIVACY | CVDAS | INQ | 4 | LIKE | No | Privacy for clients using this service | E640+ | 33 | |
| PRIVACY Output valid values | REQUIRED, SUPPORTED, NOTSUPPORTED | ||||||||
| PROTOCOL | CVDAS | INQ | 4 | LIKE | No | Protocol | 27 | ||
| PROTOCOL Output valid values | HTTP, IIOP, USER, ECI, IPIC | ||||||||
| REALM | CHAR | INQ | 56 | DIFF | No | Basic authentication realm name | E640 | 38 | |
| RECEIVES | BINARY | STAT | 4 | AVG | No | Number of receives across all sockets | 20 | ||
| REQUESTS | BINARY | STAT | 4 | AVG | No | Requests | E640 E650 E660 E670 E680 E690 E700 | 66 | |
| SENDS | BINARY | STAT | 4 | AVG | No | Number of sends across all sockets | 18 | ||
| SOCKETCLOSE | CVDAS | INQ | 4 | LIKE | No | Socket close action | 22 | ||
| SOCKETCLOSE Output valid values | WAIT, TIMEOUT | ||||||||
| SPECIFTCPS | CHAR | INQ | 8 | DIFF | No | Specific TCPIPService | E640 E650 E660 E670 E680 | 55 | |
| SSLTYPE | CVDAS | INQ | 4 | LIKE | No | Secure sockets layer (SSL) type | 7 | ||
| SSLTYPE Output valid values | SSL, NOSSL, CLIENTAUTH, ATTLSAWARE | ||||||||
| TIMEOPEN | DATETIME | STAT | 8 | MAX | No | Local service open time | 15 | ||
| TOTALCONNS | BINARY | STAT | 4 | AVG | No | Total connections | E640 E650 E660 E670 E680 E690 E700 | 57 | |
| TRANATTACH | BINARY | STAT | 4 | AVG | No | Number of transactions attached | 12 | ||
| TRANSID | CHAR | INQ | 4 | DIFF | No | CICS transaction ID | 5 | ||
| TSQPREFIX | CHAR | INQ | 6 | DIFF | No | TS queue prefix | 9 | ||
| URM | CHAR | INQ | 8 | DIFF | Yes | User-replaceable module name | 6 | ||