CICS Transaction Server Configuration Tool

https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x
Admin
CICS Transaction Server configuration tool is an IBM tool for configuring CICS regions using schemas...
Tokens:17,259
Snippets:137
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Prepare and Run Installation Script

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

Makes the installation script executable and sets its file tag to ISO-8859-1 format before running it to install the CICS TS configuration tool beta and its dependencies.

```shell
chmod u=rx ./install.sh
```

```shell
chtag -tc ISO8859-1 ./install.sh
```

```shell
./install.sh
```

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

### Install CICS TS Configuration Tool using Python Wheel

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

Installs the CICS TS configuration tool beta using its Python wheel file. This command should be run from the directory where the wheel file has been transferred. The wildcard `*` is used to accommodate versioning in the filename.

```shell
pip3 install cicsconfig-*-py3-none-any.whl
```

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

### Install Z Open Automation Utilities (ZOAU)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

Installs the ZOAU Python wheel within the active virtual environment. Ensure you have the correct ZOAU Python wheel file, and replace `<zoau-python-wheel>` with the actual filename.

```shell
pip3 install <zoau-python-wheel>
```

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

### Extract cicsconfig.zip on z/OS UNIX

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

Extracts the CICS TS configuration tool beta wheel and its dependencies from a zip archive on z/OS UNIX. Requires the `unzip` command or `jar` if `unzip` is unavailable.

```shell
unzip ./cicsconfig*.zip
```

```shell
jar -xvf ./cicsconfig*.zip
```

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

### Create Python Virtual Environment using venv

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

This command creates a self-contained Python environment. Replace `<virtual-environmment-location>` with your desired directory path. The created environment cannot be moved after creation.

```shell
python -m venv <virtual-environmment-location>
```

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

### Activate Python Virtual Environment

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=installing

This command activates the virtual environment, making its Python interpreter and packages the default. Replace `<virtual-environmment-location>` with the path to your virtual environment directory. This command must be run in the z/OS UNIX shell.

```shell
. <virtual-environmment-location>/bin/activate
```

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

### Extend CSD with Local DFHCSDUP Script (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML example demonstrates extending a CSD file with a DFHCSDUP script located in the same directory as the configuration file. Relative paths are supported for convenience.

```YAML
cics_region:
  csd:
    content:
      - type: csdup_script
        script: filename.txt
```

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

### Extend CSD with Resource Builder and Multiple Definitions (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML example shows how to use the CICS TS resource builder with multiple resource definition files. It allows for a single resource model to be applied against several sets of resource definitions.

```YAML
cics_region:
  csd:
    content:
      - type: resource_builder
        model: /path/to/resource-model.yaml
        definitions:
          - /path/to/resource-definitions.yaml
      - type: resource_builder
        model: /path/to/different_resource-model.yaml
        definitions:
          - /path/to/resource-definitions1.yaml
          - /path/to/resource-definitions2.yaml
```

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

### Apply Job Parameters for CICS Startup JCL

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-specifying-region-type

This example shows how to apply various job parameters to the CICS startup job using the `job_parameters` key within `region_jcl`. Supported parameters include `output_class`, `memlimit`, `msgclass`, `msglevel`, `programmer_name`, `region`, and `user`. Note that no validation is performed on these values.

```yaml
cics_region:
  region_jcl:
    job_parameters:
      output_class: 'A'
      memlimit: '2048M'
      msgclass: 'X'
      msglevel: '(1,2)'
      programmer_name: 'USERID'
      region: 'R1'
      user: 'BATCHUSER'
```

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

### CICS Auxiliary Trace Configuration Example

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-defining-auxiliary-trace

This YAML snippet demonstrates the configuration structure for auxiliary trace in a CICS region. It shows how to enable or disable tracing, configure rolling trace behavior, and specify parameters for two trace data sets (trace_a and trace_b), including their allocation, dataset names, and space allocation.

```yaml
cics_region:
  aux_trace:
    enabled: true | false
    rolling: true | false
    trace_a:
      allocate: true | false
      dsn: SOME.TRACEA
      primary_space: 123
      secondary_space: 456
      unit: MB
    trace_b:
      allocate: true | false
      dsn: SOME.TRACEB
      primary_space: 123
      secondary_space: 456
      unit: MB
```

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

### cicsconfig rm Command (Implied)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

While no direct code example is provided for 'rm', the command's existence is noted in the main help output. This action is used to remove configurations with a given ID from the CICS TS system.

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

### Specify EXEC Step Parameters for CICS Program Execution

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-specifying-region-type

This YAML configuration illustrates how to specify EXEC statement parameters for the DFHSIP program execution step using `cics_exec_step_parameters`. This is particularly useful for started tasks where `job_parameters` might not be applicable. Supported parameters are `memlimit` and `region`.

```yaml
cics_region:
  region_jcl:
    cics_exec_step_parameters:
      memlimit: '1024M'
      region: 'R2'
```

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

### Configure CICS Region Data Sets (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-overriding-default-region-data-sets

This YAML configuration demonstrates how to override default data set names and sizes for CICS region data sets. It specifies custom data set names (dsn), primary and secondary space allocations, and units (records, MB). This example focuses on auxiliary temporary storage and transaction dump data sets.

```YAML
cics_region:
  applid: APPL1
  sysid: SYS1
  region_hlq: MY.CICS.REGION
  cics_hlq: CICS.CICS630

  aux_temp_storage:
    dsn: MY.AUX.TEMP.STORAGE
    primary: 100
    secondary: 1
    unit: records

  transaction_dump:
    dump_a:
      dsn: MY.DUMP.A
      primary_space: 50
      secondary_space: 2
      unit: MB
    dump_b:
      dsn: MY.DUMP.B
      primary_space: 50
      secondary_space: 2
      unit: MB
```

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

### Override Default JVM Profile Directory in CICS Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-jvm-profile

This example shows how to override the default directory for JVM profiles in your CICS region configuration. By setting the `jvm_profile_dir` key, you can specify a custom z/OS UNIX directory where CICS TS configuration tool will create the JVM profiles. The `jvm_profiles` key is still used to define individual profiles.

```yaml
cics_region:
  jvm_profile_dir: "/u/user/jvmprofiles"
  jvm_profiles:
    - name: EYUSMSSJ
      source_path: "/u/user/jvmprofiles/EYUSMSSJ.jvmprofile"
      source_type: symlink
```

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

### Show CICS TS Configuration Tool Help

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

Display help information for the cicsconfig command, including available options and actions. This is useful for understanding the tool's capabilities and syntax.

```bash
$ cicsconfig --help
```

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

### CICS Configuration Tool CLI Help

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

View help information for the cicsconfig command, including available actions and options.

```APIDOC
## GET /help

### Description
Displays help information for the CICS TS configuration tool.

### Method
GET

### Endpoint
`cicsconfig --help` or `cicsconfig -h`

### Parameters
#### Query Parameters
- `-h` (boolean) - Optional - Show help message and exit.
- `-V` (boolean) - Optional - Show version of the installed cicsconfig tool.

### Request Example
```bash
cicsconfig --help
```

### Response
#### Success Response (200)
Output includes usage, options, and actions (apply, ls, rm).

#### Response Example
```
usage: cicsconfig [-h] [-V] {apply,ls,rm} ...

This tool helps configure CICS TS regions using declarative YAML files. It supports a configuration-as-code approach, where you define the entire setup of a CICS region in YAML — including region
datasets, system initialization parameters, and other CICS-specific resources.

options:
  -h, --help     Show this help message and exit.
  -V, --version  Show version of the installed cicsconfig tool.

actions:
  {apply,ls,rm}  Actions
    apply        Apply the configuration to the system
    ls           List all the configurations that have been applied
    rm           Remove the configurations with given ID
```
```

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

### cicsconfig Command Overview and Help

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

Displays the general usage, available actions (apply, ls, rm), and global options for the cicsconfig command. This is the primary entry point for understanding the tool's capabilities.

```bash
$ cicsconfig --help
usage: cicsconfig [-h] [-V] {apply,ls,rm} ...

This tool helps configure CICS TS regions using declarative YAML files. It supports a configuration-as-code approach, 
where you define the entire setup of a CICS region in YAML — including region data sets, system initialization 
parameters, and other CICS-specific resources.

options:
  -h, --help     Show this help message and exit.
  -V, --version  Show version of the installed cicsconfig tool.

actions:
  {apply,ls,rm}  Actions
    apply        Apply the configuration to the system
    ls           List all the configurations that have been applied
    rm           Remove the configurations with given ID

```

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

### List Applied CICS Configurations

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

List all CICS configurations that have been successfully applied to your system. This command helps in tracking the applied configurations and their details.

```bash
cicsconfig ls
```

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

### List Applied CICS Configurations

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

Lists all CICS configurations that have been applied to the system.

```APIDOC
## GET /ls

### Description
Lists all configurations that have been applied to the CICS system, providing details about each configuration's type, task ID, and last updated timestamp.

### Method
GET

### Endpoint
`cicsconfig ls`

### Parameters
None

### Request Example
```bash
cicsconfig ls
```

### Response
#### Success Response (200)
Returns a list of applied configurations with their details.

#### Response Example
```
TYPE          CONFIG TASK ID            LAST UPDATED 
cics_region   cics_region://<applid1>   2025-09-05T13:27:00+01:00
cics_region   cics_region://<applid2>   2025-09-05T13:30:00+01:00
cics_region   cics_region://<applid3>   2025-09-05T13:33:00+01:00
```
```

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

### Override Default CICS DD Statements in YAML

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-defining-data-definition-statements

Configures specific CICS Data Definition (DD) statements, overriding default ones. This example shows how to change the output class for `SYSABEND` and the dataset name for `CEEMSG`.

```yaml
cics_region:
  region_jcl:
    dds:
      - name: sysabend
        type: output
        output_class: B
      - name: ceemsg
        type: data_set
        dsn: MY.CEEMSG.DSN
```

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

### cicsconfig ls Command Syntax and Options

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

Describes the 'ls' action for the cicsconfig command, which lists all configurations that have been previously applied to the CICS TS system. It includes the option to display help information.

```bash
cicsconfig ls
        [-h (--help)]
```

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

### Configure CICS Region JCL Type in YAML

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-specifying-region-type

This YAML snippet demonstrates how to configure the CICS region JCL type using the `region_jcl` and `type` keys. The `type` can be set to `job` or `proc`, influencing how the CICS region is started. The `dsn` parameter specifies the dataset or member where the JCL is stored.

```yaml
cics_region:
  region_jcl:
    type: job | proc
    dsn: HLQ.DATASET | HLQ.DATASET(MEMBER)
    ...
```

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

### Configure DFHRPL and STEPLIB Datasets in CICS Region JCL

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-defining-your-dfhrpl-steplib-arguments

This YAML configuration defines datasets for DFHRPL and STEPLIB within the CICS region JCL. The `top_data_sets` key prepends datasets to the concatenation, while `data_sets` appends them. This is crucial for specifying libraries containing CICS application programs, control tables, or z/OS system modules.

```yaml
cics_region:
  region_jcl:
    dfhrpl:
      top_data_sets:
        - TOP.DATA_SET.ONE
        - TOP.DATA_SET.TWO
      data_sets:
        - BOTTOM.DATA_SET.ONE

    steplib:
      top_data_sets:
        - TOP.DATA_SET.ONE
        - TOP.DATA_SET.TWO
      data_sets:
        - BOTTOM.DATA_SET.ONE
```

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

### Apply CICS Region Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

Apply a CICS region configuration defined in a YAML file to your system. This command takes the path to the configuration file as an argument.

```bash
cicsconfig apply <path-to-yaml-file>
```

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

### Extend CSD with Resource Builder and DFHCSDUP Script (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML configuration combines the CICS TS resource builder with a DFHCSDUP script. The resource builder definitions are processed first, followed by any definitions provided in the DFHCSDUP script, allowing for a layered approach to CSD extension.

```YAML
cics_region:
  csd:
    content:
      - type: resource_builder
        model: /path/to/different-resource-model.yaml
        definitions:
          - /path/to/resource-definitions1.yaml
          - /path/to/resource-definiitons2.yaml
      - type: csdup_script
        script: /path/to/csdup_script.txt
```

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

### cicsconfig ls

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

Lists all the CICS configurations that have been applied to the system.

```APIDOC
## cicsconfig ls

List all the configurations that have been applied.

### Description
This action lists all the configurations that have been successfully applied to the CICS TS region.

### Method
Command-line action

### Usage
```bash
cicsconfig ls
        [-h (--help)]
```

### Options
- `-h`, `--help`: Show help message and exit.
```

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

### Apply CICS Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

Applies a CICS region configuration defined in a YAML file to the system.

```APIDOC
## POST /apply

### Description
Applies a CICS region configuration to the system using a specified YAML file. This command enables a configuration-as-code approach for managing CICS resources.

### Method
POST

### Endpoint
`cicsconfig apply <path-to-yaml-file>`

### Parameters
#### Path Parameters
- `path-to-yaml-file` (string) - Required - The relative or absolute path to the CICS region configuration YAML file.

#### Query Parameters
- `-e` (string) - Optional - Allows passing variables to the configuration. Variables can be space-separated key-value pairs or JSON objects/arrays.

### Request Example
```bash
cicsconfig apply /path/to/your/region-config.yaml
cicsconfig apply /path/to/your/region-config.yaml -e "applid=MYAPPL variable_key_a=value"
cicsconfig apply /path/to/your/region-config.yaml -e 'var={"key": "value"}'
cicsconfig apply /path/to/your/region-config.yaml -e 'var=["mylistentry"]'
```

### Response
#### Success Response (200)
Indicates that the configuration has been applied successfully. Detailed output may vary.

#### Response Example
(Successful application of configuration)
```

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

### Extend CSD with Multiple DFHCSDUP Scripts (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML configuration shows how to extend a CSD file using multiple DFHCSDUP scripts. Each script is listed as a separate entry under the 'content' key, allowing for modular management of CICS resources.

```YAML
cics_region:
  csd:
    content:
      - type: csdup_script
        script: /path/to/csdup_script1.txt
      - type: csdup_script
        script: /path/to/csdup_script2.txt
```

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

### cicsconfig apply Command Syntax and Options

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

Details the 'apply' action of the cicsconfig command, used to apply configurations defined in YAML files to the CICS TS system. It outlines the available options for controlling verbosity and providing external variables.

```bash
cicsconfig apply
        [-e (--extra-vars)]
        [-h (--help)]
        [-q (--quiet)]
        [-v (--verbose)]
```

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

### Extend CSD with DFHCSDUP Script (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML configuration extends a CSD file by referencing a DFHCSDUP script. The 'script' key points to the location of the script file, which contains commands like ADD, APPEND, COPY, DEFINE, and USERDEFINE to manage CICS resources.

```YAML
cics_region:
  csd:
    content:
      - type: csdup_script
        script: /path/to/csdup_script.txt
```

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

### YAML Configuration for CICS Region

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=using-yaml-files-configuring-cics-regions

This YAML snippet demonstrates the required parameters for configuring a CICS region using the CICS TS configuration tool. It includes the application ID, system ID, and high-level qualifiers for CICS and region data sets.

```yaml
cics_region:
  applid: APPLID1
  sysid: SYS1
  cics_hlq: CICSTS63.CICS
  region_hlq: USER.DATASETS.REG1.APPLID1
```

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

### Configure CICS Region with Existing CSD File (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML configuration snippet shows how to specify an existing CICS System Definition (CSD) file for your CICS region. It uses the 'existing: true' flag and the 'dsn' key to point to the pre-existing CSD data set. This is useful when migrating or integrating with existing CICS environments.

```yaml
cics_region:
  csd:
    existing: true
    dsn: MY.PREEXISTING.CSD
```

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

### cicsconfig Command Syntax

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

The 'cicsconfig' command is used to invoke functions of the CICS Transaction Server configuration tool. It supports applying, listing, and removing configurations for CICS regions using declarative YAML files.

```APIDOC
## cicsconfig command syntax

The `cicsconfig` command invokes functions of CICS® Transaction Server configuration tool beta (CICS TS configuration tool beta).

### Description
This tool helps configure CICS TS regions using declarative YAML files. It supports a configuration-as-code approach, where you define the entire setup of a CICS region in YAML — including region data sets, system initialization parameters, and other CICS-specific resources.

### Method
Command-line tool

### Usage
```bash
$ cicsconfig [-h] [-V] {apply,ls,rm} ...
```

### Options
- `-h`, `--help`: Show help message and exit.
- `-V`, `--version`: Show version of the installed cicsconfig tool.

### Actions
- `apply`: Apply the configuration to the system.
- `ls`: List all the configurations that have been applied.
- `rm`: Remove the configurations with given ID.
```

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

### Define JVM Profile with Symlink in CICS Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-jvm-profile

This snippet demonstrates how to define a JVM profile using a symbolic link in the CICS region configuration file. It specifies the profile name, the source path of the existing JVM profile, and its type as 'symlink'. This ensures CICS can locate the profile at runtime by creating a symbolic link in the `jvm_profile_dir`.

```yaml
cics_region:
  jvm_profiles:
    - name: EYUSMSSJ
      source_path: "/u/user/jvmprofiles/EYUSMSSJ.jvmprofile"
      source_type: symlink
```

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

### cicsconfig apply

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=reference-cicsconfig-command-syntax

Applies the CICS region configuration defined in YAML files to the system. This command allows for detailed control over the configuration process.

```APIDOC
## cicsconfig apply

Apply the configuration to the system.

### Description
This action applies the declarative YAML configuration to the CICS TS region, enabling a configuration-as-code approach.

### Method
Command-line action

### Usage
```bash
cicsconfig apply
        [-e (--extra-vars)]
        [-h (--help)]
        [-q (--quiet)]
        [-v (--verbose)]
```

### Options
- `-e`, `--extra-vars`: Provide variables to be used in your YAML in the format: "var1=value1 var2=value2". (string, optional)
- `-h`, `--help`: Show help message and exit.
- `-q`, `--quiet`: Hide all messages apart from errors in the console. Ignored if `-v` or `-vv` is used.
- `-v`, `--verbose`: Increase console output verbosity. Use `-v` for info, `-vv` for debug-level log. (integer, default=0)
```

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

### Configure Console Autoinstall Mode in CICS

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-defining-autoinstall-consoles

This snippet defines the autoinstall support for consoles within a CICS region configuration file. The `mode` key accepts 'dfhtermc', 'yes', 'no', or 'auto' to control the autoinstall behavior. 'dfhtermc' is the default and implies AICONS set to 'auto' and configuration in XDFHCFG. Other modes directly set the AICONS SIT override, unless manually overridden in the YAML.

```yaml
cics_region:
  console_autoinstall:
    mode: dfhtermc | yes | no | auto
```

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

### Extend CSD with Resource Builder (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-cics-system-definition-csd-files

This YAML configuration utilizes the CICS TS resource builder to extend a CSD file. It specifies a resource model file and one or more resource definition files, which are processed by the resource builder to generate DFHCSDUP commands.

```YAML
cics_region:
  csd:
    content:
      - type: resource_builder
        model: /path/to/resource-model.yaml
        definitions:
          - /path/to/resource-definitions.yaml
```

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

### Create New JVM Profile with Properties in CICS Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-using-jvm-profile

This snippet illustrates how to create a new JVM profile with custom properties using the CICS region configuration. The `properties` key accepts a multi-line string to define JVM arguments and environment variables, such as `WORK_DIR`, memory settings (`-Xms`, `-Xmx`), and system properties (`-Dfile.encoding`). This method is used when `source_type` is 'inline' (the default).

```yaml
cics_region:
  jvm_profiles:
    - name: EYUSMSSJ
      properties: |
        WORK_DIR=.
        -Xms128M
        -Xmx1G
        -Xmso1M
        -Dfile.encoding=ISO-8859-1
```

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

### Specify Schema in YAML File

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=using-schemas

This modeline can be added to the beginning of an individual YAML file to explicitly tell the YAML language server which schema to use for validation and autocompletion. It allows for project-specific schema referencing using relative paths.

```yaml
# yaml-language-server: $schema=../relative/path/to/schema
```

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

### Pass Variables via CLI to CICS Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=running-cics-ts-configuration-tool

Apply a CICS region configuration while passing variables through the command-line interface using the '-e' option. CLI variables take precedence over those defined in the configuration file.

```bash
cicsconfig apply <path-to-yaml-file> -e "variable_key_a=value variable_key_b=value"
```

```bash
-e 'var={"key": "value"}'
```

```bash
-e 'var=["mylistentry"]'
```

```bash
-e "\" var=\"{"key": \"value\"}\"\n        \""
```

```bash
cicsconfig apply <path-to-yaml-file> -e "applid=MYAPPL"
```

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

### Configure VS Code YAML Schemas

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=using-schemas

This configuration snippet for VS Code's settings.json associates a local JSON schema file with YAML files matching a specific naming convention. It's used to enable schema validation and autocompletion for CICS region configuration files.

```json
"yaml.schemas": {
    "file:///my-schemas/cics_region_<version_number>.schema.json": "*.cicsregion.y*ml"
  }
```

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

### Generated CICS Region JCL from YAML Configuration

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=jcl-defining-data-definition-statements

Illustrates the JCL generated from the provided YAML configuration for CICS Data Definition (DD) statements. Shows how different DD types and content are translated into standard JCL.

```jcl
//DD1        DD DSN=MY.EXTRA.DD,DISP=SHR
//DD2        DD SYSOUT=A
//DD3        DD *
MY CONTENT
/*
//DD4        DD DUMMY
//DD5        DD DSN=MY.DSN,DISP=SHR
//           DD *
INSTREAM CONTENT
/*
//           DD *
mykey1=value1
mykey2=value2
/*
```

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

### Define CMCI Configuration in CICS Region (YAML)

Source: https://www.ibm.com/docs/en/cics-configuration-tool/1.0.x/index_topic=regions-defining-cics-management-client-interface-cmci

This snippet demonstrates how to configure the CICS management client interface (CMCI) within a CICS region's configuration file using YAML format. It specifies the port, authentication mode, IP address, and SSL settings for CMCI connections. This configuration is essential for enabling CMCI functionality.

```yaml
cics_region:
  extensions:
    cics_cmci:
      cmci_auth: BASIC
      cmci_port: 12345
      tcpip_address: "<ip_address>"
      ssl: "YES"
      ssl_cert: "<cert_path>"
      ssl_ciphers: "TLS_RSA_WITH_AES_256_CBC_SHA"

```
Tokens:
Raw