IPCONN Resource Table

A CICS® Resource that describes an IPIC connection 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:
ACQUIRE
Acquire the connection.
BACKOUT
Back out shunted units of work associated with the connection.
CANCEL
Cancel the connection.
COMMIT
Commit shunted units of work associated with the connection.
DISCARD
Discard the connection.
FORCE
Force shunted units of work associated with the connection to commit or back out.
FORCECANCEL
Cancel all AIDs, including system AIDs, queuing for the connection.
FORCEPURGE
Force purge all transactions running on sessions on the connected system.
INSERVICE
Place the connection in service.
KILL
Kill all transactions running on sessions on the connected system.
Note: Kill can lead to unpredictable results and should be used only in exceptional circumstances.
NORECOVDATA
Override the normal resynchronization process.
NOTPENDING
Set the connection not pending.
OUTSERVICE
Place the connection out of service.
PURGE
Purge the connection.
RELEASE
Release the connection.
RESYNC
Resynchronize shunted units of work associated with the connection.
These actions require no unique parameter data.

Some of these actions may be valid only for particular types of CICS connections. Refer to the appropriate CICS documentation for details.

Note: The value returned by CICS conflicts with CVDA values in other CICS environments. In order to retain the attribute's uniqueness, CICSPlex SM adds either 8000 or 9000 to the value returned by CICS. For more information about translating CVDA values, see TRANSLATE command.

External resource name
CICSIPICConnection
Length
768
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
EYUt0167
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   None N/A
SET   None N/A
PERFORM SET DISCARD None N/A
  ACQUIRE None N/A
  BACKOUT None N/A
  COMMIT None N/A
  CANCEL None N/A
  FORCE None N/A
  FORCECANCEL None N/A
  FORCEPURGE None N/A
  INSERVICE None N/A
  KILL None N/A
  NORECOVDATA None N/A
  NOTPENDING None N/A
  OUTSERVICE None N/A
  PURGE None N/A
  RELEASE None N/A
  RESYNC None N/A
Table 2. IPCONN resource table attributes
Name Datatype Source CICS Source CICS Field Len Sum Set Description Default Value Range 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        
ALLCFAILLINK BINARY STAT DFHISRDS ISR_ALLOCATES_FAILED_LINK 4 DIFF No Number of allocations failed on link       32
ALLCFAILOTH BINARY STAT DFHISRDS ISR_ALLOCATES_FAILED_OTHER 4 DIFF No Number of allocations failed for other reasons       33
APPLID CHAR INQ IPCONN APPLID 8 DIFF No Remote application ID       2
AUTOCONNECT CVDAS INQ IPCONN AUTOCONNECT 4 LIKE No Autoconnect option       3
AUTOCONNECT Input/output valid values AUTOCONN, NONAUTOCONN
BASDEFINEVER BINARY CPSM     1 AVG No BAS resource definition version 0   E640 E650 58
CERTIFICATE CHAR INQ IPCONN CERTIFICATE 32 DIFF No Certificate       44
CHANGEAGENT CVDAS INQ IPCONN LINKAUTH 4 LIKE No Last modification agent     E640 E650 49
CHANGEAGENT Input/output valid values CSDAPI, CSDBATCH, DREPAPI, DREPBATCH, AUTOINSTALL, CREATESPI, NOTAPPLIC
CHANGEAGREL CHAR INQ IPCONN LINKAUTH 4 DIFF No Last modification agent release     E640 E650 51
CHANGETIME DATETIME INQ IPCONN LINKAUTH 8 MAX No Last modification time     E640 E650 52
CHANGEUSRID CHAR INQ IPCONN LINKAUTH 8 DIFF No Last modification user ID     E640 E650 50
CIPHERS CHAR INQ IPCONN CIPHERS 56 LIKE No SSL cipher suite codes       46
CLIENTLOC CHAR INQ IPCONN LINKAUTH 32 DIFF No Most diverse route to partner system     E640 E650 59
CONNSTATUS CVDAS INQ IPCONN CONNSTATUS 4 LIKE Yes Connection status       4
CONNSTATUS Input/output valid values ACQUIRED, RELEASED
CONNSTATUS Output valid values FREEING, OBTAINING
CRECVSESS BINARY STAT DFHISRDS ISR_CURRENT_RECEIVE_SESSIONS 4 DIFF No Number of receive sessions in use       27
CSENDSESS BINARY STAT DFHISRDS ISR_CURRENT_SEND_SESSIONS 4 DIFF No Number of send sessions in use       25
CURRQUEUED BINARY STAT DFHISRDS ISR_CURRENT_QUEUED_ALLOCATES 4 DIFF No Current number of allocates queued       30
DEFINESOURCE CHAR INQ IPCONN LINKAUTH 8 DIFF No Source of the resource definition     E640 E650 53
DEFINETIME DATETIME INQ IPCONN LINKAUTH 8 MAX No Creation time     E640 E650 54
EXITALLCPUR BINARY STAT DFHISRDS ISR_XISQUE_ALLOCS_PURGED 4 DIFF No Number of XISQUE allocates purged       39
EXITALLCQPUR BINARY STAT DFHISRDS ISR_XISQUE_ALLOC_QPURGES 4 DIFF No Number of XISQUE allocation queue purges       38
EXITALLCREJ BINARY STAT DFHISRDS ISR_XISQUE_ALLOC_REJECTS 4 DIFF No Number of XISQUE allocate rejections       37
FSFCBYTERECD BINARY STAT DFHISRDS ISR_FS_FC_BYTES_RECEIVED 8 AVG No Number of FC function shipped bytes received     E640 E650 E660 75
FSFCBYTESENT BINARY STAT DFHISRDS ISR_FS_FC_BYTES_SENT 8 AVG No Number of FC function shipped bytes sent     E640 E650 E660 74
FSFCREQS BINARY STAT DFHISRDS ISR_FS_FC_REQUESTS 4 AVG No Number of FC function shipped requests     E640 E650 E660 73
FSICBYTERECD BINARY STAT DFHISRDS ISR_FS_IC_BYTES_RECEIVED 8 AVG No Number of IC function shipped bytes received     E640 E650 69
FSICBYTESENT BINARY STAT DFHISRDS ISR_FS_IC_BYTES_SENT 8 AVG No Number of IC function shipped bytes sent     E640 E650 68
FSICREQS BINARY STAT DFHISRDS ISR_FS_IC_REQUESTS 4 DIFF No Number of IC function shipped requests     E640 E650 67
FSPCBYTERECD BINARY STAT DFHISRDS ISR_FS_PG_BYTES_RECEIVED 8 DIFF No Number of PC function shipped bytes received       20
FSPCBYTESENT BINARY STAT DFHISRDS ISR_FS_PG_BYTES_SENT 8 DIFF No Number of PC function shipped bytes sent       19
FSPGREQS BINARY STAT DFHISRDS ISR_FS_PG_REQUESTS 4 DIFF No Number of PC function shipped requests       41
FSTDBYTERECD BINARY STAT DFHISRDS ISR_FS_TD_BYTES_RECEIVED 8 AVG No Number of TD function shipped bytes received     E640 E650 E660 78
FSTDBYTESENT BINARY STAT DFHISRDS ISR_FS_TD_BYTES_SENT 8 AVG No Number of TD function shipped bytes sent     E640 E650 E660 77
FSTDREQS BINARY STAT DFHISRDS ISR_FS_TD_REQUESTS 4 AVG No Number of TD function shipped requests     E640 E650 E660 76
FSTSBYTERECD BINARY STAT DFHISRDS ISR_FS_TS_BYTES_RECEIVED 8 AVG No Number of TS function shipped bytes received     E640 E650 E660 81
FSTSBYTESENT BINARY STAT DFHISRDS ISR_FS_TS_BYTES_SENT 8 AVG No Number of TS function shipped bytes sent     E640 E650 E660 80
FSTSREQS BINARY STAT DFHISRDS ISR_FS_TS_REQUESTS 4 AVG No Number of TS function shipped requests     E640 E650 E660 79
GMTCTIME TIMESTP STAT DFHISRDS ISR_IPCONN_GMT_CREATE_TIME 8 MAX No GMT connection create time       23
GMTDTIME TIMESTP STAT DFHISRDS ISR_IPCONN_GMT_DELETE_TIME 8 MAX No GMT connection delete time       24
HA CVDAS INQ     4 LIKE No High availability status     E640 E650 E660 E670 E680 83
HA Output valid values REQUIRED, NOTREQUIRED
HOST CHAR INQ IPCONN HOST 116 DIFF No Remote host name       5
HOSTTYPE CVDAS INQ IPCONN LINKAUTH 4 LIKE No Host name's address format     E640 E650 63
HOSTTYPE Output valid values HOSTNAME, IPV4, IPV6, NOTAPPLIC
IDPROP CVDAS INQ IPCONN LINKAUTH 4 LIKE No Identity propagation     E640 E650 70
IDPROP Output valid values NOTALLOWED, OPTIONAL, REQUIRED
INSTALLAGENT CVDAS INQ IPCONN LINKAUTH 4 LIKE No Installation agent     E640 E650 57
INSTALLAGENT Input/output valid values CSDAPI, CREATESPI, AUTOINSTALL, GRPLIST
INSTALLTIME DATETIME INQ IPCONN LINKAUTH 8 MAX No Installation time     E640 E650 56
INSTALLUSRID CHAR INQ IPCONN LINKAUTH 8 DIFF No Installation user ID     E640 E650 55
IPFAMILY CVDAS INQ IPCONN LINKAUTH 4 LIKE No The format of the resolved IP address     E640 E650 62
IPFAMILY Output valid values IPV4, IPV6, UNKNOWN
IPRESOLVED CHAR INQ IPCONN LINKAUTH 39 DIFF No Remote host's IP address     E640 E650 61
LINKAUTH CVDAS INQ IPCONN LINKAUTH 4 LIKE No Link security       16
LINKAUTH Output valid values SECUSER, CERTUSER
LOCCTIME TIMESTP STAT DFHISRDS ISR_IPCONN_CREATE_TIME 8 MAX No Local connection create time       21
LOCDTIME TIMESTP STAT DFHISRDS ISR_IPCONN_DELETE_TIME 8 MAX No Local connection delete time       22
MAXQTIME BINARY INQ IPCONN MAXQTIME 4 DIFF No Maximum queue time NO     6
MIRRORLIFE CVDAS INQ IPCONN LINKAUTH 4 DIFF No Minimum mirror lifetime     E640 E650 E660 72
MIRRORLIFE Input/output valid values REQUEST, TASK, UOW
MQTALLPURG BINARY STAT DFHISRDS ISR_MAXQTIME_ALLOCS_PURGED 4 DIFF No Number of queue time allocates purged       36
MQTALLQPURG BINARY STAT DFHISRDS ISR_MAXQTIME_ALLOC_QPURGES 4 DIFF No Number of queue time allocation queue purges       35
 NAME-1  CHAR INQ IPCONN IPCONN 8 DIFF No IPIC connection ID       1
NETWORKID CHAR INQ IPCONN NETWORKID 8 DIFF No Remote network ID       15
NUMCIPHERS BINARY INQ IPCONN NUMCIPHERS 2 LIKE No Number of SSL cipher suite codes       45
PARTNER CHAR INQ IPCONN LINKAUTH 64 DIFF No Product token of partner system     E640 E650 60
PEAKQUEUED BINARY STAT DFHISRDS ISR_PEAK_QUEUED_ALLOCATES 4 DIFF No Number of peak queued session allocations       31
PENDSTATUS CVDAS INQ IPCONN PENDSTATUS 4 LIKE Yes Pending status       7
PENDSTATUS Input/output valid values PENDING, NOTPENDING
PORT BINARY INQ IPCONN PORT 4 DIFF No Port number       8
PRECVSESS BINARY STAT DFHISRDS ISR_PEAK_RECEIVE_SESSIONS 4 DIFF No Maximum number of receive sessions used       28
PSENDSESS BINARY STAT DFHISRDS ISR_PEAK_SEND_SESSIONS 4 DIFF No Maximum number of send sessions used       26
PURGETYPE CVDAS INQ     4 LIKE Yes Purge type       17
PURGETYPE Input/output valid values CANCEL, FORCECANCEL, FORCEPURGE, KILL, PURGE, N_A
QLIMALLOCREJ BINARY STAT DFHISRDS ISR_QLIMIT_ALLOC_REJECTS 4 DIFF No Number of queue limit allocate rejections       34
QUEUELIMIT BINARY INQ IPCONN QUEUELIMIT 4 DIFF No Queue limit       9
RECEIVECOUNT BINARY INQ DFHISRDS ISR_RECEIVE_SESSIONS 4 DIFF No Receive count       10
RECOVSTATUS CVDAS INQ IPCONN RECEIVECOUNT 4 LIKE Yes Recovery status       11
RECOVSTATUS Input/output valid values NORECOVDATA, NRS, RECOVDATA
REMTRMSTRT BINARY STAT DFHISRDS ISR_REMOTE_TERM_STARTS 4 AVG No Remote terminal starts     E640 E650 71
SECURITYNAME CHAR CPSM IPCONN SECURITYNAME 8 DIFF No Security name of the remote system       47
SENDCOUNT BINARY INQ DFHISRDS ISR_SEND_SESSIONS 4 DIFF No Send count   0-999   12
SERVSTATUS CVDAS INQ IPCONN SERVSTATUS 4 LIKE Yes Service status       13
SERVSTATUS Input/output valid values INSERVICE, OUTSERVICE
SSLTYPE CVDAS INQ IPCONN SSLTYPE 4 LIKE No Secure sockets layer (SSL) type       42
SSLTYPE Output valid values SSL, NOSSL, ATTLSAWARE
TCPIPSERVICE CHAR INQ IPCONN TCPIPSERVICE 8 DIFF No TCP/IP service       14
TOTALLOC BINARY STAT DFHISRDS ISR_TOTAL_ALLOCATES 4 DIFF No Total number of session allocations       29
TRANSATTCH BINARY STAT DFHISRDS ISR_TRANS_ATTACHED 4 DIFF No Number of transactions attached       40
TRBYTERECD BINARY STAT DFHISRDS ISR_TR_BYTES_RECEIVED 8 AVG No Number of TR function shipped bytes received     E640 E650 66
TRBYTESENT BINARY STAT DFHISRDS ISR_TR_BYTES_SENT 8 AVG No Number of TR function shipped bytes sent     E640 E650 65
TRREQS BINARY STAT DFHISRDS ISR_TR_REQUESTS 4 AVG No Number of TR function shipped requests     E640 E650 64
UNSUPREQS BINARY STAT DFHISRDS ISR_UNSUPPORTED_REQUESTS 4 AVG No Number of unsupported requests     E640 E650 E660 82
UOWACTION CVDAS INQ     4 LIKE Yes UOW Action       18
UOWACTION Input/output valid values BACKOUT, COMMIT, FORCE, RESYNC, N_A
USERAUTH CVDAS INQ IPCONN USERAUTH 4 LIKE No Attach-time user security level       43
USERAUTH Output valid values DEFAULTUSER, LOCAL, VERIFY, IDENTIFY