IBM CICS Configuration Manager for z/OS

https://www.ibm.com/docs/en/cics-cm
Admin
IBM CICS Configuration Manager for z/OS is a configuration management solution for IBM's CICS...
Tokens:512,024
Snippets:4,280
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Single Program to All Remote CICS Connections

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

This example demonstrates installing a single program (DFH$SXP1) to all active remote system connections defined in the CICS configuration. It includes options to quiesce and discard.

```xml
<CCV540>
  <Install>

    <LocationCriteria>
      <LocationName> QAACSD22 </LocationName>
      <LocationType> CCONFIG </LocationType>
    </LocationCriteria>

    <ObjectCriteria>
      <Listcount> 1 </Listcount>
      <ListElement>
        <ObjName> DFH$SXP1 </ObjName>
        <ObjGroup> DFH$SXP </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
    </ObjectCriteria>

    <ProcessParms>
      <Quiesce> YES </Quiesce>
      <Discard> NO </Discard>
    </ProcessParms>

  </Install>
</CCV540>
```

--------------------------------

### Install Single Program via All Remote Connections

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-install

This example shows how to install a single program into CICS regions using all defined remote system connections. It utilizes the `<Install>` element with `<LocationCriteria>` and `<ObjectCriteria>` for the program details. The `<ProcessParms>` section does not specify individual connections, implying all available connections will be used.

```xml
<CCV530>
  <Install>
    <LocationCriteria>
      <LocationName> QAACSD22 </LocationName>
      <LocationType> CCONFIG </LocationType>
    </LocationCriteria>
    <ObjectCriteria>
      <Listcount> 1 </Listcount>
      <ListElement>
        <ObjName> DFH$SXP1 </ObjName>
        <ObjGroup> DFH$SXP </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
    </ObjectCriteria>
    <ProcessParms>
      <Quiesce> YES </Quiesce>
      <Discard> NO </Discard>
    </ProcessParms>
  </Install>
</CCV530>
```

--------------------------------

### Install Multiple Programs to Specific CICS Regions

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

This example shows how to install three programs (DFH$AALL, ACCT00, DFH$AREP) into two CICS regions (QAACSD22 via T22T and T13T connections). It specifies the program details and connection parameters for the installation.

```xml
<CCV540>
  <Install>

    <LocationCriteria>
      <LocationName> QAACSD22 </LocationName>
      <LocationType> CCONFIG </LocationType>
    </LocationCriteria>

    <ObjectCriteria>
      <Listcount> 3 </Listcount>
      <ListElement>
        <ObjName> DFH$AALL </ObjName>
        <ObjGroup> DFH$AFLA </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
      <ListElement>
        <ObjName> ACCT00 </ObjName>
        <ObjGroup> DFH$ACCT </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
      <ListElement>
        <ObjName> DFH$AREP </ObjName>
        <ObjGroup> DFH$AFLA </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
    </ObjectCriteria>

    <ProcessParms>
      <Quiesce> No </Quiesce>
      <Discard> No </Discard>
      <CSDPARMS>
        <CONNECTIONCOUNT> 2 </CONNECTIONCOUNT>
         <CONNECTIONELEMENT>
          <CONNECTIONNAME> T22T </CONNECTIONNAME>
         </CONNECTIONELEMENT>
         <CONNECTIONELEMENT>
          <CONNECTIONNAME> T13T </CONNECTIONNAME>
         </CONNECTIONELEMENT>
      </CSDPARMS>
    </ProcessParms>

  </Install>
</CCV540>
```

--------------------------------

### Install Multiple Programs in Specific CICS Regions

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-install

This example demonstrates how to install multiple programs into two specified CICS regions. It uses the `<Install>` element with `<LocationCriteria>` to select the target region and `<ObjectCriteria>` to list the programs to be installed. The `<CSDPARMS>` section specifies the remote system connections.

```xml
<CCV530>
  <Install>
    <LocationCriteria>
      <LocationName> QAACSD22 </LocationName>
      <LocationType> CCONFIG </LocationType>
    </LocationCriteria>
    <ObjectCriteria>
      <Listcount> 3 </Listcount>
      <ListElement>
        <ObjName> DFH$AALL </ObjName>
        <ObjGroup> DFH$AFLA </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
      <ListElement>
        <ObjName> ACCT00 </ObjName>
        <ObjGroup> DFH$ACCT </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
      <ListElement>
        <ObjName> DFH$AREP </ObjName>
        <ObjGroup> DFH$AFLA </ObjGroup>
        <ObjType> PROGDEF </ObjType>
      </ListElement>
    </ObjectCriteria>
    <ProcessParms>
      <Quiesce> No </Quiesce>
      <Discard> No </Discard>
      <CSDPARMS>
        <CONNECTIONCOUNT> 2 </CONNECTIONCOUNT>
         <CONNECTIONELEMENT>
          <CONNECTIONNAME> T22T </CONNECTIONNAME>
         </CONNECTIONELEMENT>
         <CONNECTIONELEMENT>
          <CONNECTIONNAME> T13T </CONNECTIONNAME>
         </CONNECTIONELEMENT>
      </CSDPARMS>
    </ProcessParms>
  </Install>
</CCV530>
```

--------------------------------

### INSTALL Command Parameters

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=batch-install

This section details the parameters available for the INSTALL command in CICS Configuration Manager, used for installing change packages.

```APIDOC
## POST /websites/ibm_en_cics-cm

### Description
This endpoint documents the parameters for the INSTALL command used in CICS Configuration Manager to install change packages. It outlines various options for migration schemes, data qualifications, and target scope definitions.

### Method
POST

### Endpoint
/websites/ibm_en_cics-cm

### Parameters
#### Query Parameters
- **CPID** (string) - Required - The change package identifier.
- **EXTREF** (string) - Required - The external reference for the change package.
- **SCHEME** (string) - Optional - The migration scheme to be used.
- **DATA** (string) - Optional - Qualification exit data for the install action. Used only if an active operations qualification exit (OPQAIN01) is configured.
- **QUIESCE** (boolean) - Optional - Specifies whether to quiesce the target system.
- **DISCARD** (boolean) - Optional - Specifies whether to discard resources.
- **EXITDATE** (date) - Optional - The date for the exit condition.
- **EXITTEXT** (string) - Optional - Text associated with the exit condition.
- **NOCONNECTION** (enum: IGNORE) - Optional - Specifies to ignore processing for unavailable remote connections. If omitted, unavailable connections are processed, resulting in errors and audit logging.
- **DELETEDISCARD** (boolean) - Optional - Applies only to CSD-based configurations when DISCARD=YES. Specifies whether to include resources marked for deletion within the target configuration for discard processing. Ignored for CICSPlex SM context configurations or when DISCARD=NO.
- **TARGETSCOPE** (string) - Required if the change package contains candidates for migration to context-based target CICS configurations. Specifies the target scope for the migration.
- **FILE** (object) - Optional - Specifies parameters related to file installations.
  - **RSCOPE** (string) - Optional - Resource scope for the file.
  - **USAGE** (enum: LOCAL, REMOTE) - Optional - Usage type for the file (LOCAL or REMOTE).
- **PROGRAM** (object) - Optional - Specifies parameters related to program installations.
  - **RSCOPE** (string) - Optional - Resource scope for the program.
  - **USAGE** (enum: LOCAL, REMOTE) - Optional - Usage type for the program.
  - **MODE** (string) - Optional - Mode for program installation.
- **TDQUEUE** (object) - Optional - Specifies parameters related to TDQUEUE installations.
  - **RSCOPE** (string) - Optional - Resource scope for the TDQUEUE.
  - **USAGE** (enum: LOCAL, REMOTE) - Optional - Usage type for the TDQUEUE.
  - **MODE** (string) - Optional - Mode for TDQUEUE installation.
- **TRANSACTION** (object) - Optional - Specifies parameters related to transaction installations.
  - **RSCOPE** (string) - Optional - Resource scope for the TRANSACTION.
  - **USAGE** (enum: LOCAL, REMOTE) - Optional - Usage type for the TRANSACTION.
  - **MODE** (string) - Optional - Mode for TRANSACTION installation.
- **CONNECTION** (object) - Optional - Specifies parameters related to connection installations.
  - **REFASSGN** (string) - Required - Reference assignment for the connection.

### Request Example
```json
{
  "CPID": "change_package",
  "EXTREF": "external_reference",
  "SCHEME": "migration_scheme",
  "DATA": "qualification_exit_data",
  "QUIESCE": true,
  "DISCARD": false,
  "EXITDATE": "2023-10-27",
  "EXITTEXT": "Example exit text",
  "NOCONNECTION": "IGNORE",
  "DELETEDISCARD": true,
  "TARGETSCOPE": "target_scope",
  "FILE": {
    "RSCOPE": "scope",
    "USAGE": "REMOTE"
  },
  "PROGRAM": {
    "RSCOPE": "scope",
    "USAGE": "REMOTE",
    "MODE": "mode"
  },
  "TDQUEUE": {
    "RSCOPE": "scope",
    "USAGE": "REMOTE",
    "MODE": "mode"
  },
  "TRANSACTION": {
    "RSCOPE": "scope",
    "USAGE": "REMOTE",
    "MODE": "mode"
  },
  "CONNECTION": {
    "REFASSGN": "refassgn"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the installation request.
- **message** (string) - Provides details about the installation process or any encountered issues.

#### Response Example
```json
{
  "status": "success",
  "message": "Change package 'change_package' installed successfully."
}
```
```

--------------------------------

### Install Individual Resource Definition

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

Installs an individual resource definition by specifying its name, type, and group. This is an extension of the resource group installation where only a single resource is targeted.

```APIDOC
## POST /websites/ibm_en_cics-cm/install/resource

### Description
Installs an individual resource definition.

### Method
POST

### Endpoint
/websites/ibm_en_cics-cm/install/resource

### Parameters
#### Request Body
- **resourceName** (string) - Required - The name of the resource definition.
- **resourceType** (string) - Required - The type of the resource definition (e.g., PROGRAM, TRANSACTION).
- **resourceGroup** (string) - Required - The group the resource definition belongs to.
- **connectionCount** (string) - Optional - Specifies the CSD-based CICS regions for the action. Accepts 'All', 'Local', or 'element_count'.
- **connectionElements** (array) - Optional - Required if connectionCount is 'element_count'. Each element refers to a remote system connection.
- **locationName** (string) - Optional - Required if connectionCount is 'Local'. Specifies a CICS configuration.

### Request Example
```json
{
  "resourceName": "MY_PROGRAM",
  "resourceType": "PROGRAM",
  "resourceGroup": "MY_RESOURCE_GROUP"
}
```

### Response
#### Success Response (200)
- **outputData** (object) - Contains the installation results.
  - **returnCode** (string) - The return code of the installation operation.
  - **reasonCode** (string) - The reason code for the return code.
  - **taskNo** (string) - The CICS task number.
  - **listCount** (string) - The number of resource definitions processed.
  - **listElement** (array) - Details for the installed resource definition.

#### Response Example
```json
{
  "outputData": {
    "returnCode": "00",
    "reasonCode": "000",
    "taskNo": "12347",
    "listCount": "1",
    "listElement": [
      {
        "returnCode": "00",
        "reasonCode": "000",
        "objName": "MY_PROGRAM",
        "objType": "PROGRAM",
        "objGroup": "MY_RESOURCE_GROUP",
        "config": "CICSPROD",
        "locationName": "CSD.MY.FILE"
      }
    ]
  }
}
```
```

--------------------------------

### List PROGDEF Resources by Name, Group, and Attributes

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-list

This example lists PROGDEF resource definitions that match specific criteria: a name starting with 'Q', belonging to group 'QAACRE01', and having CEDF='YES', DATALOCATION='BELOW', and EXECKEY='USER'. It uses XML format for the API request.

```xml
<CCV530>
<LIST>

  <LocationCriteria>
    <LocationName> CCVPLEXD </LocationName>
    <LocationType> CONTEXT </LocationType>
  </LocationCriteria>

  <ObjectCriteria>
    <ObjName> Q* </ObjName>
    <ObjGroup> QAACRE01 </ObjGroup>
    <ObjType> PROGDEF </ObjType>
  </ObjectCriteria>

  <RestrictionCriteria>
  <ListCount> 3 </ListCount>
  <ListElement>
    <RestrictionField> CEDF </RestrictionField>
    <RestrictionOperator> = </RestrictionOperator>
    <RestrictionValue> YES </RestrictionValue>
  </ListElement>
  <ListElement>
    <RestrictionField> DATALOCATION </RestrictionField>
    <RestrictionOperator> = </RestrictionOperator>
    <RestrictionValue> BELOW </RestrictionValue>
  </ListElement>
  <ListElement>
    <RestrictionField> EXECKEY </RestrictionField>
    <RestrictionOperator> = </RestrictionOperator>
    <RestrictionValue> USER </RestrictionValue>
  </ListElement>
  </RestrictionCriteria>

</LIST>
</CCV530>
```

--------------------------------

### Install Resource Group

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

Installs an entire group of resource definitions by specifying the group name and setting the resource type to ResGroup. The `<ObjGroup>` element is ignored when the resource type is ResGroup.

```XML
<CCV540>
  <Install>
    <InputData>
      <ResourceName>group_name</ResourceName>
      <ResourceType>ResGroup</ResourceType>
    </InputData>
  </Install>
</CCV540>
```

--------------------------------

### List READYLST Resources for Change Packages

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-list

This example shows how to list candidate resource definitions for a specific change package and migration scheme. It targets READYLST objects and specifies criteria like CPID and Scheme.

```xml
<CCV540>
  <LIST>
    <LocationCriteria>
      <LocationType> REPOSITORY </LocationType>
    </LocationCriteria>
    <ObjectCriteria>
      <ObjType> READYLST </ObjType>
      <CPID> 00000015 </CPID>
      <Scheme> PJCTEST </Scheme>
    </ObjectCriteria>
    <ProcessParms>
      <HashingScope> FULL </HashingScope>
    </ProcessParms>
  </LIST>
</CCV540>
```

--------------------------------

### SOAP API Reference - Install Operation

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

The Install command dynamically makes resource definitions available to an active CICS® region. It supports two formats: for resource definitions in a change package, and for ad hoc selection.

```APIDOC
## POST /<webservice_endpoint>/install

### Description
Dynamically makes resource definitions available to an active CICS® region.
This command has two formats:
  * For resource definitions that are in a change package
  * For ad hoc selection of resource definitions

### Method
POST

### Endpoint
/<webservice_endpoint>/install

### Parameters
#### Request Body
- **resourceDefinitions** (array of objects) - Required - The definitions of the resources to be installed.
  - **packageName** (string) - Optional - The name of the change package containing the resource definitions.
  - **resourceName** (string) - Optional - The name of the individual resource definition to install.
  - **resourceType** (string) - Optional - The type of the resource definition.

### Request Example
```json
{
  "resourceDefinitions": [
    {
      "packageName": "MYPACKAGE",
      "resourceName": "MYTRAN",
      "resourceType": "TRANSACTION"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - Provides details about the operation result.

#### Response Example
```json
{
  "status": "Success",
  "message": "Resource definitions installed successfully."
}
```
```

--------------------------------

### List READYLST Resource Definitions

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-list

This example shows how to list READYLST resource definitions that are candidates for a particular change package and migration scheme.

```APIDOC
## POST /websites/ibm_en_cics-cm

### Description
This endpoint allows you to list READYLST resource definitions that are associated with a specific change package and migration scheme. It also allows for specifying a hashing scope.

### Method
POST

### Endpoint
/websites/ibm_en_cics-cm

### Request Body
```xml
<CCV530>
  <LIST>
    <LOCATIONCRITERIA>
      <LOCATIONTYPE> REPOSITORY </LOCATIONTYPE>
    </LOCATIONCRITERIA>
    <OBJECTCRITERIA>
      <OBJTYPE> READYLST </OBJTYPE>
      <CPID> 00000015 </CPID>
      <SCHEME> PJCTEST </SCHEME>
    </OBJECTCRITERIA>
    <PROCESSPARMS>
      <HASHINGSCOPE> FULL </HASHINGSCOPE>
    </PROCESSPARMS>
  </LIST>
</CCV530>
```

### Response
#### Success Response (200)
This will return a list of READYLST resource definitions that are candidates for the specified change package and migration scheme. The exact structure of the response will depend on the specific resource definitions found.

#### Response Example
(Response body will contain XML describing the matched READYLST resources)
```

--------------------------------

### CICS Administrator Permissions for Installing Change Packages

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=definitions-example-security-scenario

Defines permissions for CICS administrators to install change packages into production environments. This is a critical step in the deployment process, ensuring that only authorized personnel can deploy changes. The example does not provide specific code but implies the need for 'Install' permissions.

```z/OS RACF
# Placeholder for Install command permissions
# Example: CCVAPI.INS.*.PRODUCTION.ENVIRONMENT
```

--------------------------------

### List READYLST Resources by Change Package and Migration Scheme

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-list

This example lists READYLST resource definitions that are candidates for a specific change package ('00000015') and migration scheme ('PJCTEST'). The request is made using XML format.

```xml
<CCV530>
  <LIST>
    <LOCATIONCRITERIA>
      <LOCATIONTYPE> REPOSITORY </LOCATIONTYPE>
    </LOCATIONCRITERIA>
    <OBJECTCRITERIA>
      <OBJTYPE> READYLST </OBJTYPE>
      <CPID> 00000015 </CPID>
      <SCHEME> PJCTEST </SCHEME>
    </OBJECTCRITERIA>
    <PROCESSPARMS>
      <HASHINGSCOPE> FULL </HASHINGSCOPE>
    </PROCESSPARMS>
  </LIST>
</CCV530>
```

--------------------------------

### CICS Event Start Types (XML)

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=objects-eventstart

This snippet illustrates the possible values for the event start type within CICS journal objects. These types indicate the nature of the event being logged, such as online edits, migrations, backouts, or installations.

```XML
<ES_EventType> ONLINEEDIT | MIGRATE | BACKOUT | INSTALL </ES_EventType>
```

--------------------------------

### Example DEPLOY Command for Candidate Resource Comparison

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=definitions-deploy

This example demonstrates a DEPLOY command used to compare two sets of candidate resource definitions. It shows how to collect definitions from both CSD files and CICSPlex SM contexts for test and production environments, using REPORTSET to group collection phases.

```JCL
DEPLOY PHASE=COLLECT,REPORTSET=1,
         TYPE=CANDIDATES,CONFIGURATION=TESTCSD1,GRPLIST=DFHLIST,LOCALSYSID=TST1,
       PHASE=COLLECT,REPORTSET=1,
         TYPE=CANDIDATES,CONFIGURATION=TESTPLX1,SCOPE=TEST1,
       PHASE=COLLECT,REPORTSET=2,
         TYPE=CANDIDATES,CONFIGURATION=PRODCSD1,GRPLIST=DFHLIST,LOCALSYSID=PRD1,
       PHASE=COLLECT,REPORTSET=2,
         TYPE=CANDIDATES,CONFIGURATION=PRODPLX1,SCOPE=PROD1,
       PHASE=REPORT,TYPE=CANDIDATESCOMPARE

```

--------------------------------

### Remove CCVSCRPT from TSO/E authorization lists

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=v52-removing-authorization-from-passticket-program-libraries

This snippet shows how to remove the CCVSCRPT program from the AUTHPGM and AUTHTSF lists within the SYS1.PARMLIB member IKJTSOxx. These lists control which programs are authorized when started via CALL command or TSO/E service facility, respectively. The example assumes SYS1.PARMLIB is the correct parmlib name and IKJTSOxx is the relevant member.

```jcl
AUTHPGM NAMES(...CCVSCRPT...)
AUTHTSF NAMES(...CCVSCRPT...)
```

--------------------------------

### Dynamically Set CSD File Strings in CICS

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=region-edit-cics-sit-parameters

This example shows how to dynamically adjust the number of strings for a CSD file using an EXEC CICS SET FILE command. This is useful for resolving CSD RDO exceptions related to insufficient VSAM strings without requiring a CICS cold or initial start. The `value` should be set according to monitoring and error messages.

```cobol
EXEC CICS SET FILE(DFHCSD) STRINGS(value) END-EXEC
```

--------------------------------

### CICS SIT GRPLIST Parameter Example

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=definitions-deploy

Example of a CICS System Initialization Table (SIT) GRPLIST parameter specifying a sequence of lists and a wildcard for group collection. This demonstrates how runtime definitions are typically configured.

```JCL
GRPLIST=(DFHLIST,LISTA,LISTB,LISTC*)
```

--------------------------------

### CICS-CM Ad Hoc Installation Request Format

Source: https://www.ibm.com/docs/en/cics-cm/5.4_topic=reference-install

This XML structure is used for ad hoc installations in CICS-CM, allowing for specific object installations based on location and object criteria. It supports defining connection parameters for CSD (Customer System Definition) and other processing options.

```xml
<CCV540>
    <Install>
        <LocationCriteria>
            <LocationName> CICS_configuration </LocationName>
            <LocationType> CConfig </LocationType>
        </LocationCriteria>
        <ObjectCriteria>
            <ListCount> element_count </ListCount>
            <ListElement>
                <ObjName> resource_name </ObjName>
                <ObjType> resource_type </ObjType>
                <ObjGroup> resource_group </ObjGroup>
            </ListElement>
        </ObjectCriteria>
        <ProcessParms>
            <Quiesce> No | Yes </Quiesce>
            <QualificationData> exit-data </QualificationData>
            <Discard> No | Yes </Discard>
            <CSDParms>
                <ConnectionCount> All | element_count | Local </ConnectionCount>
                <ConnectionElement>
                    <ConnectionName> remote_system_connection </ConnectionName>
                </ConnectionElement>
            </CSDParms>
            <Force> No | Yes </Force>
        </ProcessParms>
    </Install>
</CCV540>
```

--------------------------------

### Ready Command - Request and Response Formats (XML)

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-ready

This snippet shows the XML structure for the 'Ready' command request and its corresponding response. The request specifies the change package ID and migration scheme. The response provides return codes, reason codes, and the CICS task number.

```xml
<CCV530>
  <Ready>
    <SelectionCriteria>
      <CPID> change_package_ID </CPID>
      <Scheme> migration_scheme </Scheme>
    </SelectionCriteria>
  </Ready>
</CCV530>
```

```xml
<CCV530>
  <Ready>
    <OutputData>
      <ReturnCode> return_code </ReturnCode>
      <ReasonCode> reason_code </ReasonCode>
      <TaskNo> CICS_task_number </TaskNo>
    </OutputData>
  </Ready>
</CCV530>
```

--------------------------------

### Install Change Package

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=reference-install

Installs a CICS change package by specifying selection criteria and processing parameters.

```APIDOC
## POST /websites/ibm_en_cics-cm/install/changepackage

### Description
Installs a CICS change package by specifying selection criteria (CPID, Scheme) and processing parameters (Quiesce, QualificationData, Discard, Force, CICSPlex SM parameters).

### Method
POST

### Endpoint
/websites/ibm_en_cics-cm/install/changepackage

### Parameters
#### Request Body
- **CPID** (string) - Required - The ID of the change package.
- **Scheme** (string) - Required - The migration scheme for the change package.
- **Quiesce** (string) - Optional - 'Yes' or 'No'. Specifies whether to quiesce resources before installation.
- **QualificationData** (string) - Optional - Data for the Install operations qualification exit point.
- **Discard** (string) - Optional - 'Yes' or 'No'. Specifies whether to discard existing resource definitions before installation.
- **Force** (string) - Optional - 'Yes' or 'No'. Context-based CICS configurations only.
- **CPSMParms** (object) - Optional - CICSPlex SM parameters.
  - **TargetScope** (string) - Optional - Target scope for CICSPlex SM parameters.
  - **ResGroupObjectType** (string) - Optional - Resource group object type (* or resource_type).
  - **CONNDEF** (object) - Optional - Connection definition parameters.
    - **RefAssign** (string) - Optional - Resource assignment for connection definition.
  - **FILEDEF** (object) - Optional - File definition parameters.
    - **RelatedScope** (string) - Optional - Related scope for file definition.
    - **Usage** (string) - Optional - Usage (LOCAL | REMOTE).
  - **PROGDEF** (object) - Optional - Program definition parameters.
    - **RelatedScope** (string) - Optional - Related scope for program definition.
    - **Usage** (string) - Optional - Usage (LOCAL | REMOTE).
    - **Mode** (string) - Optional - Mode (N/A | AUTO).
  - **TDQDEF** (object) - Optional - Transient data queue definition parameters.
    - **RelatedScope** (string) - Optional - Related scope for TDQ definition.
    - **Usage** (string) - Optional - Usage (LOCAL | REMOTE).
    - **Mode** (string) - Optional - Mode (N/A | IND | INTRA | EXTRA).
  - **TRANDEF** (object) - Optional - Transaction definition parameters.
    - **RelatedScope** (string) - Optional - Related scope for transaction definition.
    - **Usage** (string) - Optional - Usage (LOCAL | REMOTE).
    - **Mode** (string) - Optional - Mode (N/A | DYNAM | STAT).

### Request Example
```json
{
  "CPID": "change_package_ID",
  "Scheme": "migration_scheme",
  "Quiesce": "No",
  "Discard": "Yes",
  "CPSMParms": {
    "TargetScope": "target_scope"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A message detailing the result of the installation.

#### Response Example
```json
{
  "status": "success",
  "message": "Change package installed successfully."
}
```
```

--------------------------------

### Execute CICS Configuration Manager REXX Program

Source: https://www.ibm.com/docs/en/cics-cm/5.3_topic=interface-static-setup

This REXX command executes the CICS Configuration Manager REXX program, optionally specifying a language parameter. Ensure the CCVOREXX program is accessible in your SYSEXEC or SYSPROC concatenation.

```REXX
%CCVOREXX 'NODYNAM lang'
```
Tokens:
Raw