PLATFORM Resource Table

This CICS® Resource is the runtime resource that represents a deployed platform.

The First key field for this resource is PLATDEF.

The following actions are supported:
ADDBUNDLE
Add a CICS bundle to the platform.
The parameter data for the ADDBUNDLE action is: 
   PARM('BUNDLEID(bundleid) BUNDMAJORVER(major) 
         BUNDMICROVER(micro) BUNDMINORVER(minor) REGIONTYPE(regiontype).')

     where:
     
     bundleid   = Bundle ID of the bundle to add to this platform.
     major      = Major version of the bundle.
     minor      = Minor version of the bundle.
     micro      = Micro version of the bundle.
     regiontype = Region type to install into.
ADDREGION
Add a CICS region to a region type.
The parameter data for the ADDREGION action is: 
   PARM('CSYSDEF_NAME(name) REGIONTYPE(regiontype)
         APPLID(applid) PRICMAS(cmas) SYSID(sysid).')

     where:
     
     name       = Name of the CICS system definition.
     regiontype = Region type to install into.
     cmas       = Primary CMAS for the CICS region.
     applid     = APPLID of the CICS region.
     sysid      = SYSID of the CICS region.
DISABLE
Disable a platform in the CICSplex.
DISCARD
Remove a platform from the CICSplex.
ENABLE
Enable a platform in the CICSplex.
REMOVEBUNDLE
Remove a CICS bundle from the platform.
The parameter data for the REMOVEBUNDLE action is: 
   PARM('BUNDLEID(bundleid) BUNDMAJORVER(major) 
         BUNDMICROVER(micro) BUNDMINORVER(minor) REGIONTYPE(regiontype).')

     where:
     
     bundleid   = Bundle ID of the bundle to remove.
     major      = Major version of the bundle.
     minor      = Minor version of the bundle.
     micro      = Micro version of the bundle.
     regiontype = Region type to remove from.
REMOVEREGION
Remove a CICS region from a region type.
The parameter data for the REMOVEREGION action is: 
   PARM('CSYSDEF_NAME(name) REGIONTYPE(regiontype).')

     where:
     
     name       = Name of the CICS system definition.
     regiontype = Region type to remove from.

External resource name(CMCI)
CICSPlatform
Object type
CICSPlex SM Resource
Length
760
Usage
API, CICS Management Client Interface(CMCI)
API view
Yes
CMAS context
No
SCOPE applies
Yes
Only query CMASs in workload
No
Copybook identifier
EYUt3526
Security Class
CLOUD.PLATFORM
Unsupported CICS Releases
None
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   None N/A
PERFORM SET, PERFORM OBJECT ADDBUNDLE BUNDLEID(value) Yes
    BUNDMAJORVER(value) Yes
    BUNDMICROVER(value) Yes
    BUNDMINORVER(value) Yes
    REGIONTYPE(value) Yes
  ADDREGION APPLID(value) No
    CSYSDEF_NAME(value) Yes
    PRICMAS(value) No
    REGIONTYPE(value) Yes
    SYSID(value) No
  DISABLE None N/A
  DISCARD None N/A
  ENABLE None N/A
  REMOVEBUNDLE BUNDLEID(value) Yes
    BUNDMAJORVER(value) Yes
    BUNDMICROVER(value) Yes
    BUNDMINORVER(value) Yes
    REGIONTYPE(value) Yes
  REMOVEREGION CSYSDEF_NAME(value) Yes
    REGIONTYPE(value) Yes
Table 2. PLATFORM FEEDBACK error codes
Value Code Description
1 PLATFORM_REC_NOT_FOUND Platform not found
2 PLATFORM_CONTAINS_APPLICATIONS Applications are installed in this Platform
3 PLATFORM_DISABLED_SOME_BUNDLES CICS bundles were not disabled in some regions
4 PLATFORM_DISCARDED_SOME_BUNDS CICS bundles were not discarded in some regions
5 PLATFORM_DISCARDED_NO_BUNDLES CICS bundles were not discarded in any regions
6 PLATFORM_ENABLED_SOME_BUNDLES CICS bundles were not enabled in some regions
7 PLATFORM_ENABLED_NO_BUNDLES CICS bundles were not enabled in any regions
8 PLATFORM_DISABLED_NO_BUNDLES CICS bundles were not disabled in any regions
11 PLATFORM_BUNDLE_NOT_FOUND CICS bundle was not found
12 PLATFORM_RGNTYPE_INVALID Invalid region type
13 PLATFORM_BUNDLE_ID_INVALID Invalid CICS bundle ID
17 PLATFORM_REGION_ACTIVE Region is active
18 PLATFORM_CONTEXT_INVALID CICSplex not found
19 PLATFORM_APPLID_INVALID Invalid VTAM APPLID
20 PLATFORM_SYSID_INVALID Invalid system ID
21 PLATFORM_PRIMARY_CMAS_INVALID Invalid primary CMAS
22 PLATFORM_REGION_INVALID CICS region could not be created
23 PLATFORM_RGNTYPE_NOT_FOUND Requested region type not found
24 PLATFORM_DUPLICATE_REGION Duplicate CICS region exists
25 PLATFORM_CSYSGRP_EXISTS VTAM APPLID matches an existing group definition
26 PLATFORM_REGION_NOT_FOUND Requested region not found
27 PLATFORM_RECORD_EXISTS The CICS bundle already exists in the region type
28 PLATFORM_INSTALLED_SOME_BUNDS CICS bundles were not installed in some regions
29 PLATFORM_INSTALLED_NO_BUNDLES CICS bundles were not installed in any regions
30 PLATFORM_BUSY Platform is busy for another action.
31 PLATFORM_NOT_DISABLED At least one installed bundle is enabled.
32 PLATFORM_BUNDLE_NOT_DISABLED At least one installed bundle is enabled.
33 PLATFORM_ADDBUNDLE_FAILED Platform ADDBUNDLE request failed.
34 PLATFORM_BUNDLE_MAJVER_INVALID Invalid CICS bundle major version
35 PLATFORM_BUNDLE_MINVER_INVALID Invalid CICS bundle minor version
36 PLATFORM_BUNDLE_MICVER_INVALID Invalid CICS bundle micro version
37 PLATFORM_PLATDEF_INVALID Invalid platform definition
38 PLATFORM_CREATED_REGION_ACTIVE A created region was still active.
39 PLATFORM_CREATED_REGION_IN_USE A created region was still in use by Business Application Services (BAS).
40 PLATFORM_RTYPE_IN_USE A region type was still in use by Business Application Services (BAS).
41 PLATFORM_CSYSDEF_NAME_INVALID Invalid CSYSDEF name
42 PLATFORM_INCOMPAT_REGION Incompatible region
43 PLATFORM_REGION_NOT_IN_RTYPE Region not in Region Type
44 PLATFORM_STATUS_FAILED Platform in failed state
Table 3. PLATFORM resource table attributes
Name Datatype Source Len Sum Description Default Value Range Offset
 PLATDEF-1  CHAR CPSM 8 DIFF Platform definition     36
CHANGEAGENT CVDAS CPSM 4 LIKE Last modification agent     8
CHANGEAGENT Input/output valid values
  • DREPAPI
CHANGEAGREL CHAR CPSM 4 DIFF Last modification agent release     32
CHANGETIME DATETIME CPSM 8 MAX Last modification     0
CHANGEUSRID CHAR CPSM 8 DIFF Last modification user ID     24
CREATETIME DATETIME CPSM 8 MAX Time created     16
DESCCODEPAGE BINARY CPSM 4 MAX Description code page 37 0-99999999 752
DESCRIPTION CHAR CPSM 255 DIFF Description of this platform     48
ENABLESTATUS EYUDA CPSM 4 LIKE Enable Status     756
ENABLESTATUS Input/output valid values
  • ENABLED
  • DISABLED
  • ENABLING
  • DISABLING
  • INCOMPLETE
  • EMPTY
  • SOMEDISABLED
  • INSTALLING
  • DISCARDING
  • FAILED
PLATDIR CHAR CPSM 255 DIFF Platform bundle directory     303
PLATFORM CHAR CPSM 64 DIFF Platform     686
PLATHOME CHAR CPSM 128 DIFF Platform home directory     558
STATUS EYUDA CPSM 4 LIKE Status     44
STATUS Input/output valid values
  • ACTIVE
  • PARTIAL
  • INACTIVE