zowe › dbm-db2 › execute › compare-script🖨️

Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]

Positional Arguments

• local-input-compare-script-filename (string)

  • Specifies the local input compare-script file that contains the update script that was generated with the 'zowe dbm compare ddl' command.

Options

• --output-recovery-script | --ors | --output-recovery-file | --orf (string)

  • Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm execute script' command undoes the changes that were made by execution of the compare-script.

    Default value: recovery.txt

• --restart | -r (string)

  • Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

    The following restart options are valid:

    new - Restart execution of the script at the first statement.

    token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.

• --error-file | --ef (string)

  • Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

    Default value: error.log

• --modification | -m (string)

  • Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

    For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

Profile Options

• --dbm-db2-options-profile | --dbm-db2-options-p (string)

  • The name of a (dbm-db2-options) profile to load for this command execution.

• --dbm-db2-profile | --dbm-db2-p (string)

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

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

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

DBM-Db2 Connection Options

• --protocol (string)

  • Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

    Allowed values: http, https

• --environment-list | --el (string)

  • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt

• --job-cards | --jc (array)

  • Specifies a string array of z/OS JCL JOB statements.

• --work-dataset-prefix | --wdp (string)

  • Specifies the prefix (high-level qualifier) in z/OS work data set names.

• --delete-work-datasets | --dwd (boolean)

  • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.

• --overwrite-output-files | --oof (boolean)

  • Specifies whether to overwrite output files if they exist.

• --base-path | --bp (string)

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

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.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

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

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

Examples

• Execute a compare script:

  • zowe dbm-db2 execute compare-script compare.txt Copy

• Restart execution of a compare script at the first statement in the script:

  • zowe dbm-db2 execute compare-script compare.txt --restart new Copy

• Restart execution of a compare script at the location in the token:

  • zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA Copy