From 958243a2317d1ecf598ab515d5cc829aa6622986 Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Thu, 29 Feb 2024 16:17:09 -0500 Subject: [PATCH] Update Broadcom copyright notices and plugins Signed-off-by: Andrew W. Harn --- commandGroups/ca7.jsonc | 2 +- commandGroups/caview.jsonc | 2 +- commandGroups/dbm-db2.jsonc | 928 ++++++++++++-------- commandGroups/endevor-bridge-for-git.jsonc | 449 ++++++++-- commandGroups/endevor.jsonc | 2 +- commandGroups/file-master-plus.jsonc | 2 +- commandGroups/idms.jsonc | 2 +- commandGroups/mat-pma-util.jsonc | 2 +- commandGroups/mat.jsonc | 2 +- commandGroups/omspool.jsonc | 62 +- commandGroups/ops.jsonc | 2 +- commandGroups/sysview.jsonc | 2 +- profiles/create/ca7.jsonc | 2 +- profiles/create/caview.jsonc | 2 +- profiles/create/dbm-db2-options.jsonc | 286 ++++++ profiles/create/dbm-db2.jsonc | 185 ++-- profiles/create/ebg.jsonc | 2 +- profiles/create/endevor-location.jsonc | 2 +- profiles/create/endevor.jsonc | 2 +- profiles/create/fmp.jsonc | 2 +- profiles/create/idms.jsonc | 2 +- profiles/create/mat.jsonc | 2 +- profiles/create/omspool.jsonc | 22 +- profiles/create/ops.jsonc | 2 +- profiles/create/pma.jsonc | 2 +- profiles/create/sysview-format.jsonc | 2 +- profiles/create/sysview.jsonc | 2 +- profiles/delete/ca7.jsonc | 2 +- profiles/delete/caview.jsonc | 2 +- profiles/delete/dbm-db2-options.jsonc | 76 ++ profiles/delete/dbm-db2.jsonc | 2 +- profiles/delete/ebg.jsonc | 2 +- profiles/delete/endevor-location.jsonc | 2 +- profiles/delete/endevor.jsonc | 2 +- profiles/delete/fmp.jsonc | 2 +- profiles/delete/idms.jsonc | 2 +- profiles/delete/mat.jsonc | 2 +- profiles/delete/omspool.jsonc | 22 +- profiles/delete/ops.jsonc | 2 +- profiles/delete/pma.jsonc | 2 +- profiles/delete/sysview-format.jsonc | 2 +- profiles/delete/sysview.jsonc | 2 +- profiles/list/ca7.jsonc | 2 +- profiles/list/caview.jsonc | 2 +- profiles/list/dbm-db2-options.jsonc | 75 ++ profiles/list/dbm-db2.jsonc | 2 +- profiles/list/ebg.jsonc | 2 +- profiles/list/endevor-location.jsonc | 2 +- profiles/list/endevor.jsonc | 2 +- profiles/list/fmp.jsonc | 2 +- profiles/list/idms.jsonc | 2 +- profiles/list/mat.jsonc | 2 +- profiles/list/omspool.jsonc | 22 +- profiles/list/ops.jsonc | 2 +- profiles/list/pma.jsonc | 2 +- profiles/list/sysview-format.jsonc | 2 +- profiles/list/sysview.jsonc | 2 +- profiles/set-default/ca7.jsonc | 2 +- profiles/set-default/caview.jsonc | 2 +- profiles/set-default/dbm-db2-options.jsonc | 68 ++ profiles/set-default/dbm-db2.jsonc | 2 +- profiles/set-default/ebg.jsonc | 2 +- profiles/set-default/endevor-location.jsonc | 2 +- profiles/set-default/endevor.jsonc | 2 +- profiles/set-default/fmp.jsonc | 2 +- profiles/set-default/idms.jsonc | 2 +- profiles/set-default/mat.jsonc | 2 +- profiles/set-default/omspool.jsonc | 22 +- profiles/set-default/ops.jsonc | 2 +- profiles/set-default/pma.jsonc | 2 +- profiles/set-default/sysview-format.jsonc | 2 +- profiles/set-default/sysview.jsonc | 2 +- profiles/update/ca7.jsonc | 2 +- profiles/update/caview.jsonc | 2 +- profiles/update/dbm-db2-options.jsonc | 304 +++++++ profiles/update/dbm-db2.jsonc | 156 ++-- profiles/update/ebg.jsonc | 2 +- profiles/update/endevor-location.jsonc | 2 +- profiles/update/endevor.jsonc | 2 +- profiles/update/fmp.jsonc | 2 +- profiles/update/idms.jsonc | 2 +- profiles/update/mat.jsonc | 2 +- profiles/update/omspool.jsonc | 22 +- profiles/update/ops.jsonc | 2 +- profiles/update/pma.jsonc | 2 +- profiles/update/sysview-format.jsonc | 2 +- profiles/update/sysview.jsonc | 2 +- 87 files changed, 2089 insertions(+), 754 deletions(-) create mode 100644 profiles/create/dbm-db2-options.jsonc create mode 100644 profiles/delete/dbm-db2-options.jsonc create mode 100644 profiles/list/dbm-db2-options.jsonc create mode 100644 profiles/set-default/dbm-db2-options.jsonc create mode 100644 profiles/update/dbm-db2-options.jsonc diff --git a/commandGroups/ca7.jsonc b/commandGroups/ca7.jsonc index c60bbab..3f77213 100644 --- a/commandGroups/ca7.jsonc +++ b/commandGroups/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7", diff --git a/commandGroups/caview.jsonc b/commandGroups/caview.jsonc index 3178dda..c29b35a 100644 --- a/commandGroups/caview.jsonc +++ b/commandGroups/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview", diff --git a/commandGroups/dbm-db2.jsonc b/commandGroups/dbm-db2.jsonc index e9f82e6..2020522 100644 --- a/commandGroups/dbm-db2.jsonc +++ b/commandGroups/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2", @@ -26,28 +26,38 @@ "options": [ { "name": "target-db2", - "description": "Specifies the target Db2 subsystem or data sharing group where you want to validate the DDL.\n \n\u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "td" ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "verify", - "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n\u001b[90m Default value: no \u001b[0m", - "type": "string", "aliases": [ "v" ], + "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n\u001b[90m Default value: no \u001b[0m", + "required": false, + "type": "string", "allowableValues": { "values": [ "yes", "no" ] }, + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { @@ -55,20 +65,44 @@ "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "group": "Options" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -78,71 +112,57 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", - "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "authid", - "aliases": [ - "a" - ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "sqlid", + "name": "delete-work-datasets", "aliases": [ - "s" + "dwd" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { "name": "overwrite-output-files", "aliases": [ "oof" ], - "description": "Specifies whether to overwrite output files when they already exist.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, "type": "boolean", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] + "group": "DBM-Db2 Connection Options" }, { - "name": "environment-list", + "name": "sqlid", "aliases": [ - "el" + "s" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -360,27 +380,27 @@ "options": [ { "name": "target-db2", - "description": "Specifies the target Db2 subsystem or the data sharing group where the objects that you are comparing reside.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "td" ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "match-set", - "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", - "type": "string", "aliases": [ "ms" ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "match-set-file", - "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \n% (percent sign) indicates that zero or more characters can occupy that position. Other non-wildcard characters must match.\n \n- (hyphen) indicates that any character can occupy that position, but a character must exist at that position.\n \n* (asterisk) indicates that like named objects on the source and target should be mapped. No other characters can appear together with this character.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. \u001b[0m", "type": "string", "conflictsWith": [ "match-set" @@ -393,17 +413,17 @@ }, { "name": "change-set", - "description": "Specifies the creator and name of an existing RC/Migrator global change set used for modifying Db2 object attributes. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n \nConsult with your database administrator about global change behavior for the default or a specific modification parameter. \u001b[0m", - "type": "string", "aliases": [ "cs" ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "change-set-file", - "description": "Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to table’s schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n \nConsult with your database administrator about global change behavior for the default or a specific modification parameter. \u001b[0m", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", "type": "string", "aliases": [ "csf" @@ -413,35 +433,35 @@ }, { "name": "rule-set", - "description": "Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", - "type": "string", "aliases": [ "rs" ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "id", - "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem by the execution of this command.\n \n\u001b[90m Format: The name must begin with a non-numeric character, and can consist of the characters A to Z (uppercase only), 0 to 9, $, #, and @. \u001b[0m", - "type": "string", + "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n\u001b[90m Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. \u001b[0m", "required": false, + "type": "string", "group": "Options", "aliases": [] }, { "name": "description", - "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", - "type": "string", "aliases": [ "d" ], + "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", "required": false, + "type": "string", "group": "Options" }, { "name": "output-compare-script", - "description": "Specifies the local output file name that contains the update script to make changes to the target Db2 subsystem.\n \n\u001b[90m Default value: compare.txt \u001b[0m", + "description": "Specifies the name of the local output file that contains the update script to make changes to objects that reside on the Db2 subsystem.\n \n\u001b[90m Default value: compare.txt \u001b[0m", "type": "string", "aliases": [ "ocs" @@ -451,7 +471,7 @@ }, { "name": "output-summary-file", - "description": "Specifies the local output file name that contains the change summary report in textual format. This report provides an overview of the changes to be performed to the Db2 objects on the target Db2 subsystem, but it does not describe how the changes are made.\n \n\u001b[90m Default value: summary.txt \u001b[0m", + "description": "Specifies the name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.\n \n\u001b[90m Default value: summary.txt \u001b[0m", "type": "string", "aliases": [ "osf" @@ -461,7 +481,7 @@ }, { "name": "output-impact-file", - "description": "Specifies the local output file name that contains the parseable impact analysis report in JSON or YAML format. This report helps identify significant DDL operations to be performed on Db2 objects. It provides the total number and type of DDL operations that are being performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.\n \nThe report format is determined by the supplied file name extension: .json for JSON and .yaml or .yml for YAML. If no extension is provided, JSON format is used.\n \n\u001b[90m Default value: impact.json\n\nFor more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", + "description": "Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.\n \nTo determine the report format, supply one of the following extensions in the file name:\n- .json for JSON\n- .yaml or .yml for YAML\nIf no extension is provided, the format is set to JSON.\n \n\u001b[90m Default value: impact.json\n\nFor more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", "type": "string", "aliases": [ "oif" @@ -469,25 +489,59 @@ "required": false, "group": "Options" }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, { "name": "modification", "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "description": "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", "required": false, "type": "string", - "group": "Options" + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -497,85 +551,71 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "authid", + "name": "delete-work-datasets", "aliases": [ - "a" + "dwd" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "sqlid", + "name": "overwrite-output-files", "aliases": [ - "s" + "oof" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "termination-character", + "name": "authid", "aliases": [ - "tc" + "a" ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "sqlid", "aliases": [ - "oof" + "s" ], - "description": "Specifies whether to overwrite output files when they already exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] + "group": "DBM-Db2 Connection Options" }, { - "name": "environment-list", + "name": "termination-character", "aliases": [ - "el" + "tc" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -797,27 +837,27 @@ "options": [ { "name": "target-db2", - "description": "Specifies the target Db2 subsystem or the data sharing group.\n \n\u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "td" ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "match-set", - "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n \n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", - "type": "string", "aliases": [ "ms" ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "match-set-file", - "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \n% (percent sign) indicates that zero or more characters can occupy that position. Other non-wildcard characters must match.\n \n- (hyphen) indicates that any character can occupy that position, but a character must exist at that position.\n \n* (asterisk) indicates that like named objects on the source and target should be mapped. No other characters can appear together with this character.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. \u001b[0m", "type": "string", "conflictsWith": [ "match-set" @@ -830,17 +870,17 @@ }, { "name": "change-set", - "description": "Specifies the creator and name of an existing RC/Migrator global change set used for modifying Db2 object attributes. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n \nConsult with your database administrator about global change behavior for the default or a specific modification parameter. \u001b[0m", - "type": "string", "aliases": [ "cs" ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "change-set-file", - "description": "Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to table’s schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n \nConsult with your database administrator about global change behavior for the default or a specific modification parameter. \u001b[0m", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", "type": "string", "aliases": [ "csf" @@ -850,12 +890,22 @@ }, { "name": "rule-set", - "description": "Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", - "type": "string", "aliases": [ "rs" ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { @@ -863,20 +913,44 @@ "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "group": "Options" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -886,85 +960,71 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "authid", + "name": "delete-work-datasets", "aliases": [ - "a" + "dwd" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "sqlid", + "name": "overwrite-output-files", "aliases": [ - "s" + "oof" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "termination-character", + "name": "authid", "aliases": [ - "tc" + "a" ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "sqlid", "aliases": [ - "oof" + "s" ], - "description": "Specifies whether to overwrite output files when they already exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] + "group": "DBM-Db2 Connection Options" }, { - "name": "environment-list", + "name": "termination-character", "aliases": [ - "el" + "tc" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -1207,58 +1267,38 @@ "group": "Options" }, { - "name": "modification", + "name": "error-file", "aliases": [ - "m" + "ef" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "modification", "aliases": [ - "ef" + "m" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "job-cards", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "jc" + "dbm-db2-options-p" ], - "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, - "type": "array", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "work-dataset-prefix", - "aliases": [ - "wdp" - ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", - "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "overwrite-output-files", - "aliases": [ - "oof" - ], - "description": "Specifies whether to overwrite output files when they already exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Profile Options" + "group": "Profile Options" }, { "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", "allowableValues": { @@ -1267,7 +1307,7 @@ "https" ] }, - "group": "DBM-Db2 Profile Options", + "group": "DBM-Db2 Connection Options", "aliases": [] }, { @@ -1275,10 +1315,50 @@ "aliases": [ "el" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -1485,25 +1565,59 @@ "required": false, "group": "Options" }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, { "name": "modification", "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "group": "Options" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -1513,51 +1627,37 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "delete-work-datasets", "aliases": [ - "oof" + "dwd" ], - "description": "Specifies whether to overwrite output files when they already exist.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, "type": "boolean", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] - }, - { - "name": "environment-list", + "name": "overwrite-output-files", "aliases": [ - "el" + "oof" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -1761,25 +1861,59 @@ "required": false, "group": "Options" }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, { "name": "modification", "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "group": "Options" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -1789,51 +1923,37 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "delete-work-datasets", "aliases": [ - "oof" + "dwd" ], - "description": "Specifies whether to overwrite output files when they already exist.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, "type": "boolean", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] - }, - { - "name": "environment-list", + "name": "overwrite-output-files", "aliases": [ - "el" + "oof" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -2055,16 +2175,16 @@ "options": [ { "name": "object", - "description": "Specifies the Db2 objects for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.\n \n\u001b[90m Format: see object-file description.\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "description": "Specifies the Db2 objects to be generated in DDL. Use the optional include clause to include related Db2 objects.\n \n \u001b[90m Format: see the object-file description\n \n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", "type": "string", "aliases": [ "o" ], - "group": "Options" + "group": "Required Options" }, { "name": "object-file", - "description": "Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional clause include(,...) identifies one or more, comma separated related object types that you want to include in the generated DDL statements. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "description": "Specifies the name of the local input file that contains a list of Db2 objects to be generated in DDL. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional include clause (,...) identifies one or more related Db2 object types to include in the object list.\n\nYou can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", "type": "string", "aliases": [ "of" @@ -2072,31 +2192,31 @@ "conflictsWith": [ "object" ], - "group": "Options" + "group": "Required Options" }, { "name": "source-db2", - "description": "Specifies the source Db2 subsystem or the data sharing group where the objects that you want to generate DDL for are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "sd" ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "change-set", - "description": "Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when generating the DDL.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", - "type": "string", "aliases": [ "cs" ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "change-set-file", - "description": "Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when generating DDL.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to table’s schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", "type": "string", "aliases": [ "csf" @@ -2106,12 +2226,12 @@ }, { "name": "type", - "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", - "type": "string", "aliases": [ "t" ], + "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", "required": false, + "type": "string", "allowableValues": { "values": [ "drop", @@ -2131,25 +2251,59 @@ "required": false, "group": "Options" }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, { "name": "modification", "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "group": "Options" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "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", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -2159,85 +2313,71 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "authid", + "name": "delete-work-datasets", "aliases": [ - "a" + "dwd" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "sqlid", + "name": "overwrite-output-files", "aliases": [ - "s" + "oof" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "termination-character", + "name": "authid", "aliases": [ - "tc" + "a" ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "sqlid", "aliases": [ - "oof" + "s" ], - "description": "Specifies whether to overwrite output files when they already exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] + "group": "DBM-Db2 Connection Options" }, { - "name": "environment-list", + "name": "termination-character", "aliases": [ - "el" + "tc" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", @@ -2456,16 +2596,16 @@ "options": [ { "name": "object", - "description": "Specifies the Db2 objects that you want to migrate. Use the optional include syntax to include related Db2 objects.\n \n\u001b[90m Format: see object-file description.\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "description": "Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format: see the object-file description\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", "type": "string", "aliases": [ "o" ], - "group": "Options" + "group": "Required Options" }, { "name": "object-file", - "description": "Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, that you want to migrate. Use the optional include syntax to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional clause include(,...) identifies one or more, comma separated related object types that you want to include in the object list. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "description": "Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional include clause (,...) identifies one or more related Db2 object types to include in the object list.\n\nYou can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", "type": "string", "aliases": [ "of" @@ -2473,41 +2613,41 @@ "conflictsWith": [ "object" ], - "group": "Options" + "group": "Required Options" }, { "name": "source-db2", - "description": "Specifies the source Db2 subsystem or the data sharing group where the object definitions and data that you want to migrate are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "sd" ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "target-db2", - "description": "Specifies the target Db2 subsystem or the data sharing group where the object definitions and data are migrated (copied) to.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", - "type": "string", "aliases": [ "td" ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", "required": true, + "type": "string", "group": "Required Options" }, { "name": "change-set", - "description": "Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when preparing objects for migration. \n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", - "type": "string", "aliases": [ "cs" ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", "required": false, + "type": "string", "group": "Options" }, { "name": "change-set-file", - "description": "Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when preparing for migration.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to table’s schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", "type": "string", "aliases": [ "csf" @@ -2517,7 +2657,7 @@ }, { "name": "output-migrate-script", - "description": "Specifies the local output file name that contains the script to make changes to the target Db2 subsystem.\n \n\u001b[90m Default value: migration.txt \u001b[0m", + "description": "Specifies the name of the local output file that contains the script to make changes to objects that reside on the Db2 subsystem.\n \n\u001b[90m Default value: migration.txt \u001b[0m", "type": "string", "aliases": [ "oms" @@ -2527,7 +2667,7 @@ }, { "name": "output-ddl-file", - "description": "Specifies the local output file name that contains the generated DDL for the input objects that are identified by the --object-file or --object option.\n \n\u001b[90m Default value: output.sql \u001b[0m", + "description": "Specifies the name of the local output file that contains the generated DDL for objects that are identified by the --object-file or --object option.\n \n\u001b[90m Default value: output.sql \u001b[0m", "type": "string", "aliases": [ "odf" @@ -2535,25 +2675,59 @@ "required": false, "group": "Options" }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "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.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, { "name": "modification", "aliases": [ "m" ], - "description": "Identifies 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 set of values that are normally used.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "description": "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.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", "required": false, "type": "string", "group": "Options" }, { - "name": "error-file", + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", "aliases": [ - "ef" + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" ], - "description": "Specifies the local output error file in YAML format that contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "description": "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", "required": false, "type": "string", - "group": "Options" + "group": "DBM-Db2 Connection Options" }, { "name": "job-cards", @@ -2563,85 +2737,71 @@ "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, "type": "array", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { "name": "work-dataset-prefix", "aliases": [ "wdp" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "authid", + "name": "delete-work-datasets", "aliases": [ - "a" + "dwd" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "sqlid", + "name": "overwrite-output-files", "aliases": [ - "s" + "oof" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, - "type": "string", - "group": "DBM-Db2 Profile Options" + "type": "boolean", + "group": "DBM-Db2 Connection Options" }, { - "name": "termination-character", + "name": "authid", "aliases": [ - "tc" + "a" ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Profile Options" + "group": "DBM-Db2 Connection Options" }, { - "name": "overwrite-output-files", + "name": "sqlid", "aliases": [ - "oof" + "s" ], - "description": "Specifies whether to overwrite output files when they already exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Profile Options" - }, - { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Profile Options", - "aliases": [] + "group": "DBM-Db2 Connection Options" }, { - "name": "environment-list", + "name": "termination-character", "aliases": [ - "el" + "tc" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", "required": false, "type": "string", - "group": "DBM-Db2 Profile Options" + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Connection Options" }, { "name": "show-inputs-only", diff --git a/commandGroups/endevor-bridge-for-git.jsonc b/commandGroups/endevor-bridge-for-git.jsonc index c6ee7bb..77cd0dc 100644 --- a/commandGroups/endevor-bridge-for-git.jsonc +++ b/commandGroups/endevor-bridge-for-git.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-bridge-for-git", @@ -123,6 +123,9 @@ "implies": [ "endevor-stage-number" ], + "conflictsWith": [ + "json-file" + ], "group": "Options", "aliases": [] }, @@ -136,8 +139,19 @@ "implies": [ "read-only" ], + "conflictsWith": [ + "json-file" + ], "group": "Options" }, + { + "name": "only-work-environment", + "description": "If specified, only elements from the Endevor work environment will be synchronized.", + "type": "boolean", + "required": false, + "group": "Options", + "aliases": [] + }, { "name": "mapping-mode", "description": "Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')", @@ -162,21 +176,6 @@ "group": "Options", "aliases": [] }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization of the branch even if the branch exists.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, - "type": "string", - "defaultValue": "REQUIRE_EMPTY", - "required": false, - "group": "Options", - "aliases": [] - }, { "name": "endevor-protocol", "aliases": [ @@ -469,9 +468,9 @@ "aliases": [ "b" ], - "description": "Name of the branch that will be added/removed.", + "description": "Name of the synchronized branch in the Git repository.", "type": "string", - "required": true + "defaultValue": "master" } ], "profile": { @@ -997,8 +996,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-area-id", @@ -1387,8 +1386,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-area-id", @@ -1860,8 +1859,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", @@ -3702,6 +3701,364 @@ ], "positionals": [] }, + { + "name": "endevor-credentials", + "aliases": [ + "ec" + ], + "summary": "Manage the stored Endevor credentials. [Deprecated]", + "description": "Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]", + "type": "group", + "children": [ + { + "name": "update", + "aliases": [ + "u" + ], + "type": "command", + "handler": "", + "description": "Update your Endevor credentials for a Git-Endevor mapping.", + "positionals": [ + { + "name": "context", + "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", + "type": "string", + "required": true + }, + { + "name": "mapping", + "description": "Git-Endevor mapping name (ID of the Git repository).", + "type": "string", + "required": true + } + ], + "profile": { + "optional": [ + "ebg", + "endevor", + "base" + ] + }, + "options": [ + { + "name": "endevor-user", + "aliases": [ + "endevoru" + ], + "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "endevor-password", + "aliases": [ + "endevorpass", + "endevorpw" + ], + "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Endevor Bridge for Git username (your git username).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "token", + "aliases": [ + "t" + ], + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: false", + "type": "boolean", + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ebg-profile", + "aliases": [ + "ebg-p" + ], + "group": "Profile Options", + "description": "The name of a (ebg) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", + "options": "MY-CONTEXT MY-MAPPING" + }, + { + "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile", + "options": "MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password" + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Endevor Bridge for Git username (your git username).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "token", + "aliases": [ + "t" + ], + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: false", + "type": "boolean", + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, { "name": "local-hook-token", "aliases": [ @@ -4525,6 +4882,14 @@ "defaultValue": "master", "group": "Options" }, + { + "name": "only-work-environment", + "description": "If specified, only elements from the Endevor work environment will be synchronized.", + "type": "boolean", + "required": false, + "group": "Options", + "aliases": [] + }, { "name": "read-only", "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", @@ -4555,32 +4920,9 @@ "group": "Options" }, { - "name": "type-filters", - "description": "Type filters that your mapping will be using. There can be multiple separated by a space. eg --type-filters \"COBOL\" \"COPY\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "name-filters", - "description": "Name filters that your mapping will be using. There can be multiple separated by a space. eg --name-filters \"ELE*\" \"CO*\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization even if the repository is not empty.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, + "name": "type-filter", + "description": "Type filter", "type": "string", - "defaultValue": "REQUIRE_EMPTY", "required": false, "group": "Options", "aliases": [] @@ -4615,6 +4957,7 @@ "read-only", "endevor-instance", "endevor-environment", + "endevor-environment", "endevor-system", "endevor-subsystem" ], @@ -6499,8 +6842,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", @@ -6765,8 +7108,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", diff --git a/commandGroups/endevor.jsonc b/commandGroups/endevor.jsonc index 1cc0fc9..44daacb 100644 --- a/commandGroups/endevor.jsonc +++ b/commandGroups/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor", diff --git a/commandGroups/file-master-plus.jsonc b/commandGroups/file-master-plus.jsonc index 28033e6..f8a6db0 100644 --- a/commandGroups/file-master-plus.jsonc +++ b/commandGroups/file-master-plus.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "file-master-plus", diff --git a/commandGroups/idms.jsonc b/commandGroups/idms.jsonc index ab2117e..a74b51b 100644 --- a/commandGroups/idms.jsonc +++ b/commandGroups/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms", diff --git a/commandGroups/mat-pma-util.jsonc b/commandGroups/mat-pma-util.jsonc index 1fddf1d..d510168 100644 --- a/commandGroups/mat-pma-util.jsonc +++ b/commandGroups/mat-pma-util.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-pma-util", diff --git a/commandGroups/mat.jsonc b/commandGroups/mat.jsonc index 0199c23..1a5c534 100644 --- a/commandGroups/mat.jsonc +++ b/commandGroups/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat", diff --git a/commandGroups/omspool.jsonc b/commandGroups/omspool.jsonc index dcc76c5..0e5aaee 100644 --- a/commandGroups/omspool.jsonc +++ b/commandGroups/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool", @@ -200,12 +200,19 @@ "group": "Zosmf Connection Options", "aliases": [] }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -214,23 +221,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" }, @@ -461,12 +461,19 @@ } ], "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -475,23 +482,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } @@ -504,12 +504,19 @@ "esf" ], "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -518,23 +525,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/commandGroups/ops.jsonc b/commandGroups/ops.jsonc index a49ad0e..e3706df5 100644 --- a/commandGroups/ops.jsonc +++ b/commandGroups/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops", diff --git a/commandGroups/sysview.jsonc b/commandGroups/sysview.jsonc index 6372ebd..3a2fb8d 100644 --- a/commandGroups/sysview.jsonc +++ b/commandGroups/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview", diff --git a/profiles/create/ca7.jsonc b/profiles/create/ca7.jsonc index 015cff9..98f9e35 100644 --- a/profiles/create/ca7.jsonc +++ b/profiles/create/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/create/caview.jsonc b/profiles/create/caview.jsonc index d5ea111..652e024 100644 --- a/profiles/create/caview.jsonc +++ b/profiles/create/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", diff --git a/profiles/create/dbm-db2-options.jsonc b/profiles/create/dbm-db2-options.jsonc new file mode 100644 index 0000000..43ac387 --- /dev/null +++ b/profiles/create/dbm-db2-options.jsonc @@ -0,0 +1,286 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-options-profile", + "aliases": [ + "dbm-db2-options" + ], + "summary": "Create a dbm-db2-options profile", + "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config init' command", + "customize": { + "profileTypeIdentifier": "dbm-db2-options" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set-values", + "aliases": [ + "csv" + ], + "description": "Specifies the global change specifications that modify Db2 object attributes during a command execution.\n\n Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. ", + "required": false, + "type": "array", + "group": "Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "defaultValue": null, + "group": "Options" + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "id", + "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. ", + "required": false, + "type": "string", + "group": "Options", + "aliases": [] + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "Options" + }, + { + "name": "match-set", + "aliases": [ + "ms" + ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "match-set-values", + "aliases": [ + "msv" + ], + "description": "Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. ", + "required": false, + "type": "array", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "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.\n \n For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "defaultValue": null, + "group": "Options" + }, + { + "name": "rule-set", + "aliases": [ + "rs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "source-db2", + "aliases": [ + "sd" + ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "Options" + }, + { + "name": "type", + "aliases": [ + "t" + ], + "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "drop", + "create" + ] + }, + "group": "Options" + }, + { + "name": "verify", + "aliases": [ + "v" + ], + "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n Default value: no ", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "yes", + "no" + ] + }, + "group": "Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "overwrite", + "aliases": [ + "ow" + ], + "description": "Overwrite the dbm-db2-options profile when a profile of the same name exists.", + "type": "boolean", + "group": "Options" + }, + { + "name": "disable-defaults", + "aliases": [ + "dd" + ], + "description": "Disable populating profile values of undefined properties with default values.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/create/dbm-db2.jsonc b/profiles/create/dbm-db2.jsonc index 2ef7f9e..867b933 100644 --- a/profiles/create/dbm-db2.jsonc +++ b/profiles/create/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2-profile", @@ -23,159 +23,170 @@ ], "options": [ { - "name": "job-cards", + "name": "host", "aliases": [ - "jc" + "H" ], - "description": "Specifies a string array of z/OS JCL JOB statements.", + "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", "required": false, - "type": "array", - "group": "DBM-Db2 Common Options", - "defaultValue": [ - "//DB2DVOPS JOB CLASS=A,", - "// MSGCLASS=X" - ] + "type": "string", + "group": "DBM-Db2 Options" }, { - "name": "work-dataset-prefix", + "name": "port", "aliases": [ - "wdp" + "P" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", "required": false, - "type": "string", - "group": "DBM-Db2 Common Options", - "defaultValue": "${user}.dbmdb2" + "type": "number", + "defaultValue": 7300, + "group": "DBM-Db2 Options" }, { - "name": "authid", + "name": "user", "aliases": [ - "a" + "u" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", "required": false, "type": "string", - "group": "DBM-Db2 Common Options", - "defaultValue": "${user}" + "group": "DBM-Db2 Options" }, { - "name": "sqlid", + "name": "password", "aliases": [ - "s" + "pass", + "pw" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", "required": false, "type": "string", - "group": "DBM-Db2 Common Options", - "defaultValue": "${user}" + "group": "DBM-Db2 Options" }, { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Common Options", - "defaultValue": ";" + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Options", + "defaultValue": "https", + "aliases": [] }, { - "name": "overwrite-output-files", + "name": "reject-unauthorized", "aliases": [ - "oof" + "ru" ], - "description": "Specifies whether to overwrite output files when they already exist.", + "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", "required": false, "type": "boolean", - "group": "DBM-Db2 Common Options", - "defaultValue": false + "defaultValue": true, + "group": "DBM-Db2 Options" }, { - "name": "host", + "name": "environment-list", "aliases": [ - "H" + "el" ], - "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", + "description": "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", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options" + "group": "DBM-Db2 Options", + "defaultValue": { + "ssid1": "env1@host1:port1", + "ssid2": "env2@host2:port2" + } }, { - "name": "port", + "name": "job-cards", "aliases": [ - "P" + "jc" ], - "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", + "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, - "type": "number", - "defaultValue": 7300, - "group": "DBM-Db2 Connection Options" + "type": "array", + "group": "DBM-Db2 Options", + "defaultValue": [ + "//DB2DVOPS JOB CLASS=A,", + "// MSGCLASS=X" + ] }, { - "name": "user", + "name": "work-dataset-prefix", "aliases": [ - "u" + "wdp" ], - "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options" + "group": "DBM-Db2 Options", + "defaultValue": "${user}.dbmdb2" }, { - "name": "password", + "name": "delete-work-datasets", "aliases": [ - "pass", - "pw" + "dwd" ], - "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Connection Options" + "type": "boolean", + "group": "DBM-Db2 Options", + "defaultValue": true }, { - "name": "reject-unauthorized", + "name": "overwrite-output-files", "aliases": [ - "ru" + "oof" ], - "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, "type": "boolean", - "defaultValue": true, - "group": "DBM-Db2 Connection Options" + "group": "DBM-Db2 Options", + "defaultValue": false }, { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Connection Options", - "defaultValue": "https", - "aliases": [] + "group": "DBM-Db2 Options", + "defaultValue": "${user}" }, { - "name": "environment-list", + "name": "sqlid", "aliases": [ - "el" + "s" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options", - "defaultValue": { - "ssid1": "env1@host1:port1", - "ssid2": "env2@host2:port2" - } + "group": "DBM-Db2 Options", + "defaultValue": "${user}" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Options", + "defaultValue": ";" }, { "name": "overwrite", @@ -233,7 +244,7 @@ "examples": [ { "options": "profile_name1", - "description": "Create a DBM-Db2 profile named profile_name1 and default values for all the DBM-Db2-profile options" + "description": "Create a DBM-Db2 profile named profile_name1 and default values for all the options" }, { "options": "dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss", diff --git a/profiles/create/ebg.jsonc b/profiles/create/ebg.jsonc index c44e91e..4a0111b 100644 --- a/profiles/create/ebg.jsonc +++ b/profiles/create/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ebg-profile", diff --git a/profiles/create/endevor-location.jsonc b/profiles/create/endevor-location.jsonc index e74cd2d..f593384 100644 --- a/profiles/create/endevor-location.jsonc +++ b/profiles/create/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", diff --git a/profiles/create/endevor.jsonc b/profiles/create/endevor.jsonc index 8e3f04b..3a45722 100644 --- a/profiles/create/endevor.jsonc +++ b/profiles/create/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-profile", diff --git a/profiles/create/fmp.jsonc b/profiles/create/fmp.jsonc index f708d63..4b562db 100644 --- a/profiles/create/fmp.jsonc +++ b/profiles/create/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", diff --git a/profiles/create/idms.jsonc b/profiles/create/idms.jsonc index 33eae24..342e2fc 100644 --- a/profiles/create/idms.jsonc +++ b/profiles/create/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/create/mat.jsonc b/profiles/create/mat.jsonc index 4bf6462..1353b39 100644 --- a/profiles/create/mat.jsonc +++ b/profiles/create/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/create/omspool.jsonc b/profiles/create/omspool.jsonc index bb2401d..f4fee24 100644 --- a/profiles/create/omspool.jsonc +++ b/profiles/create/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool-profile", @@ -106,12 +106,19 @@ "type": "boolean", "group": "Options" }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -120,23 +127,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/profiles/create/ops.jsonc b/profiles/create/ops.jsonc index e21a8da..b80fe05 100644 --- a/profiles/create/ops.jsonc +++ b/profiles/create/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profile", diff --git a/profiles/create/pma.jsonc b/profiles/create/pma.jsonc index 2de6fc5..5668a73 100644 --- a/profiles/create/pma.jsonc +++ b/profiles/create/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", diff --git a/profiles/create/sysview-format.jsonc b/profiles/create/sysview-format.jsonc index 946b88c..e76d30a 100644 --- a/profiles/create/sysview-format.jsonc +++ b/profiles/create/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-format-profile", diff --git a/profiles/create/sysview.jsonc b/profiles/create/sysview.jsonc index e0f85e6..2e5124d 100644 --- a/profiles/create/sysview.jsonc +++ b/profiles/create/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profile", diff --git a/profiles/delete/ca7.jsonc b/profiles/delete/ca7.jsonc index fbe1cd2..5fbf998 100644 --- a/profiles/delete/ca7.jsonc +++ b/profiles/delete/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/delete/caview.jsonc b/profiles/delete/caview.jsonc index a8e1034..5486fd9 100644 --- a/profiles/delete/caview.jsonc +++ b/profiles/delete/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", diff --git a/profiles/delete/dbm-db2-options.jsonc b/profiles/delete/dbm-db2-options.jsonc new file mode 100644 index 0000000..b4c417d --- /dev/null +++ b/profiles/delete/dbm-db2-options.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-options-profile", + "aliases": [ + "dbm-db2-options" + ], + "summary": "Delete a dbm-db2-options profile.", + "description": "Delete a dbm-db2-options profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", + "type": "command", + "handler": "", + "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", + "customize": { + "profileTypeIdentifier": "dbm-db2-options" + }, + "options": [ + { + "name": "force", + "aliases": [], + "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", + "type": "boolean", + "required": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the dbm-db2-options profile to be deleted. You can also load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "profilename", + "description": "Delete a dbm-db2-options profile named profilename" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/delete/dbm-db2.jsonc b/profiles/delete/dbm-db2.jsonc index fa597a7..a8722c6 100644 --- a/profiles/delete/dbm-db2.jsonc +++ b/profiles/delete/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2-profile", diff --git a/profiles/delete/ebg.jsonc b/profiles/delete/ebg.jsonc index 840e6c4..3ab3187 100644 --- a/profiles/delete/ebg.jsonc +++ b/profiles/delete/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ebg-profile", diff --git a/profiles/delete/endevor-location.jsonc b/profiles/delete/endevor-location.jsonc index ecffb26..090a0ec 100644 --- a/profiles/delete/endevor-location.jsonc +++ b/profiles/delete/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", diff --git a/profiles/delete/endevor.jsonc b/profiles/delete/endevor.jsonc index c76e146..7d1e084 100644 --- a/profiles/delete/endevor.jsonc +++ b/profiles/delete/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-profile", diff --git a/profiles/delete/fmp.jsonc b/profiles/delete/fmp.jsonc index 03fe12d..b5b486c 100644 --- a/profiles/delete/fmp.jsonc +++ b/profiles/delete/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", diff --git a/profiles/delete/idms.jsonc b/profiles/delete/idms.jsonc index 8bbdd54..10d1062 100644 --- a/profiles/delete/idms.jsonc +++ b/profiles/delete/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/delete/mat.jsonc b/profiles/delete/mat.jsonc index 2aee2aa..29527bd 100644 --- a/profiles/delete/mat.jsonc +++ b/profiles/delete/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/delete/omspool.jsonc b/profiles/delete/omspool.jsonc index c1262e3..bdc7d0f 100644 --- a/profiles/delete/omspool.jsonc +++ b/profiles/delete/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool-profile", @@ -22,12 +22,19 @@ "required": false, "group": "Options" }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -36,23 +43,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/profiles/delete/ops.jsonc b/profiles/delete/ops.jsonc index 6c931c7..eaada51 100644 --- a/profiles/delete/ops.jsonc +++ b/profiles/delete/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profile", diff --git a/profiles/delete/pma.jsonc b/profiles/delete/pma.jsonc index 6388654..cc1222d 100644 --- a/profiles/delete/pma.jsonc +++ b/profiles/delete/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", diff --git a/profiles/delete/sysview-format.jsonc b/profiles/delete/sysview-format.jsonc index b7b51e1..7778657 100644 --- a/profiles/delete/sysview-format.jsonc +++ b/profiles/delete/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-format-profile", diff --git a/profiles/delete/sysview.jsonc b/profiles/delete/sysview.jsonc index be71701..a094beb 100644 --- a/profiles/delete/sysview.jsonc +++ b/profiles/delete/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profile", diff --git a/profiles/list/ca7.jsonc b/profiles/list/ca7.jsonc index 02b2ce3..3024a27 100644 --- a/profiles/list/ca7.jsonc +++ b/profiles/list/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profiles", diff --git a/profiles/list/caview.jsonc b/profiles/list/caview.jsonc index 3ccd980..6a6436d 100644 --- a/profiles/list/caview.jsonc +++ b/profiles/list/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profiles", diff --git a/profiles/list/dbm-db2-options.jsonc b/profiles/list/dbm-db2-options.jsonc new file mode 100644 index 0000000..ee5347f --- /dev/null +++ b/profiles/list/dbm-db2-options.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-options-profiles", + "aliases": [ + "dbm-db2-options" + ], + "summary": "List profiles of the type dbm-db2-options.", + "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config list' command", + "customize": { + "profileTypeIdentifier": "dbm-db2-options" + }, + "options": [ + { + "name": "show-contents", + "aliases": [ + "sc" + ], + "description": "List dbm-db2-options profiles and their contents. All profile details will be printed as part of command output.", + "type": "boolean", + "required": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type dbm-db2-options" + }, + { + "options": "--sc", + "description": "List profiles of type dbm-db2-options and display their contents" + } + ], + "positionals": [], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/list/dbm-db2.jsonc b/profiles/list/dbm-db2.jsonc index 7f3d24b..467bc6d 100644 --- a/profiles/list/dbm-db2.jsonc +++ b/profiles/list/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2-profiles", diff --git a/profiles/list/ebg.jsonc b/profiles/list/ebg.jsonc index 7a2536d..2be6293 100644 --- a/profiles/list/ebg.jsonc +++ b/profiles/list/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ebg-profiles", diff --git a/profiles/list/endevor-location.jsonc b/profiles/list/endevor-location.jsonc index d9a7a22..2c02183 100644 --- a/profiles/list/endevor-location.jsonc +++ b/profiles/list/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profiles", diff --git a/profiles/list/endevor.jsonc b/profiles/list/endevor.jsonc index 7d6dc52..7f6e3ca 100644 --- a/profiles/list/endevor.jsonc +++ b/profiles/list/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-profiles", diff --git a/profiles/list/fmp.jsonc b/profiles/list/fmp.jsonc index 41f82c4..f65f2f6 100644 --- a/profiles/list/fmp.jsonc +++ b/profiles/list/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profiles", diff --git a/profiles/list/idms.jsonc b/profiles/list/idms.jsonc index 5158f16..3efe73e 100644 --- a/profiles/list/idms.jsonc +++ b/profiles/list/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profiles", diff --git a/profiles/list/mat.jsonc b/profiles/list/mat.jsonc index f26408b..4a3bfd1 100644 --- a/profiles/list/mat.jsonc +++ b/profiles/list/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profiles", diff --git a/profiles/list/omspool.jsonc b/profiles/list/omspool.jsonc index f7bf12a..48bcc42 100644 --- a/profiles/list/omspool.jsonc +++ b/profiles/list/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool-profiles", @@ -24,12 +24,19 @@ "required": false, "group": "Options" }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -38,23 +45,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/profiles/list/ops.jsonc b/profiles/list/ops.jsonc index f32b275..47f5b38 100644 --- a/profiles/list/ops.jsonc +++ b/profiles/list/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profiles", diff --git a/profiles/list/pma.jsonc b/profiles/list/pma.jsonc index 71ca4fc..e8d4b96 100644 --- a/profiles/list/pma.jsonc +++ b/profiles/list/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profiles", diff --git a/profiles/list/sysview-format.jsonc b/profiles/list/sysview-format.jsonc index c9fd888..c527409 100644 --- a/profiles/list/sysview-format.jsonc +++ b/profiles/list/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-format-profiles", diff --git a/profiles/list/sysview.jsonc b/profiles/list/sysview.jsonc index 6a7294d..2b58bf2 100644 --- a/profiles/list/sysview.jsonc +++ b/profiles/list/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profiles", diff --git a/profiles/set-default/ca7.jsonc b/profiles/set-default/ca7.jsonc index 2197596..acf7056 100644 --- a/profiles/set-default/ca7.jsonc +++ b/profiles/set-default/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/set-default/caview.jsonc b/profiles/set-default/caview.jsonc index d4de6f3..c50a986 100644 --- a/profiles/set-default/caview.jsonc +++ b/profiles/set-default/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", diff --git a/profiles/set-default/dbm-db2-options.jsonc b/profiles/set-default/dbm-db2-options.jsonc new file mode 100644 index 0000000..8c2edbe --- /dev/null +++ b/profiles/set-default/dbm-db2-options.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-options-profile", + "aliases": [ + "dbm-db2-options" + ], + "summary": "Set the default\n profiles for the dbm-db2-options group", + "description": "The dbm-db2-options set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2-options command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config set' command", + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the dbm-db2-options group. When you issue commands within the dbm-db2-options group without a profile specified as part of the command, the default will be loaded instead.", + "type": "string", + "required": true + } + ], + "customize": { + "profileTypeIdentifier": "dbm-db2-options" + }, + "examples": [ + { + "options": "profilename", + "description": "Set the default profile for type dbm-db2-options to the profile named 'profilename'" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/set-default/dbm-db2.jsonc b/profiles/set-default/dbm-db2.jsonc index 9d2dbae..c2575fa 100644 --- a/profiles/set-default/dbm-db2.jsonc +++ b/profiles/set-default/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2-profile", diff --git a/profiles/set-default/ebg.jsonc b/profiles/set-default/ebg.jsonc index 22ccb8e..a5e9123 100644 --- a/profiles/set-default/ebg.jsonc +++ b/profiles/set-default/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ebg-profile", diff --git a/profiles/set-default/endevor-location.jsonc b/profiles/set-default/endevor-location.jsonc index fd58e3f..f0bf5a3 100644 --- a/profiles/set-default/endevor-location.jsonc +++ b/profiles/set-default/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", diff --git a/profiles/set-default/endevor.jsonc b/profiles/set-default/endevor.jsonc index 93a56ab..60ea35e 100644 --- a/profiles/set-default/endevor.jsonc +++ b/profiles/set-default/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-profile", diff --git a/profiles/set-default/fmp.jsonc b/profiles/set-default/fmp.jsonc index eb83a9f..26ae367 100644 --- a/profiles/set-default/fmp.jsonc +++ b/profiles/set-default/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", diff --git a/profiles/set-default/idms.jsonc b/profiles/set-default/idms.jsonc index b662c05..41bcc30 100644 --- a/profiles/set-default/idms.jsonc +++ b/profiles/set-default/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/set-default/mat.jsonc b/profiles/set-default/mat.jsonc index 4a23afc..bf4fa61 100644 --- a/profiles/set-default/mat.jsonc +++ b/profiles/set-default/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/set-default/omspool.jsonc b/profiles/set-default/omspool.jsonc index 39c682c..992b013 100644 --- a/profiles/set-default/omspool.jsonc +++ b/profiles/set-default/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool-profile", @@ -11,12 +11,19 @@ "handler": "", "deprecatedReplacement": "The 'config set' command", "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -25,23 +32,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/profiles/set-default/ops.jsonc b/profiles/set-default/ops.jsonc index 41c11f2..ab56b81 100644 --- a/profiles/set-default/ops.jsonc +++ b/profiles/set-default/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profile", diff --git a/profiles/set-default/pma.jsonc b/profiles/set-default/pma.jsonc index a6b4fb4..a35426a 100644 --- a/profiles/set-default/pma.jsonc +++ b/profiles/set-default/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", diff --git a/profiles/set-default/sysview-format.jsonc b/profiles/set-default/sysview-format.jsonc index 5abf452..0fd3cdd 100644 --- a/profiles/set-default/sysview-format.jsonc +++ b/profiles/set-default/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-format-profile", diff --git a/profiles/set-default/sysview.jsonc b/profiles/set-default/sysview.jsonc index 96f9326..29ae7a3 100644 --- a/profiles/set-default/sysview.jsonc +++ b/profiles/set-default/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profile", diff --git a/profiles/update/ca7.jsonc b/profiles/update/ca7.jsonc index e72fd85..39b7140 100644 --- a/profiles/update/ca7.jsonc +++ b/profiles/update/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/update/caview.jsonc b/profiles/update/caview.jsonc index d4ac635..a016060 100644 --- a/profiles/update/caview.jsonc +++ b/profiles/update/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", diff --git a/profiles/update/dbm-db2-options.jsonc b/profiles/update/dbm-db2-options.jsonc new file mode 100644 index 0000000..0922372 --- /dev/null +++ b/profiles/update/dbm-db2-options.jsonc @@ -0,0 +1,304 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-options-profile", + "aliases": [ + "dbm-db2-options" + ], + "summary": "Update a dbm-db2-options profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", + "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config set' command", + "customize": { + "profileTypeIdentifier": "dbm-db2-options" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "change-set-values", + "aliases": [ + "csv" + ], + "description": "Specifies the global change specifications that modify Db2 object attributes during a command execution.\n\n Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. ", + "required": false, + "type": "array", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "id", + "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options", + "aliases": [] + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "match-set", + "aliases": [ + "ms" + ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "match-set-values", + "aliases": [ + "msv" + ], + "description": "Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. ", + "required": false, + "type": "array", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "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.\n \n For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "rule-set", + "aliases": [ + "rs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "source-db2", + "aliases": [ + "sd" + ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "type", + "aliases": [ + "t" + ], + "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "drop", + "create" + ] + }, + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "verify", + "aliases": [ + "v" + ], + "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n Default value: no ", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "yes", + "no" + ] + }, + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "absenceImplications": null, + "implies": null, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/dbm-db2.jsonc b/profiles/update/dbm-db2.jsonc index 27a9399..4528edf 100644 --- a/profiles/update/dbm-db2.jsonc +++ b/profiles/update/dbm-db2.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "dbm-db2-profile", @@ -23,167 +23,179 @@ ], "options": [ { - "name": "job-cards", + "name": "host", "aliases": [ - "jc" + "H" ], - "description": "Specifies a string array of z/OS JCL JOB statements.", + "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", "required": false, - "type": "array", - "group": "DBM-Db2 Common Options", + "type": "string", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "work-dataset-prefix", + "name": "port", "aliases": [ - "wdp" + "P" ], - "description": "Specifies the prefix that is used as the high level qualifier in z/OS work data set names.", + "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", "required": false, - "type": "string", - "group": "DBM-Db2 Common Options", + "type": "number", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "authid", + "name": "user", "aliases": [ - "a" + "u" ], - "description": "Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.", + "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", "required": false, "type": "string", - "group": "DBM-Db2 Common Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "sqlid", + "name": "password", "aliases": [ - "s" + "pass", + "pw" ], - "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", "required": false, "type": "string", - "group": "DBM-Db2 Common Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements. You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", "required": false, "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Common Options", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Options", "absenceImplications": null, - "implies": null + "implies": null, + "aliases": [] }, { - "name": "overwrite-output-files", + "name": "reject-unauthorized", "aliases": [ - "oof" + "ru" ], - "description": "Specifies whether to overwrite output files when they already exist.", + "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", "required": false, "type": "boolean", - "group": "DBM-Db2 Common Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "host", + "name": "environment-list", "aliases": [ - "H" + "el" ], - "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", + "description": "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", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "port", + "name": "job-cards", "aliases": [ - "P" + "jc" ], - "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", + "description": "Specifies a string array of z/OS JCL JOB statements.", "required": false, - "type": "number", - "group": "DBM-Db2 Connection Options", + "type": "array", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "user", + "name": "work-dataset-prefix", "aliases": [ - "u" + "wdp" ], - "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "password", + "name": "delete-work-datasets", "aliases": [ - "pass", - "pw" + "dwd" ], - "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", "required": false, - "type": "string", - "group": "DBM-Db2 Connection Options", + "type": "boolean", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "reject-unauthorized", + "name": "overwrite-output-files", "aliases": [ - "ru" + "oof" ], - "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", + "description": "Specifies whether to overwrite output files if they exist.", "required": false, "type": "boolean", - "group": "DBM-Db2 Connection Options", + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, { - "name": "protocol", - "description": "Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.", + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", "required": false, "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "DBM-Db2 Connection Options", + "group": "DBM-Db2 Options", "absenceImplications": null, - "implies": null, - "aliases": [] + "implies": null }, { - "name": "environment-list", + "name": "sqlid", "aliases": [ - "el" + "s" ], - "description": "Specifies an object of one or more values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through 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", + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", "required": false, "type": "string", - "group": "DBM-Db2 Connection Options", + "group": "DBM-Db2 Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 Options", "absenceImplications": null, "implies": null }, diff --git a/profiles/update/ebg.jsonc b/profiles/update/ebg.jsonc index 04e0246..554771c 100644 --- a/profiles/update/ebg.jsonc +++ b/profiles/update/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ebg-profile", diff --git a/profiles/update/endevor-location.jsonc b/profiles/update/endevor-location.jsonc index 343d5e5..b1bcf19 100644 --- a/profiles/update/endevor-location.jsonc +++ b/profiles/update/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", diff --git a/profiles/update/endevor.jsonc b/profiles/update/endevor.jsonc index 667990f..5e15487 100644 --- a/profiles/update/endevor.jsonc +++ b/profiles/update/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-profile", diff --git a/profiles/update/fmp.jsonc b/profiles/update/fmp.jsonc index 5776ff4..081ceac 100644 --- a/profiles/update/fmp.jsonc +++ b/profiles/update/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", diff --git a/profiles/update/idms.jsonc b/profiles/update/idms.jsonc index d0248bd..a808480 100644 --- a/profiles/update/idms.jsonc +++ b/profiles/update/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/update/mat.jsonc b/profiles/update/mat.jsonc index 08a29ce..4498cfd 100644 --- a/profiles/update/mat.jsonc +++ b/profiles/update/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/update/omspool.jsonc b/profiles/update/omspool.jsonc index edd8382..175cfa8 100644 --- a/profiles/update/omspool.jsonc +++ b/profiles/update/omspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "omspool-profile", @@ -98,12 +98,19 @@ "absenceImplications": null, "implies": null }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ "rfj" ], - "group": "Global options", + "group": "Global Options", "description": "Produce JSON formatted data from a command", "type": "boolean" }, @@ -112,23 +119,16 @@ "aliases": [ "h" ], - "group": "Global options", + "group": "Global Options", "description": "Display help text", "type": "boolean" }, - { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, { "name": "help-web", "aliases": [ "hw" ], - "group": "Global options", + "group": "Global Options", "description": "Display HTML help in browser", "type": "boolean" } diff --git a/profiles/update/ops.jsonc b/profiles/update/ops.jsonc index ef8e351..976c49e 100644 --- a/profiles/update/ops.jsonc +++ b/profiles/update/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profile", diff --git a/profiles/update/pma.jsonc b/profiles/update/pma.jsonc index cbd47da..a970b81 100644 --- a/profiles/update/pma.jsonc +++ b/profiles/update/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", diff --git a/profiles/update/sysview-format.jsonc b/profiles/update/sysview-format.jsonc index 597b49c..648d482 100644 --- a/profiles/update/sysview-format.jsonc +++ b/profiles/update/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-format-profile", diff --git a/profiles/update/sysview.jsonc b/profiles/update/sysview.jsonc index 16094c0..69b3ebb 100644 --- a/profiles/update/sysview.jsonc +++ b/profiles/update/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2023 Broadcom. All Rights Reserved. The term +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profile",