Zowe

https://docs.zowe.org/
Admin
Zowe is an open-source framework that provides modern interfaces to interact with the mainframe,...
Tokens:2,896,190
Snippets:21,800
Trust Score:8.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Zowe Internal Start Command Examples

Source: https://docs.zowe.org/v3.0.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start

Examples demonstrating how to use the 'zwe internal start' command with its sub-commands and parameters. These examples show the basic syntax for starting Zowe components or preparing the environment.

```bash
zwe internal start prepare -c /path/to/zowe.yaml
```

```bash
zwe internal start component -o component-name -c /path/to/zowe.yaml
```

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

### Zowe Install Command Examples

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/zwe-install

Provides examples of how to use the 'zwe install' command with different parameters, including specifying a configuration file and enabling JCL installation.

```bash
zwe install -v -c /path/to/zowe.yaml
```

```bash
zwe install --config "FILE(/path/to/zowe.yaml):PARMLIB(ZOWE.PARM(YAML))" --jcl
```

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

### Zowe Internal Start Command Examples (Zsh)

Source: https://docs.zowe.org/v3.1.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start

Demonstrates how to use the 'zwe internal start' command with its sub-commands and parameters. This includes starting the 'prepare' sub-command with a configuration file and starting a specific 'component' with its name and configuration file.

```zsh
zwe internal start prepare -c /path/to/zowe.yaml

zwe internal start component -o component-name -c /path/to/zowe.yaml
```

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

### Zowe Install Command Example

Source: https://docs.zowe.org/v2.18.x/appendix/zwe_server_command_reference/zwe/zwe-install

This snippet shows an example of how to run the 'zwe install' command with verbose mode and a specified configuration file. It demonstrates the basic usage for installing Zowe MVS data sets.

```bash
zwe install -v -c /path/to/zowe.yaml
```

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

### Start Resource Command Example (Zowe CLI)

Source: https://docs.zowe.org/v3.0.x/web_help/docs/zowe_ops_start_resource

This example demonstrates how to start a specific resource within a table for the OPS/MVS subsystem using the Zowe CLI. It includes the resource name, table name, and subsystem ID.

```bash
zowe ops start resource "RESOURCE1" "MYTABLE" --subsystem "OPSS"
```

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

### Install Zowe CLI Core (npm)

Source: https://docs.zowe.org/v2.18.x/getting-started/cli-getting-started

Installs the core Zowe CLI V2 LTS version from the public npm registry. Requires Node.js and npm to be installed.

```bash
npm install -g @zowe/cli@zowe-v2-lts
```

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

### Install Zowe CLI Plugins (npm)

Source: https://docs.zowe.org/v2.18.x/getting-started/cli-getting-started

Installs several open-source Zowe CLI plugins for interacting with mainframe subsystems like CICS, Db2, IMS, MQ, and ZOS FTP. Requires the core CLI to be installed.

```bash
zowe plugins install @zowe/cics-for-zowe-cli@zowe-v2-lts @zowe/db2-for-zowe-cli@zowe-v2-lts @zowe/ims-for-zowe-cli@zowe-v2-lts @zowe/mq-for-zowe-cli@zowe-v2-lts @zowe/zos-ftp-for-zowe-cli@zowe-v2-lts
```

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

### Get Launch Components Command Example

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components

Example of how to use the 'zwe internal get-launch-components' command with a configuration file path. This command requires the Zowe CLI to be installed and configured.

```bash
zwe internal get-launch-components -c /path/to/zowe.yaml
```

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

### Example Commands for zwe init security

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/init/zwe-init-security

These examples demonstrate how to execute the 'zwe init security' command with different options. The first command runs the security initialization with verbose output and a specified configuration file. The second command includes the '--generate' flag to force JCL regeneration before submission.

```bash
zwe init security -v -c /path/to/zowe.yaml

```

```bash
zwe init security -v -c /path/to/zowe.yaml --generate

```

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

### Basic Script Example

Source: https://docs.zowe.org/v3.0.x/getting-started/cli-getting-started

A basic bash script demonstrating the use of Zowe CLI commands within a script. This example sets the '-e' option to exit immediately if a command exits with a non-zero status.

```bash
#!/bin/bash

set -e

```

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

### Example Usage of 'zwe internal start component'

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component

Demonstrates how to use the 'zwe internal start component' command with specific parameters. It shows how to specify the component name and the configuration file path.

```bash
zwe internal start component -o component-name -c /path/to/zowe.yaml
```

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

### Install Zowe CLI Plug-ins

Source: https://docs.zowe.org/v3.0.x/getting-started/cli-getting-started

Installs common Zowe CLI plug-ins for interacting with mainframe services like CICS, Db2, MQ, and FTP. Note that the Db2 plug-in may require additional configuration.

```bash
zowe plugins install @zowe/cics-for-zowe-cli@zowe-v2-lts @zowe/db2-for-zowe-cli@zowe-v2-lts @zowe/mq-for-zowe-cli@zowe-v2-lts @zowe/zos-ftp-for-zowe-cli@zowe-v2-lts
```

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

### Zowe CLI Installation and Initialization Examples

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe

Demonstrates how to install Zowe components and initialize the Zowe configuration using the 'zwe' command. It shows the use of flags like '--allow-overwrite' and specifies configuration file paths.

```bash
zwe install -h

zwe init --allow-overwrite --config /path/to/zowe.yaml

zwe start -c /path/to/zowe.yaml
```

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

### Zowe YAML Configuration Setup Example

Source: https://docs.zowe.org/stable/appendix/Zowe-yaml-configuration

This YAML snippet demonstrates the structure for configuring Zowe installation and initialization. It includes settings for datasets, security, and certificates.

```yaml
zowe:
  setup:
    dataset:
      prefix: IBMUSER.ZWE
      parmlib: IBMUSER.ZWE.CUST.PARMLIB
      jcllib: IBMUSER.ZWE.CUST.JCLLIB
      authLoadlib: IBMUSER.ZWE.CUST.ZWESALL
      authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL
    security:
      product: RACF
      groups:
        admin: ZWEADMIN
        stc: ZWEADMIN
        sysProg: ZWEADMIN
      users:
        zowe: ZWESVUSR
        zis: ZWESIUSR
      stcs:
        zowe: ZWESLSTC
        zis: ZWESISTC
        aux: ZWESASTC
    certificate:
      type: PKCS12
      dname:
        caCommonName:
        commonName:
        orgUnit:
        org:
        locality:
        state:
        country:
      validity: 3650
      pkcs12:
        directory: /global/zowe/keystore
        lock: true
        name: localhost
        password: password
        caAlias: local_ca
        caPassword: local_ca_password
        import:
          keystore:
          password:
          alias:
      keyring:
        owner:
        name: ZoweKeyring
        label: localhost
        caLabel: localca
        import:
          dsName:
          password:
        connect:
          user:
          label:
        zOSMF:
          ca:
          user: IZUSVR
      san:
        - zos.my-company.com
        - internal-lpar1.zos.my-company.com
        - internal-lpar2.zos.my-company.com
        - internal-lpar3.zos.my-company.com
      importCertificateAuthorities:
        - 
    vsam:
      mode: NONRLS
      volume: VOL123
      storageClass: 

```

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

### Zowe Initialization Commands

Source: https://docs.zowe.org/v3.2.x/appendix/zwe_server_command_reference/zwe/init/zwe-init

Examples of using the 'zwe init' command for different initialization tasks. These commands typically require a configuration file path.

```bash
zwe init --allow-overwrite -c /path/to/zowe.yaml

zwe init apfauth -v -c /path/to/zowe.yaml

zwe init certificate -v -c /path/to/zowe.yaml
```

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

### zowe dbm-db2 prepare migration Examples

Source: https://docs.zowe.org/v3.3.x/web_help/docs/zowe_dbm-db2_prepare_migration

Examples demonstrating the usage of the 'zowe dbm-db2 prepare migration' command.

```APIDOC
## zowe dbm-db2 prepare migration Examples

### Description
Examples demonstrating the usage of the 'zowe dbm-db2 prepare migration' command.

### Method
N/A (Command Examples)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
# Generate a migration script for a tablespace and its child table:
zowe dbm-db2 prepare migration --object "tablespace my.tbsp include(table)" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt

# Generate a migration script and apply global changes:
zowe dbm-db2 prepare migration --object "database my.db include(children)" --source-db2 SRC --target-db2 TRG --change-set USER1.CHANGSET --output-migrate-script migrate.txt --output-ddl-file objects.sql
```

### Response
N/A
```

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

### Examples for 'zwe init mvs' Command

Source: https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs

These examples demonstrate how to use the 'zwe init mvs' command with different parameters. They show basic usage with a configuration file and advanced usage with specific dataset and parmlib overrides.

```bash
zwe init mvs -v -c /path/to/zowe.yaml

```

```bash
zwe init mvs --config 'FILE(/path/to/zowe.yaml):PARMLIB(ZOWE.PARMLIB(ZWEYAML))' --generate --trace

```

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

### Zowe YAML Configuration Setup Example

Source: https://docs.zowe.org/stable/appendix/zowe-yaml-configuration

This YAML snippet illustrates the structure and available parameters within the `zowe.setup` section for configuring Zowe installation and runtime. It covers dataset definitions, security configurations (product, groups, users, started tasks), and certificate management options including keystore type, distinguished name, validity, Subject Alternative Names (SAN), and import settings.

```yaml
zowe:
  setup:
    dataset:
      prefix: IBMUSER.ZWE
      parmlib: IBMUSER.ZWE.CUST.PARMLIB
      jcllib: IBMUSER.ZWE.CUST.JCLLIB
      authLoadlib: IBMUSER.ZWE.CUST.ZWESALL
      authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL
    security:
      product: RACF
      groups:
        admin: ZWEADMIN
        stc: ZWEADMIN
        sysProg: ZWEADMIN
      users:
        zowe: ZWESVUSR
        zis: ZWESIUSR
      stcs:
        zowe: ZWESLSTC
        zis: ZWESISTC
        aux: ZWESASTC
    certificate:
      type: PKCS12
      dname:
        caCommonName:
        commonName:
        orgUnit:
        org:
        locality:
        state:
        country:
      validity: 3650
      pkcs12:
        directory: /global/zowe/keystore
        lock: true
        name: localhost
        password: password
        caAlias: local_ca
        caPassword: local_ca_password
        import:
          keystore:
          password:
          alias:
      keyring:
        owner:
        name: ZoweKeyring
        label: localhost
        caLabel: localca
        import:
          dsName:
          password:
        connect:
          user:
          label:
        zOSMF:
          ca:
          user: IZUSVR
      san:
        - zos.my-company.com
        - internal-lpar1.zos.my-company.com
        - internal-lpar2.zos.my-company.com
        - internal-lpar3.zos.my-company.com
      importCertificateAuthorities:
        - 
    vsam:
      mode: NONRLS
      volume: VOL123
      storageClass:

```

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

### Bash Script Example for Deleting Datasets

Source: https://docs.zowe.org/v3.1.x/getting-started/cli-getting-started

A bash script demonstrating how to use Zowe CLI commands within a script to automate mainframe operations, such as deleting a list of datasets.

```bash
#!/bin/bash

set -e


```

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

### Example Usage

Source: https://docs.zowe.org/v2.18.x/web_help/docs/zowe_endevor_list_packages

An example demonstrating how to list packages in Endevor using the Zowe CLI.

```APIDOC
## Example: List Endevor Packages

### Description
Lists all packages in Endevor using a specified Endevor profile.

### Method
GET

### Endpoint
`/websites/zowe/endevor/list packages`

### Parameters
#### Query Parameters
- **-i | --instance** (string) - Required - The Endevor instance name.

### Request Example
```bash
zowe endevor list packages -i ENDEVOR
```
```

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

### Zowe CLI: Create Package Example

Source: https://docs.zowe.org/v2.18.x/web_help/docs/zowe_endevor_create_package

This example demonstrates how to create a package using the Zowe CLI with an Endevor profile. It specifies the package name, description, and the local file to be used.

```bash
zowe endevor create package packageName -d "package description" --ff localfile.txt -i ENDEVOR
```

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

### Example: Unzip Zowe CLI Installation Package

Source: https://docs.zowe.org/v2.18.x/user-guide/cli-installplugins

Provides a concrete example of unzipping a Zowe CLI installation package. This command is used to extract the contents of the zip file, preparing for local plug-in installation.

```bash
unzip zowe-cli-package-1.9.0.zip
```
Tokens:
Raw