zowe › cics-deploy › deploy › bundle🖨️

Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to install and make available a BUNDLE resource in the target group of CICS regions.

Usage

zowe cics-deploy deploy bundle [options]

cics-deploy Options

• --name | -n (string)

  • Required. Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or undeploy.

• --bundle-directory | --bd | --bundledir | --bundle-dir (string)

  • Required. Specifies the location of the CICS bundle (up to 255 characters) on zFS.

• --cicsplex | --cp (string)

  • Specifies the CICSplex (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.

• --scope | --sc (string)

  • Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.

• --csd-group | --cg | --csdgroup (string)

  • Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed, a definition is added to this group. If a bundle is undeployed, then the definition is removed from this group. The definition is added or removed from the CSD of each system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.

• --res-group | --rg | --resgroup (string)

  • Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed, a resource is defined in the BAS data repository. If a bundle is undeployed, the definition is removed. The --csd-group and --res-group options are mutually exclusive.

• --cics-hlq | --cq | --cicshlq (string)

  • Specifies the high-level qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.

• --cpsm-hlq | --cph | --cpsmhlq (string)

  • Specifies the high-level qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.

• --description | --desc (string)

  • An optional value that specifies a description of the bundle definition (up to 58 characters).

• --job-card | --jc | --jobcard (string)

  • Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter if you need to tailor the job card and you have not set the --cics-deploy-profile option. You can separate multiple lines of the jobcard with \n.

    Default value: //DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT

• --timeout | --to (number)

  • An optional numerical value that specifies the maximum amount of time in seconds (1 - 1800 inclusive) for the DFHDPLOY command to complete. If not specified DFHDPLOY will use its default of 300 seconds.

• --target-state | --ts | --targetstate (string)

  • Specifies the target state for the deployed bundle.

    Default value: ENABLED
    Allowed values: DISABLED, ENABLED, AVAILABLE

• --verbose | -v (boolean)

  • Enable or suppress verbose output from the DFHDPLOY tool.

    Default value: false

Zosmf Connection Options

• --zosmf-host | --zh (string)

  • The z/OSMF server host name.

• --zosmf-port | --zp (number)

  • The z/OSMF server port.

• --zosmf-user | --zu (string)

  • Mainframe (z/OSMF) user name, which can be the same as your TSO login.

• --zosmf-password | --zpw (string)

  • Mainframe (z/OSMF) password, which can be the same as your TSO password.

• --zosmf-reject-unauthorized | --zru (boolean)

  • Reject self-signed certificates.

• --zosmf-base-path | --zbp (string)

  • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

Profile Options

• --cics-deploy-profile | --cics-deploy-p (string)

  • The name of a (cics-deploy) profile to load for this command execution.

• --zosmf-profile | --zosmf-p (string)

  • The name of a (zosmf) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --host | -H (string)

  • Host name of service on the mainframe.

• --port | -P (number)

  • Port number of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

• --password | --pass | --pw (string)

  • Password to authenticate to service on the mainframe.

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Deploy a CICS bundle with a specific name and location to a default set of target regions:

  • zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir Copy

• Deploy a CICS bundle, but declare a timeout if the processing takes too long:

  • zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60 Copy

• Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles:

  • zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics Copy