This CICS® resource object is the runtime object that represents a deployed platform.
The Primary key field for this resource class is PLATDEF.
The following actions
are supported:
- ADDBUNDLE
- Add a CICS bundle to the
platform.
- BUNDLEID
- CICS bundle ID of the CICS bundle to add to this platform.
- BUNDMAJORVER
- CICS bundle major version of the CICS bundle to add to the platform.
- BUNDMICROVER
- CICS bundle micro version of the CICS bundle to add to the platform.
- BUNDMINORVER
- CICS bundle minor version of the CICS bundle to add to the platform.
- REGIONTYPE
- Region type that the supplied CICS bundle should be installed into.
ADDREGION
- Add a CICS region to a
region type.
- APPLID
- APPLID of the CICS region to be added.
- CSYSDEF_NAME
- Name of the CICS system definition for the CICS region to be added.
- PRICMAS
- Primary CMAS for the CICS region to be added.
- REGIONTYPE
- Platform region type to which the CICS region will be added.
- SYSID
- SYSID of the CICS region to be added.
- DISABLE
- Disable a platform in the CICSplex.
- DISCARD
- Remove a platform from the CICSplex.
- ENABLE
- Enable a platform in the CICSplex.
- GET
- Retrieve information about a deployed platform.
- REMOVEBUNDLE
- Remove a CICS bundle from
the platform.
- BUNDLEID
- CICS bundle ID of the CICS bundle to be removed.
- BUNDMAJORVER
- CICS bundle major version of the CICS bundle to be removed.
- BUNDMICROVER
- CICS bundle micro version of the CICS bundle to be removed.
- BUNDMINORVER
- CICS bundle minor version of the CICS bundle to be removed.
- REGIONTYPE
- Platform region type where the CICS bundle will be removed.
- REMOVEREGION
- Remove a CICS region from
a region type.
- CSYSDEF_NAME
- Name of the CICS system definition for the CICS region to be removed.
- REGIONTYPE
- Platform region type from which the CICS region will be removed.
- External resource name
- CICSPlatform
- Length
- 760
- Usage
- API or CICS Management Client Interface
- API view
- Yes
- CMAS context
- No
- SCOPE applies
- Yes
- Only query CMASs in workload
- No
- Object type
- CICSPlex SM Manager
- Copybook identifier
- EYUt3526
| Operations | Actions | Parameters | Required |
|---|---|---|---|
| GET | None | N/A | |
| PERFORM SET | DISCARD | None | N/A |
| ENABLE | None | N/A | |
| DISABLE | None | N/A | |
| REMOVEBUNDLE | BUNDLEID(value) | Yes | |
| BUNDMAJORVER(value) | Yes | ||
| BUNDMICROVER(value) | Yes | ||
| BUNDMINORVER(value) | Yes | ||
| REGIONTYPE(value) | Yes | ||
| 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 | ||
| REMOVEREGION | CSYSDEF_NAME(value) | Yes | |
| REGIONTYPE(value) | Yes |
| 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 |
| Name | Datatype | Source | Len | Sum | Set | Description | Default | Attr ID |
|---|---|---|---|---|---|---|---|---|
| CHANGEAGENT | CVDAS | CPSM | 4 | LIKE | No | Last modification agent | 3 | |
| CHANGEAGENT Input/output valid values | DREPAPI | |||||||
| CHANGEAGREL | CHAR | CPSM | 4 | DIFF | No | Last modification agent release | 7 | |
| CHANGETIME | DATETIME | CPSM | 8 | MAX | No | Last modification | 5 | |
| CHANGEUSRID | CHAR | CPSM | 8 | DIFF | No | Last modification user ID | 6 | |
| CREATETIME | DATETIME | CPSM | 8 | MAX | No | Time created | 4 | |
| DESCCODEPAGE | BINARY | CPSM | 4 | MAX | No | Description code page | 37 | 16 |
| DESCRIPTION | CHAR | CPSM | 255 | DIFF | Yes | Description of this platform | 12 | |
| ENABLESTATUS | EYUDA | CPSM | 4 | LIKE | No | Enable Status | 18 | |
| ENABLESTATUS Input/output valid values | ENABLED, DISABLED, ENABLING, DISABLING, INCOMPLETE, EMPTY, SOMEDISABLED, INSTALLING, DISCARDING, FAILED | |||||||
| PLATDEF-1 | CHAR | CPSM | 8 | DIFF | Yes | Platform definition | 10 | |
| PLATDIR | CHAR | CPSM | 255 | DIFF | No | Platform bundle directory | 13 | |
| PLATFORM | CHAR | CPSM | 64 | DIFF | Yes | Platform | 15 | |
| PLATHOME | CHAR | CPSM | 128 | DIFF | No | Platform home directory | 14 | |
| STATUS | EYUDA | CPSM | 4 | LIKE | No | Status | 11 | |
| STATUS Input/output valid values | ACTIVE, PARTIAL, INACTIVE | |||||||
