From a83623ad5d52d4e8b9d46fd4d30e9eb2e56e40c0 Mon Sep 17 00:00:00 2001 From: Timothy Johnson Date: Tue, 16 Aug 2022 14:59:03 -0400 Subject: [PATCH] Update Broadcom plugin help for Zowe 1.28.1 Signed-off-by: Timothy Johnson --- commandGroups/ca7.jsonc | 2 +- commandGroups/caspool.jsonc | 50 +- commandGroups/caview.jsonc | 1854 ++++++++--- commandGroups/dbm-db2.jsonc | 2289 +++++++++++++ commandGroups/endevor-bridge-for-git.jsonc | 3334 +++++-------------- commandGroups/endevor.jsonc | 2 +- commandGroups/file-master-plus.jsonc | 130 +- commandGroups/idms.jsonc | 349 +- commandGroups/jclcheck.jsonc | 2 +- commandGroups/mat-pma-util.jsonc | 6 +- commandGroups/mat.jsonc | 84 +- commandGroups/ops.jsonc | 90 +- commandGroups/sysview.jsonc | 16 +- profiles/create/ca7.jsonc | 2 +- profiles/create/caspool.jsonc | 22 +- profiles/create/caview.jsonc | 41 +- profiles/create/dbm-db2.jsonc | 246 ++ profiles/create/ebg.jsonc | 2 +- profiles/create/endevor-location.jsonc | 36 +- profiles/create/endevor.jsonc | 2 +- profiles/create/fmp.jsonc | 10 +- profiles/create/idms.jsonc | 4 +- profiles/create/jclcheck.jsonc | 2 +- profiles/create/mat.jsonc | 16 +- profiles/create/ops.jsonc | 10 +- profiles/create/pma.jsonc | 4 +- profiles/create/sysview-format.jsonc | 2 +- profiles/create/sysview.jsonc | 2 +- profiles/delete/ca7.jsonc | 2 +- profiles/delete/caspool.jsonc | 2 +- profiles/delete/caview.jsonc | 2 +- profiles/delete/dbm-db2.jsonc | 75 + 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/jclcheck.jsonc | 2 +- profiles/delete/mat.jsonc | 2 +- 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/caspool.jsonc | 4 +- profiles/list/caview.jsonc | 4 +- profiles/list/dbm-db2.jsonc | 74 + profiles/list/ebg.jsonc | 2 +- profiles/list/endevor-location.jsonc | 4 +- profiles/list/endevor.jsonc | 2 +- profiles/list/fmp.jsonc | 4 +- profiles/list/idms.jsonc | 2 +- profiles/list/jclcheck.jsonc | 2 +- profiles/list/mat.jsonc | 4 +- profiles/list/ops.jsonc | 2 +- profiles/list/pma.jsonc | 4 +- profiles/list/sysview-format.jsonc | 2 +- profiles/list/sysview.jsonc | 2 +- profiles/set-default/ca7.jsonc | 2 +- profiles/set-default/caspool.jsonc | 2 +- profiles/set-default/caview.jsonc | 2 +- profiles/set-default/dbm-db2.jsonc | 67 + 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/jclcheck.jsonc | 2 +- profiles/set-default/mat.jsonc | 2 +- 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/caspool.jsonc | 30 +- profiles/update/caview.jsonc | 29 +- profiles/update/dbm-db2.jsonc | 236 ++ profiles/update/ebg.jsonc | 2 +- profiles/update/endevor-location.jsonc | 32 +- profiles/update/endevor.jsonc | 2 +- profiles/update/fmp.jsonc | 10 +- profiles/update/idms.jsonc | 4 +- profiles/update/jclcheck.jsonc | 2 +- profiles/update/mat.jsonc | 12 +- profiles/update/ops.jsonc | 2 +- profiles/update/pma.jsonc | 4 +- profiles/update/sysview-format.jsonc | 2 +- profiles/update/sysview.jsonc | 2 +- 88 files changed, 5897 insertions(+), 3395 deletions(-) create mode 100644 commandGroups/dbm-db2.jsonc create mode 100644 profiles/create/dbm-db2.jsonc create mode 100644 profiles/delete/dbm-db2.jsonc create mode 100644 profiles/list/dbm-db2.jsonc create mode 100644 profiles/set-default/dbm-db2.jsonc create mode 100644 profiles/update/dbm-db2.jsonc diff --git a/commandGroups/ca7.jsonc b/commandGroups/ca7.jsonc index 7cc399d..7f81e60 100644 --- a/commandGroups/ca7.jsonc +++ b/commandGroups/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7", diff --git a/commandGroups/caspool.jsonc b/commandGroups/caspool.jsonc index d2fa52b..2504a05 100644 --- a/commandGroups/caspool.jsonc +++ b/commandGroups/caspool.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool", - "description": "Interact with CA Spool™", + "description": "Interact with Spool™", "type": "group", "children": [ { @@ -10,8 +10,8 @@ "aliases": [ "is" ], - "summary": "Issue CA Spool commands.", - "description": "Issue CA Spool commands.", + "summary": "Issue Spool commands.", + "description": "Issue Spool commands.", "type": "group", "children": [ { @@ -19,8 +19,8 @@ "aliases": [ "cmd" ], - "summary": "Issue commands to work with CA Spool.", - "description": "Issue commands to work with CA Spool.", + "summary": "Issue commands to work with Spool.", + "description": "Issue commands to work with Spool.", "type": "command", "handler": "", "profile": { @@ -34,13 +34,13 @@ { "name": "commandText", "type": "string", - "description": "The CA Spool command to issue.", + "description": "The Spool command to issue.", "required": true } ], "examples": [ { - "description": "Issue the CA Spool command 'DS' to display the status of the ESF system", + "description": "Issue the Spool command 'DS' to display the status of the ESF system", "options": "\"DS\"" } ], @@ -53,10 +53,10 @@ "a" ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "High level qualifier of CA Spool installation.", + "description": "High level qualifier of Spool installation.", "type": "string", "name": "spoolhlq", "aliases": [ @@ -67,10 +67,10 @@ 35 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "CA Spool subsystem name.", + "description": "Spool subsystem name.", "type": "string", "name": "subsys", "aliases": [ @@ -81,10 +81,10 @@ 4 ], "defaultValue": "ESF", - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with CA Spool.", + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", "type": "string", "name": "outds", "aliases": [ @@ -95,7 +95,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { "description": "The data set containing ESFZOWE REXX exec.", @@ -109,7 +109,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { "name": "host", @@ -296,10 +296,10 @@ "a" ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "High level qualifier of CA Spool installation.", + "description": "High level qualifier of Spool installation.", "type": "string", "name": "spoolhlq", "aliases": [ @@ -310,10 +310,10 @@ 35 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "CA Spool subsystem name.", + "description": "Spool subsystem name.", "type": "string", "name": "subsys", "aliases": [ @@ -324,10 +324,10 @@ 4 ], "defaultValue": "ESF", - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with CA Spool.", + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", "type": "string", "name": "outds", "aliases": [ @@ -338,7 +338,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { "description": "The data set containing ESFZOWE REXX exec.", @@ -352,7 +352,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" } ], "merge": true, @@ -499,7 +499,7 @@ "positionals": [] } ], - "summary": "CA Spool™ Plug-in for Zowe™ CLI", + "summary": "Spool™ Plug-in for Zowe™ CLI", "aliases": [ "esf" ], diff --git a/commandGroups/caview.jsonc b/commandGroups/caview.jsonc index 86e145d..1046f72 100644 --- a/commandGroups/caview.jsonc +++ b/commandGroups/caview.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview", - "description": "Access CA View data and perform related tasks.", + "description": "Access View data and perform related tasks.", "type": "group", "children": [ { @@ -10,8 +10,8 @@ "aliases": [ "dl" ], - "summary": "Download CA View report data to local folder.", - "description": "Download CA View report data to local folder.", + "summary": "Download View report data to local folder.", + "description": "Download View report data to local folder.", "type": "group", "children": [ { @@ -129,6 +129,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -190,15 +257,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -208,16 +266,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -262,10 +310,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -273,6 +319,82 @@ "children": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -309,16 +431,15 @@ "type": "boolean" } ], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "export", "aliases": [ "exp" ], - "summary": "Export CA View text report file to local folder.", - "description": "Export CA View text report file to local folder.", + "summary": "Export View text report file to local folder.", + "description": "Export View text report file to local folder.", "type": "group", "children": [ { @@ -371,6 +492,73 @@ "group": "Options", "aliases": [] }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -432,15 +620,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -450,16 +629,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -504,10 +673,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -515,6 +682,82 @@ "children": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -551,13 +794,12 @@ "type": "boolean" } ], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "get", - "summary": "Get information from CA View repository.", - "description": "Get information from CA View repository.", + "summary": "Get information from View repository.", + "description": "Get information from View repository.", "type": "group", "children": [ { @@ -625,6 +867,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -686,15 +995,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -704,16 +1004,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -758,10 +1048,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -811,6 +1099,82 @@ "passOn": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -848,16 +1212,15 @@ } ], "aliases": [], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "list", "aliases": [ "ls" ], - "summary": "List CA View repository, report, and user information.", - "description": "List CA View repository, report, and user information.", + "summary": "List View repository, report, and user information.", + "description": "List View repository, report, and user information.", "type": "group", "children": [ { @@ -935,6 +1298,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -996,15 +1426,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -1014,16 +1435,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -1068,10 +1479,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -1201,6 +1610,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -1262,15 +1738,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -1280,16 +1747,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -1334,10 +1791,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -1423,6 +1878,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -1484,15 +2006,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -1502,16 +2015,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -1556,10 +2059,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -1643,6 +2144,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -1704,15 +2272,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -1722,16 +2281,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -1776,10 +2325,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -1866,6 +2413,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -1927,15 +2541,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -1945,16 +2550,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -1999,10 +2594,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -2078,42 +2671,109 @@ "output" ], "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", + "description": "Output format. This option is ignored if '--response-format-json' is specified.", + "allowableValues": { + "values": [ + "^tabular$", + "^csv$", + "^json$", + "^xml$" + ], + "caseSensitive": false + }, + "defaultValue": "tabular", + "group": "Options" + }, + { + "name": "output-header", + "aliases": [ + "header" + ], + "type": "boolean", + "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", + "defaultValue": true, + "group": "Options" + }, + { + "name": "output-field", + "aliases": [ + "f" + ], + "type": "array", + "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Identifier,Name,Description,Owner,Public", + "defaultValue": [ + "Identifier", + "Name", + "Description" + ], + "group": "Options" + }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, "allowableValues": { "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" + "http", + "https" ], "caseSensitive": false }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Identifier,Name,Description,Owner,Public", - "defaultValue": [ - "Identifier", - "Name", - "Description" - ], - "group": "Options" + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] }, { "name": "response-format-json", @@ -2176,15 +2836,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -2194,16 +2845,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -2248,10 +2889,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -2259,6 +2898,82 @@ "children": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -2295,16 +3010,15 @@ "type": "boolean" } ], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "search", "aliases": [ "find" ], - "summary": "Search data in a CA View repository.", - "description": "Search data in a CA View repository.", + "summary": "Search data in a View repository.", + "description": "Search data in a View repository.", "type": "group", "children": [ { @@ -2440,6 +3154,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -2501,15 +3282,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -2519,16 +3291,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -2573,10 +3335,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -2717,6 +3477,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -2778,15 +3605,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -2796,16 +3614,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -2850,10 +3658,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -2979,21 +3785,88 @@ { "name": "output-field", "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days", - "defaultValue": [ - "ReportName", - "Lines", - "Pages", - "Type", - "ArchivalDate", - "Description", - "UserComments", - "ReportHandle" + "f" + ], + "type": "array", + "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days", + "defaultValue": [ + "ReportName", + "Lines", + "Pages", + "Type", + "ArchivalDate", + "Description", + "UserComments", + "ReportHandle" + ], + "group": "Options" + }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" ], - "group": "Options" + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] }, { "name": "response-format-json", @@ -3056,15 +3929,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -3074,16 +3938,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -3128,10 +3982,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -3181,6 +4033,82 @@ "passOn": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -3217,13 +4145,12 @@ "type": "boolean" } ], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "set", - "summary": "Set information in CA View repository.", - "description": "Set information in CA View repository.", + "summary": "Set information in View repository.", + "description": "Set information in View repository.", "type": "group", "children": [ { @@ -3298,6 +4225,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -3359,15 +4353,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -3377,16 +4362,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -3431,10 +4406,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -3511,6 +4484,73 @@ ], "group": "Options" }, + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options", + "aliases": [] + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options", + "aliases": [] + }, { "name": "response-format-json", "aliases": [ @@ -3572,15 +4612,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port number of service on the mainframe.", - "type": "number", - "group": "Base Connection Options" - }, { "name": "user", "aliases": [ @@ -3590,16 +4621,6 @@ "type": "string", "group": "Base Connection Options" }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, { "name": "reject-unauthorized", "aliases": [ @@ -3644,10 +4665,8 @@ } ], "profile": { - "required": [ - "caview" - ], "optional": [ + "caview", "base" ] }, @@ -3697,6 +4716,82 @@ "passOn": [] } ], + "passOn": [ + { + "property": "options", + "value": [ + { + "type": "string", + "name": "hostname", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", + "numericValueRange": [ + 0, + 65535 + ], + "required": false, + "defaultValue": 443, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "username", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "View Connection Options" + }, + { + "type": "string", + "name": "base-path", + "description": "Context name of the target View REST API instance.", + "required": false, + "defaultValue": "web-viewer", + "group": "View Connection Options" + }, + { + "type": "string", + "name": "protocol", + "description": "Protocol of the target View REST API instance.", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "defaultValue": "https", + "group": "View Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], "options": [ { "name": "response-format-json", @@ -3734,11 +4829,10 @@ } ], "aliases": [], - "positionals": [], - "passOn": [] + "positionals": [] } ], - "summary": "Access CA View data and perform related tasks.", + "summary": "Access View data and perform related tasks.", "aliases": [ "cv" ], diff --git a/commandGroups/dbm-db2.jsonc b/commandGroups/dbm-db2.jsonc new file mode 100644 index 0000000..2deca21 --- /dev/null +++ b/commandGroups/dbm-db2.jsonc @@ -0,0 +1,2289 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2", + "description": "dbm-db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.", + "type": "group", + "children": [ + { + "name": "check", + "description": "Perform DDL syntax checking.", + "type": "group", + "children": [ + { + "name": "ddl", + "description": "Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally 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. You can generate input DDL using the 'zowe dbm-db2 generate ddl' command.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem ID where you want to validate the DDL.", + "type": "string", + "aliases": [ + "td" + ], + "required": true, + "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" + ], + "allowableValues": { + "values": [ + "yes", + "no" + ] + }, + "required": false, + "group": "Options" + }, + { + "name": "modification", + "description": "Identifies an existing 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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-ddl-filename", + "description": "Specifies the local input file that contains the DDL statements for the Db2 objects that you want to validate on a target subsystem. Typically, this file is created by a 'zowe dbm-db2 generate ddl' command or retrieved from an archive. You can edit this file. ", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "sample.sql --target-db2 TEST", + "description": "Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem" + }, + { + "options": "sample.sql --target-db2 TEST --verify yes", + "description": "Validate DDL statement syntax and verify object dependencies" + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "compare", + "description": "Compare DDL with a Db2 subsystem and produce an update script to implement changes.", + "type": "group", + "children": [ + { + "name": "ddl", + "description": "Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a summary report that provides a high-level overview of the changes. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem ID where the objects that you are comparing reside.", + "type": "string", + "aliases": [ + "td" + ], + "required": true, + "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\n For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n\n Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "ms" + ], + "required": false, + "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\n STOGROUP \n DATABASE \n TABLESPACE \n TABLE \n INDEX \n VIEW \n SYNONYM \n ALIAS \n TRIGGER \n SEQUENCE \n FUNCTION \n PROCEDURE \n \n Note: must be 8 characters or less. must be 18 characters or less. The SEQUENCE must be 8 characters or less.\n \n A 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 \n Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\n Example:\n \n The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \n TABLE MY%.%TABLE YOUR%.%TABLE; \n TABLE MYN-M-.MYT% YOURN-M-.YOURT%;\n TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \n TABLE *.MYTABLE *.YOURTABLE;\n\n For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "type": "string", + "conflictsWith": [ + "match-set" + ], + "aliases": [ + "msf" + ], + "required": false, + "group": "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. The changes apply to new objects only as determined by match-set processing.\n\n\u001b[90m Format:\n\n \n \n For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "cs" + ], + "required": false, + "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. The changes apply to new objects only as determined by match-set processing. \n \n\u001b[90m Format:\n\n \n \n The 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 \n Example:\n \n The following example demonstrates changes to table’s schema (creator) and tablespace names:\n \n TBCR TEST% PROD%\n TBTS TESTTS% PRODTS%\n \n For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "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 \n For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \u001b[0m", + "type": "string", + "aliases": [ + "rs" + ], + "required": false, + "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", + "required": false, + "group": "Options", + "aliases": [] + }, + { + "name": "description", + "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", + "type": "string", + "aliases": [ + "d" + ], + "required": false, + "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", + "type": "string", + "aliases": [ + "ocs" + ], + "required": false, + "group": "Options" + }, + { + "name": "output-summary-file", + "description": "Specifies the local output file name that provides a summary of the changes to be performed to the Db2 objects on the target Db2 subsystem. The file summarizes what the changes are, but not how the changes are made.\n \n\u001b[90m Default value: summary.txt \u001b[0m", + "type": "string", + "aliases": [ + "osf" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-ddl-filename", + "description": "Specifies the local input file that contains DDL statements for the Db2 objects that you want to compare to Db2 objects on a target subsystem. Typically, this file is created by a 'zowe dbm-db2 generate ddl' command or retrieved from an archive. You can edit this file.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "myddl.sql --target-db2 TEST", + "description": "Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file" + }, + { + "options": "myddl.sql --target-db2 TEST --rule-set USER1.RULESET", + "description": "Generate a script to update objects and apply a rule-set for the matched objects" + }, + { + "options": "myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt", + "description": "Generate a script to update objects and apply a ruleset for the objects matched as determined by the local mask specifications in the pair.txt file" + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "deploy", + "description": "Deploy DDL statements to a Db2 subsystem.", + "type": "group", + "children": [ + { + "name": "ddl", + "description": "Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem ID.", + "type": "string", + "aliases": [ + "td" + ], + "required": true, + "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\n For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n\n Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "ms" + ], + "required": false, + "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\n STOGROUP \n DATABASE \n TABLESPACE \n TABLE \n INDEX \n VIEW \n SYNONYM \n ALIAS \n TRIGGER \n SEQUENCE \n FUNCTION \n PROCEDURE \n \n Note: must be 8 characters or less. must be 18 characters or less. The SEQUENCE must be 8 characters or less.\n \n A 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 \n Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\n Example:\n \n The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \n TABLE MY%.%TABLE YOUR%.%TABLE; \n TABLE MYN-M-.MYT% YOURN-M-.YOURT%;\n TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \n TABLE *.MYTABLE *.YOURTABLE;\n\n For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "type": "string", + "conflictsWith": [ + "match-set" + ], + "aliases": [ + "msf" + ], + "required": false, + "group": "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. The changes apply to new objects only as determined by match-set processing.\n\n\u001b[90m Format:\n\n \n \n For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "cs" + ], + "required": false, + "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. The changes apply to new objects only as determined by match-set processing. \n \n\u001b[90m Format:\n\n \n \n The 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 \n Example:\n \n The following example demonstrates changes to table’s schema (creator) and tablespace names:\n \n TBCR TEST% PROD%\n TBTS TESTTS% PRODTS%\n \n For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "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 \n For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \u001b[0m", + "type": "string", + "aliases": [ + "rs" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-ddl-filename", + "description": "Specifies the local input file that contains DDL statements for the Db2 objects that you want to deploy on a target subsystem. Typically, this file is created by a 'zowe dbm-db2 generate ddl' command or retrieved from an archive. You can edit this file.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "myddl.sql --target-db2 TEST", + "description": "Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file" + }, + { + "options": "myddl.sql --target-db2 TEST --rule-set USER1.RULESET", + "description": "Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects" + }, + { + "options": "myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt", + "description": "Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file" + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "execute", + "description": "Execute a script to implement Db2 object changes.", + "type": "group", + "children": [ + { + "name": "compare-script", + "description": "Execute the compare script that was generated with the 'zowe dbm-db2 compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.\n ", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "output-recovery-file", + "description": "Specifies the local output recovery file that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm-db2 execute script' command undoes the changes that were made by execution of the compare-script. \n \n \u001b[90m Default value: recovery.txt \u001b[0m", + "type": "string", + "aliases": [ + "orf" + ], + "required": false, + "group": "Options" + }, + { + "name": "restart", + "description": "Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain. \n \n The following restart options are valid:\n \n new - Restart execution of the script at the first statement. \n \n token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.", + "type": "string", + "aliases": [ + "r" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-compare-script-filename", + "description": "Specifies the local input compare-script file that contains the update script that was generated with the 'zowe dbm-db2 compare ddl' command.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "compare.txt", + "description": "Execute a compare script" + }, + { + "options": "compare.txt --restart new", + "description": "Restart execution of a compare script at the first statement in the script" + }, + { + "options": "compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA", + "description": "Restart execution of a compare script at the location in the token" + } + ], + "aliases": [], + "passOn": [], + "children": [] + }, + { + "name": "script", + "description": "Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm-db2 execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.\n ", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem ID where you want to execute the script. If the option is not specified, the target subsystem is identified by the first .CONNECT statement in the script. The target-db2 option value takes precedence.", + "type": "string", + "aliases": [ + "td" + ], + "required": false, + "group": "Options" + }, + { + "name": "script-section", + "description": "Identifies the location in the script where you want to begin execution. \n\n The following options are valid:\n\n name - Begin execution of the specific section and process all subsequent statements up to the next section.\n A section is a '.SYSTEM ' statement, where identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.\n \n number - Begin execution after the specific sync point (.SYNC statement) and process all statements up to the end of the script.\n \n name, number - Begin execution of the specific script section beginning from the sync point (.SYNC statement) within the section and process all subsequent statements up to the next section.", + "type": "string", + "aliases": [ + "ss" + ], + "required": false, + "group": "Options" + }, + { + "name": "restart", + "description": "Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain. \n \n The following restart options are valid:\n \n new - Restart execution of the script at the first statement.\n \n token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.\n \n name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.\n \n A section is a Batch Processor '.SYSTEM ' statement, where identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.", + "type": "string", + "aliases": [ + "r" + ], + "conflictsWith": [ + "script-section" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-bp-script-filename", + "description": "Specifies the local input file that contains the Batch Processor statements such as the recovery script that was created by executing the 'zowe dbm-db2 execute compare-script' command.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "recovery.txt", + "description": "Execute a recovery script" + }, + { + "options": "script001.txt --target-db2 TEST", + "description": "Execute a script on the 'TEST' Db2 subsystem" + }, + { + "options": "script001.txt ––script-section SQLDDL", + "description": "Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script" + }, + { + "options": "script001.txt ––script-section 10", + "description": "Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script" + }, + { + "options": "script001.txt ––script-section target,20", + "description": "Execute only the target (SQLDDL) section of the script starting at sync point 20" + }, + { + "options": "script001.txt ––restart new", + "description": "Restart execution of a script from the beginning" + }, + { + "options": "script001.txt ––restart 78A724A48DA5185D06FD140F6780D6FA", + "description": "Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm-db2 execute command' failure as part of the terminal output and in the error file" + }, + { + "options": "script001.txt ––restart target,78A724A48DA5185D06FD140F6780D6FA", + "description": "Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section" + } + ], + "aliases": [], + "passOn": [], + "children": [] + }, + { + "name": "migration-script", + "description": "Execute the migration script that was generated with the 'zowe dbm-db2 prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.\n ", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "restart", + "description": "Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain. \n \n The following restart options are valid:\n \n new - Restart execution of the script at the first statement.\n \n name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.\n \n A section is a '.SYSTEM ' statement, where identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.", + "type": "string", + "aliases": [ + "r" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [] + } + ], + "positionals": [ + { + "name": "local-input-migrate-script-filename", + "description": "Specifies the local input migration-script file that was generated with the 'zowe dbm-db2 prepare migration' command.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "migration.txt", + "description": "Execute a migration script" + }, + { + "options": "migration.txt --restart new", + "description": "Restart execution of a migration script at the first statement in the script" + }, + { + "options": "migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA", + "description": "Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section" + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "generate", + "description": "Generate DDL statements for Db2 objects.", + "type": "group", + "children": [ + { + "name": "ddl", + "description": "Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm-db2 compare ddl' command.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "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\n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "o" + ], + "group": "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\n The required clause identifies the specific Db2 (base) object:\n \n STOGROUP \n DATABASE \n TABLESPACE .\n TABLE .\n INDEX .\n VIEW .\n ALIAS .\n SYNONYM .\n MQT .\n SEQUENCE .\n TRIGGER .\n FUNCTION .[.]\n PROCEDURE .[.]\n\n The 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 \n Example:\n \n table sysibm.systables include (tablespace, database, index);\n database db1 include(children);\n\n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "of" + ], + "conflictsWith": [ + "object" + ], + "group": "Options" + }, + { + "name": "source-db2", + "description": "Specifies the source Db2 subsystem ID where the objects that you want to generate DDL for are located.", + "type": "string", + "aliases": [ + "sd" + ], + "required": true, + "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\n For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "cs" + ], + "required": false, + "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 \n The 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 \n For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Example:\n \n The following example demonstrates changes to table’s schema (creator) and tablespace names:\n \n TBCR TEST% PROD%\n TBTS TESTTS% PRODTS%\n\n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "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" + ], + "required": false, + "allowableValues": { + "values": [ + "drop", + "create" + ] + }, + "defaultValue": "create", + "group": "Options" + }, + { + "name": "output-ddl-file", + "description": "Specifies the local output file name that contains the generated DDL for the 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" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [ + { + "options": "--object \"tablespace my.tbsp include(table)\" --source-db2 SRC --output-ddl-file objects.sql", + "description": "Generate CREATE DDL statements for a tablespace and its child table" + }, + { + "options": "--object \"database my.db include(children)\" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql", + "description": "Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set" + }, + { + "options": "--object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql", + "description": "Generate DROP DDL statements only for the input object list" + } + ], + "mustSpecifyOne": [ + "object-file", + "object" + ], + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "prepare", + "description": "Prepare DDL statements and a script to migrate Db2 objects.", + "type": "group", + "children": [ + { + "name": "migration", + "description": "Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm-db2 execute migration-script' command.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "dbm-db2" + ], + "optional": [ + "base" + ], + "suppressOptions": [] + }, + "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\n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "o" + ], + "group": "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\n The required clause identifies the specific Db2 (base) object:\n \n STOGROUP \n DATABASE \n TABLESPACE .\n TABLE .\n INDEX .\n VIEW .\n ALIAS .\n SYNONYM .\n MQT .\n SEQUENCE .\n TRIGGER .\n FUNCTION .[.]\n PROCEDURE .[.]\n\n The 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 \n Example:\n \n table sysibm.systables include (tablespace, database, index);\n database db1 include(children);\n\n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "of" + ], + "conflictsWith": [ + "object" + ], + "group": "Options" + }, + { + "name": "source-db2", + "description": "Specifies the source Db2 subsystem ID where the object definitions and data that you want to migrate are located.", + "type": "string", + "aliases": [ + "sd" + ], + "required": true, + "group": "Required Options" + }, + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem ID where the object definitions and data are migrated (copied) to.", + "type": "string", + "aliases": [ + "td" + ], + "required": true, + "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\n For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig. \n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "cs" + ], + "required": false, + "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 \n The 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 \n For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig.\n \n Example:\n \n The following example demonstrates changes to table’s schema (creator) and tablespace names:\n \n TBCR TEST% PROD%\n TBTS TESTTS% PRODTS%\n \n Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "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", + "type": "string", + "aliases": [ + "oms" + ], + "required": false, + "group": "Options" + }, + { + "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", + "type": "string", + "aliases": [ + "odf" + ], + "required": false, + "group": "Options" + }, + { + "name": "modification", + "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", + "type": "string", + "aliases": [ + "m" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "description": "Specifies the local output error file that contains errors that occurred during execution of the command.\n \n \u001b[90m Default value: error.log \u001b[0m", + "type": "string", + "aliases": [ + "ef" + ], + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2-p" + ], + "group": "Profile Options", + "description": "The name of a (dbm-db2) 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": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "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": [ + { + "options": "--object \"tablespace my.tbsp include(table)\" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt", + "description": "Generate a migration script for a tablespace and its child table" + }, + { + "options": "--object \"database my.db include(children)\" --source-db2 SRC --target-db2 TRG –-change-set USER1.CHANGSET –-output-migrate-script migrate.txt --output-ddl-file objects.sql", + "description": "Generate a migration script and apply global changes" + } + ], + "mustSpecifyOne": [ + "object-file", + "object" + ], + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + } + ], + "summary": "Interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.", + "aliases": [ + "dbm" + ], + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/endevor-bridge-for-git.jsonc b/commandGroups/endevor-bridge-for-git.jsonc index 68eb85b..7af71bb 100644 --- a/commandGroups/endevor-bridge-for-git.jsonc +++ b/commandGroups/endevor-bridge-for-git.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-bridge-for-git", @@ -1455,30 +1455,65 @@ "positionals": [] }, { - "name": "endevor-connection", + "name": "endevor-credentials", "aliases": [ - "co" + "ec" ], - "summary": "Manage the stored Endevor connections.", - "description": "Manage connections to Endevor Web Services used by CA Endevor Bridge for Git.", + "summary": "Manage the stored Endevor credentials.", + "description": "Manage your Endevor credentials stored in CA Endevor Bridge for Git.", "type": "group", "children": [ { - "name": "list", + "name": "update", "aliases": [ - "ls" + "u" ], "type": "command", "handler": "", - "description": "List Endevor connections used by CA Endevor Bridge for Git.", - "summary": "List Endevor connections", + "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": [ @@ -1588,6 +1623,15 @@ "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": [ @@ -1638,173 +1682,26 @@ "type": "existingLocalFile", "group": "Base Connection Options", "aliases": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null } ], - "outputFormatOptions": true, "examples": [ { - "description": "List all the Endevor connections using the default EBG profile", - "options": "" + "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": "List all the Endevor connections without an EBG profile", - "options": "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" + "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" } ], - "positionals": [], "passOn": [], "children": [] - }, + } + ], + "passOn": [ { - "name": "create", - "aliases": [ - "c" - ], - "type": "command", - "handler": "", - "description": "Create new Endevor connection for CA Endevor Bridge for Git.", - "summary": "Create new Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The CA Endevor Web Services dataSource name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The CA Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "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": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The CA Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, + "property": "options", + "value": [ { "name": "protocol", "aliases": [ @@ -1870,1925 +1767,282 @@ "description": "Reject self-signed certificates. \n\nDefault value: false", "type": "boolean", "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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": "Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile", - "options": "MY-CONNECTION --endevor-instance INSTANCE" - }, - { - "description": "Create the Endevor connection 'MY-CONNECTION' using the default EBG profile", - "options": "MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE" - }, - { - "description": "Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile", - "options": "MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "rename", - "aliases": [ - "ren" - ], - "type": "command", - "handler": "", - "description": "Rename existing Endevor connection defined to CA Endevor Bridge for Git.", - "summary": "Rename existing Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - }, - { - "name": "new-connection", - "description": "New Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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": "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": "Rename the Endevor connection using the default EBG profile", - "options": "MY-CONNECTION NEW-NAME" - }, - { - "description": "Rename the Endevor connection without an EBG profile", - "options": "MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "type": "command", - "handler": "", - "description": "Delete existing Endevor connection defined to CA Endevor Bridge for Git.", - "summary": "Delete existing Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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": "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": "Delete the Endevor connection using the default EBG profile", - "options": "MY-CONNECTION" - }, - { - "description": "Delete the Endevor connection without an EBG profile", - "options": "MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "update-credentials", - "aliases": [ - "uc" - ], - "type": "command", - "handler": "", - "description": "Update your Endevor credentials for the Endevor connection.", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "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: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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 Endevor connection MY-CONNECTION using the default EBG and Endevor profile", - "options": "MY-CONNECTION" - }, - { - "description": "Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile", - "options": "MY-CONNECTION --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: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "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-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", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "endevor-credentials", - "aliases": [ - "ec" - ], - "summary": "Manage the stored Endevor credentials. [Deprecated]", - "description": "Manage your Endevor credentials stored in CA 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: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "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-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", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "mapping", - "aliases": [ - "m" - ], - "description": "Manage the Git-Endevor mappings.", - "type": "group", - "children": [ - { - "name": "create", - "aliases": [ - "c" - ], - "type": "command", - "handler": "", - "description": "Create a Git-Endevor mapping", - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "remote-url", - "aliases": [ - "url" - ], - "description": "Git repository remote URL", - "type": "string", - "required": false, - "conflictsWith": [ - "json-file" - ], - "group": "Options" - }, - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The CA Endevor Web Services dataSource name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The CA Endevor system where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The CA Endevor subsystem where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "system-alias", - "description": "The alias of CA Endevor system.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "subsystem-alias", - "description": "The alias of CA Endevor subsystem.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-environment", - "aliases": [ - "endevorenv" - ], - "description": "The CA Endevor environment where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "branch", - "aliases": [ - "b" - ], - "description": "Name of the synchronized branch in the Git repository.", - "type": "string", - "defaultValue": "master", - "group": "Options" - }, - { - "name": "only-work-environment", - "description": "If specified, only elements from the Endevor work environment will be synchronized.", - "type": "boolean", - "defaultValue": 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.", - "type": "boolean", - "required": false, - "implies": [ - "endevor-stage-number" - ], - "conflictsWith": [ - "json-file" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-stage-number", - "aliases": [ - "endevorsn" - ], - "description": "The CA Endevor stage where your project resides (only for read only mappings).", - "type": "string", - "implies": [ - "read-only" - ], - "conflictsWith": [ - "json-file" - ], - "group": "Options" - }, - { - "name": "type-filter", - "description": "Type filter", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "json-file", - "aliases": [ - "json" - ], - "description": "Mapping JSON file to import", - "type": "existingLocalFile", - "required": false, - "conflictsWith": [ - "remote-url", - "endevor-stage-number", - "read-only", - "endevor-instance", - "endevor-environment", - "endevor-environment", - "endevor-system", - "endevor-subsystem" - ], - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The CA Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "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": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The CA Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "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: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA 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": "CA 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": "CA 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": "CA 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": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "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-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", - "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": "Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME " - }, - { - "description": "Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME " - }, - { - "description": "Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2" - }, - { - "description": "Create the Git-Endevor mapping with importing a mapping file", - "options": "--json-file my-mapping.json " - } + "merge": true + } + ], + "options": [ + { + "name": "response-format-json", + "aliases": [ + "rfj" ], - "positionals": [], - "passOn": [], - "children": [] + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" }, { - "name": "delete", + "name": "help", "aliases": [ - "del" + "h" + ], + "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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "mapping", + "aliases": [ + "m" + ], + "description": "Manage the Git-Endevor mappings.", + "type": "group", + "children": [ + { + "name": "create", + "aliases": [ + "c" ], "type": "command", "handler": "", - "description": "Delete 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 - } - ], + "description": "Create a Git-Endevor mapping", "profile": { "optional": [ "ebg", + "endevor", "base" ] }, - "examples": [ - { - "description": "Delete the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile", - "options": "MY-CONTEXT MY-MAPPING" - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, + "options": [ { - "name": "port", + "name": "remote-url", "aliases": [ - "P" + "url" ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + "description": "Git repository remote URL", + "type": "string", + "required": false, + "conflictsWith": [ + "json-file" + ], + "group": "Options" }, { - "name": "user", + "name": "endevor-instance", "aliases": [ - "u" + "endevori" ], - "description": "Endevor Bridge for Git username (your git username).", + "description": "The CA Endevor Web Services dataSource name.", "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + "required": false, + "group": "Options" }, { - "name": "token", + "name": "endevor-system", "aliases": [ - "t" + "endevorsys" ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", + "description": "The CA Endevor system where your project resides.", "type": "string", - "required": true, - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "Options" }, { - "name": "reject-unauthorized", + "name": "endevor-subsystem", "aliases": [ - "ru" + "endevorsub" ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + "description": "The CA Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "Options" }, { - "name": "response-format-json", + "name": "endevor-environment", "aliases": [ - "rfj" + "endevorenv" ], - "group": "Global options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" + "description": "The CA Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "Options" }, { - "name": "help", + "name": "branch", "aliases": [ - "h" + "b" ], - "group": "Global options", - "description": "Display help text", - "type": "boolean" + "description": "Name of the synchronized branch in the Git repository.", + "type": "string", + "defaultValue": "master", + "group": "Options" }, { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", + "name": "only-work-environment", + "description": "If specified, only elements from the Endevor work environment will be synchronized.", "type": "boolean", + "defaultValue": false, + "group": "Options", "aliases": [] }, { - "name": "help-web", - "aliases": [ - "hw" + "name": "read-only", + "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", + "type": "boolean", + "required": false, + "implies": [ + "endevor-stage-number" ], - "group": "Global options", - "description": "Display HTML help in browser", - "type": "boolean" + "conflictsWith": [ + "json-file" + ], + "group": "Options", + "aliases": [] }, { - "name": "ebg-profile", + "name": "endevor-stage-number", "aliases": [ - "ebg-p" + "endevorsn" ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" + "description": "The CA Endevor stage where your project resides (only for read only mappings).", + "type": "string", + "implies": [ + "read-only" + ], + "conflictsWith": [ + "json-file" + ], + "group": "Options" }, { - "name": "base-profile", + "name": "json-file", "aliases": [ - "base-p" + "json" ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" + "description": "Mapping JSON file to import", + "type": "existingLocalFile", + "required": false, + "conflictsWith": [ + "remote-url", + "endevor-stage-number", + "read-only", + "endevor-instance", + "endevor-environment", + "endevor-environment", + "endevor-system", + "endevor-subsystem" + ], + "group": "Options" }, { - "name": "password", + "name": "endevor-protocol", "aliases": [ - "pass", - "pw" + "endevorprot" ], - "description": "Password to authenticate to service on the mainframe.", + "description": "The CA Endevor SCM Rest API protocol. \n\nDefault value: http", "type": "string", - "group": "Base Connection Options" + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } }, { - "name": "token-type", + "name": "endevor-host", "aliases": [ - "tt" + "endevorh" ], - "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'.", + "description": "The Endevor Rest API hostname.", "type": "string", - "group": "Base Connection Options" + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { - "name": "token-value", + "name": "endevor-port", "aliases": [ - "tv" + "endevorp" ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" + "description": "The Endevor Rest API port.", + "type": "number", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication", - "type": "existingLocalFile", - "group": "Base Connection Options", - "aliases": [] + "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": "cert-key-file", - "description": "The file path to a certificate key file to use for authentication", - "type": "existingLocalFile", - "group": "Base Connection Options", - "aliases": [] - } - ], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.", - "summary": "List Git-Endevor mappings", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "view", + "name": "endevor-password", "aliases": [ - "v" + "endevorpass", + "endevorpw" ], - "description": "Type of detail to be displayed.", + "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", "type": "string", - "allowableValues": { - "values": [ - "default", - "endevor", - "all" - ], - "caseSensitive": false - }, - "defaultValue": "default", - "group": "Options" + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { - "name": "export", - "description": "Export list of mapping to a json file.", + "name": "endevor-reject-unauthorized", + "aliases": [ + "endevorru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: true", "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "endevor-base-path", + "aliases": [ + "endevorbp" + ], + "description": "The CA Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { "name": "protocol", @@ -3899,6 +2153,15 @@ "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": [ @@ -3949,62 +2212,20 @@ "type": "existingLocalFile", "group": "Base Connection Options", "aliases": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null } ], - "outputFormatOptions": true, "examples": [ { - "description": "List all the Git-Endevor mappings using the default EBG profile", - "options": "" - }, - { - "description": "List all the Git-Endevor mappings and show their Endevor details using the default EBG profile", - "options": "--view endevor" + "description": "Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", + "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME " }, { - "description": "List all the Git-Endevor mappings and show all their details using the default EBG profile", - "options": "--view all" + "description": "Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", + "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2" }, { - "description": "List all the Git-Endevor mappings without an EBG profile", - "options": "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" + "description": "Create the Git-Endevor mapping with importing a mapping file", + "options": "--json-file my-mapping.json " } ], "positionals": [], @@ -4012,13 +2233,13 @@ "children": [] }, { - "name": "add-element", + "name": "delete", "aliases": [ - "add" + "del" ], "type": "command", "handler": "", - "description": "Add an element from up the map in your CA Endevor to your Git repository.", + "description": "Delete a Git-Endevor mapping", "positionals": [ { "name": "context", @@ -4034,191 +2255,18 @@ } ], "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "element-name", - "aliases": [ - "name" - ], - "description": "The name of the CA Endevor element you want to add.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "element-type", - "aliases": [ - "type" - ], - "description": "The type of the CA Endevor element you want to add", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The CA Endevor system where your element resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The CA Endevor subsystem where your element resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "name": "withDependencies", - "description": "If specified, the requested element will be added with dependencies (eg. COBOL copybooks).", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "force-get-dependencies", - "aliases": [ - "force" - ], - "description": "If specified, the maximum number of dependencies will be bypassed. This only applies to the repository administrator.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "validate", - "description": "If specified, the requested elements will be validated against CA Endevor.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "branchId", - "description": "If specified, the requested elements will be added to the selected branch.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "all-branches", - "description": "If specified, the requested elements will be added to all synchronized branches in your repository.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "file", - "aliases": [ - "fn" - ], - "description": "If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.", - "type": "existingLocalFile", - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The CA Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "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": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The CA Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, + "optional": [ + "ebg", + "base" + ] + }, + "examples": [ + { + "description": "Delete the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile", + "options": "MY-CONTEXT MY-MAPPING" + } + ], + "options": [ { "name": "protocol", "aliases": [ @@ -4328,15 +2376,6 @@ "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": [ @@ -4389,24 +2428,51 @@ "aliases": [] } ], - "examples": [ - { - "description": "Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING'", - "options": "MY-CONTEXT MY-MAPPING --name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE" - }, - { - "description": "Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file", - "options": "MY-CONTEXT MY-MAPPING --fileName MY-FILEPATH.json" - } - ], "passOn": [], "children": [] - } - ], - "passOn": [ + }, { - "property": "options", - "value": [ + "name": "list", + "aliases": [ + "ls" + ], + "type": "command", + "handler": "", + "description": "List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.", + "summary": "List Git-Endevor mappings", + "profile": { + "optional": [ + "ebg", + "base" + ] + }, + "options": [ + { + "name": "view", + "aliases": [ + "v" + ], + "description": "Type of detail to be displayed.", + "type": "string", + "allowableValues": { + "values": [ + "default", + "endevor", + "all" + ], + "caseSensitive": false + }, + "defaultValue": "default", + "group": "Options" + }, + { + "name": "export", + "description": "Export list of mapping to a json file.", + "type": "boolean", + "defaultValue": false, + "group": "Options", + "aliases": [] + }, { "name": "protocol", "aliases": [ @@ -4472,273 +2538,435 @@ "description": "Reject self-signed certificates. \n\nDefault value: false", "type": "boolean", "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "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-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", + "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": "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": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null } ], - "merge": true - } - ], - "options": [ - { - "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-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "help-web", - "aliases": [ - "hw" + "outputFormatOptions": true, + "examples": [ + { + "description": "List all the Git-Endevor mappings using the default EBG profile", + "options": "" + }, + { + "description": "List all the Git-Endevor mappings and show their Endevor details using the default EBG profile", + "options": "--view endevor" + }, + { + "description": "List all the Git-Endevor mappings and show all their details using the default EBG profile", + "options": "--view all" + }, + { + "description": "List all the Git-Endevor mappings without an EBG profile", + "options": "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" + } ], - "group": "Global options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "processor-group", - "aliases": [ - "proc-group", - "pg" - ], - "description": "Manage the processor groups of your mapping", - "type": "group", - "children": [ + "positionals": [], + "passOn": [], + "children": [] + }, { - "name": "list", + "name": "add-element", "aliases": [ - "ls" + "add" ], "type": "command", "handler": "", - "description": "List processor groups used by a type in your mapping", - "summary": "List Processor Groups", + "description": "Add an element from up the map in your CA Endevor to your Git repository.", + "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": "work-dir", + "name": "elementName", "aliases": [ - "wd" + "name" ], - "description": "The local working directory of your Git-Endevor mapping.", + "description": "The name of the CA Endevor element you want to add.", "type": "string", - "defaultValue": "./", + "required": false, "group": "Options" }, { - "name": "endevor-system", + "name": "elementType", "aliases": [ - "endevorsys" + "type" ], - "description": "The CA Endevor system or alias of the system where your project resides.", + "description": "The type of the CA Endevor element you want to add", "type": "string", + "stringLengthRange": [ + 1, + 8 + ], "required": false, "group": "Options" }, { - "name": "endevor-subsystem", + "name": "endevor-system", "aliases": [ - "endevorsub" + "endevorsys" ], - "description": "The CA Endevor subsystem or alias of the subsystem where your project resides.", + "description": "The CA Endevor system where your element resides.", "type": "string", - "required": false, + "stringLengthRange": [ + 1, + 8 + ], "group": "Options" }, { - "name": "type", + "name": "endevor-subsystem", "aliases": [ - "type" + "endevorsub" ], - "description": "The type of the CA Endevor element", + "description": "The CA Endevor subsystem where your element resides.", "type": "string", "stringLengthRange": [ 1, 8 ], - "required": false, "group": "Options" }, { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" + "name": "withDependencies", + "description": "If specified, the requested element will be added with dependencies (eg. COBOL copybooks).", + "type": "boolean", + "defaultValue": false, + "group": "Options", + "aliases": [] }, { - "name": "help", + "name": "force-get-dependencies", "aliases": [ - "h" + "force" ], - "group": "Global options", - "description": "Display help text", - "type": "boolean" + "description": "If specified, the maximum number of dependencies will be bypassed. This only applies to the repository administrator.", + "type": "boolean", + "defaultValue": false, + "group": "Options" }, { - "name": "help-examples", - "group": "Global options", - "description": "Display examples for all the commands in a group", + "name": "validate", + "description": "If specified, the requested elements will be validated against CA Endevor.", "type": "boolean", + "defaultValue": false, + "group": "Options", "aliases": [] }, { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global options", - "description": "Display HTML help in browser", - "type": "boolean" + "name": "branchId", + "description": "If specified, the requested elements will be added to the selected branch.", + "type": "string", + "group": "Options", + "aliases": [] }, { - "name": "response-format-filter", + "name": "all-branches", + "description": "If specified, the requested elements will be added to all synchronized branches in your repository.", + "type": "boolean", + "defaultValue": false, + "group": "Options", + "aliases": [] + }, + { + "name": "file", "aliases": [ - "rff" + "fn" ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" + "description": "If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.", + "type": "existingLocalFile", + "group": "Options" }, { - "name": "response-format-type", + "name": "endevor-protocol", "aliases": [ - "rft" + "endevorprot" ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "description": "The CA Endevor SCM Rest API protocol. \n\nDefault value: http", "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)", "allowableValues": { "values": [ - "table", - "list", - "object", - "string" + "http", + "https" ], "caseSensitive": false - }, - "group": "Response Format Options" + } }, { - "name": "response-format-header", + "name": "endevor-host", "aliases": [ - "rfh" + "endevorh" ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ + "description": "The Endevor Rest API hostname.", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, { - "description": "List all the processor groups used by a type in your mapping for a single system/subsystem mapping.", - "options": "--type TYPE" + "name": "endevor-port", + "aliases": [ + "endevorp" + ], + "description": "The Endevor Rest API port.", + "type": "number", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { - "description": "List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.", - "options": "--endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "update", - "aliases": [ - "u" - ], - "type": "command", - "handler": "", - "description": "Update the processor group of a specific element in your local repository", - "summary": "Update the processor group of an element", - "positionals": [ + "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": "element", + "name": "endevor-password", "aliases": [ - "element" + "endevorpass", + "endevorpw" ], - "description": "The name of the CA Endevor element that its processor group will be modified", + "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", "type": "string", - "required": true + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" }, { - "name": "processor-group", + "name": "endevor-reject-unauthorized", + "aliases": [ + "endevorru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: true", + "type": "boolean", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "endevor-base-path", "aliases": [ - "proc-group", - "pg" + "endevorbp" ], - "description": "The name of the processor group you want to use", + "description": "The CA Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", "type": "string", - "required": true - } - ], - "options": [ + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, { - "name": "work-dir", + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http", + "type": "string", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "port", "aliases": [ - "wd" + "P" ], - "description": "The local working directory of your Git-Endevor mapping.", - "type": "string", - "defaultValue": "./", - "group": "Options" + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "endevor-system", + "name": "user", "aliases": [ - "endevorsys" + "u" ], - "description": "The CA Endevor system or alias of the system where your project resides.", + "description": "Endevor Bridge for Git username (your git username).", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "endevor-subsystem", + "name": "token", "aliases": [ - "endevorsub" + "t" ], - "description": "The CA Endevor subsystem or alias of the subsystem where your project resides.", + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "type", + "name": "reject-unauthorized", "aliases": [ - "type" - ], - "description": "The type of the CA Endevor element", - "type": "string", - "stringLengthRange": [ - 1, - 8 + "ru" ], - "required": false, - "group": "Options" + "description": "Reject self-signed certificates. \n\nDefault value: false", + "type": "boolean", + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { "name": "response-format-json", @@ -4775,190 +3003,161 @@ "type": "boolean" }, { - "name": "response-format-filter", + "name": "ebg-profile", "aliases": [ - "rff" + "ebg-p" ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" + "group": "Profile Options", + "description": "The name of a (ebg) profile to load for this command execution.", + "type": "string" }, { - "name": "response-format-type", + "name": "endevor-profile", "aliases": [ - "rft" + "endevor-p" ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" }, { - "name": "response-format-header", + "name": "base-profile", "aliases": [ - "rfh" + "base-p" ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [], - "passOn": [], - "children": [] - }, - { - "name": "update-all", - "aliases": [ - "ua" - ], - "type": "command", - "handler": "", - "description": "Update the processor group of all changed elements of a specific type", - "summary": "Update the processor group of all changed elements", - "positionals": [ + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, { - "name": "processor-group", + "name": "password", "aliases": [ - "proc-group", - "pg" + "pass", + "pw" ], - "description": "The name of the processor group you want to use", + "description": "Password to authenticate to service on the mainframe.", "type": "string", - "required": true - } - ], - "options": [ + "group": "Base Connection Options" + }, { - "name": "work-dir", + "name": "token-type", "aliases": [ - "wd" + "tt" ], - "description": "The local working directory of your Git-Endevor mapping.", + "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", - "defaultValue": "./", - "group": "Options" + "group": "Base Connection Options" }, { - "name": "endevor-system", + "name": "token-value", "aliases": [ - "endevorsys" + "tv" ], - "description": "The CA Endevor system or alias of the system where your project resides.", + "description": "The value of the token to pass to the API.", "type": "string", - "required": false, - "group": "Options" + "group": "Base Connection Options" }, { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The CA Endevor subsystem or alias of the subsystem where your project resides.", - "type": "string", - "required": false, - "group": "Options" + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] }, { - "name": "type", - "aliases": [ - "type" - ], - "description": "The type of the CA Endevor element", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" + "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": "Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING'", + "options": "MY-CONTEXT MY-MAPPING --name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE" }, { - "name": "response-format-json", + "description": "Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file", + "options": "MY-CONTEXT MY-MAPPING --fileName MY-FILEPATH.json" + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "protocol", "aliases": [ - "rfj" + "prot" ], - "group": "Global options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http", + "type": "string", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } }, { - "name": "help", + "name": "host", "aliases": [ - "h" + "H" ], - "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": [] + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "help-web", + "name": "port", "aliases": [ - "hw" + "P" ], - "group": "Global options", - "description": "Display HTML help in browser", - "type": "boolean" + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "response-format-filter", + "name": "user", "aliases": [ - "rff" + "u" ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" + "description": "Endevor Bridge for Git username (your git username).", + "type": "string", + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "response-format-type", + "name": "token", "aliases": [ - "rft" + "t" ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" + "required": true, + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" }, { - "name": "response-format-header", + "name": "reject-unauthorized", "aliases": [ - "rfh" + "ru" ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "description": "Reject self-signed certificates. \n\nDefault value: false", "type": "boolean", - "group": "Response Format Options", - "defaultValue": null + "group": "CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" } ], - "outputFormatOptions": true, - "examples": [], - "passOn": [], - "children": [] + "merge": true } ], "options": [ @@ -4997,8 +3196,7 @@ "type": "boolean" } ], - "positionals": [], - "passOn": [] + "positionals": [] }, { "name": "work-area", diff --git a/commandGroups/endevor.jsonc b/commandGroups/endevor.jsonc index 0f4d53f..7fee0b6 100644 --- a/commandGroups/endevor.jsonc +++ b/commandGroups/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 2be450b..633b363 100644 --- a/commandGroups/file-master-plus.jsonc +++ b/commandGroups/file-master-plus.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "file-master-plus", - "description": "CA File Master Plus command line interface is a file management and data manipulation tool.\nIt speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.\nIt also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.", + "description": "File Master Plus command line interface is a file management and data manipulation tool.\nIt speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.\nIt also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.", "type": "group", "children": [ { @@ -19,7 +19,7 @@ "aliases": [ "ds" ], - "description": "Copy from a data set to another data set.\nIf the data set does not exist, CA File Master Plus automatically creates a new data set using the attributes of data set.\nIt supports all data set types that are supported by CA File Master Plus.", + "description": "Copy from a data set to another data set.\nIf the data set does not exist, File Master Plus automatically creates a new data set using the attributes of data set.\nIt supports all data set types that are supported by File Master Plus.", "summary": "Copy a data set", "type": "command", "handler": "", @@ -81,7 +81,7 @@ "aliases": [ "ssc" ], - "description": "Specifies the name of pre-defined CA File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in CA File Master Plus server.\nExample: --ssc testcri", + "description": "Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server.\nExample: --ssc testcri", "type": "string", "conflictsWith": [ "dynamic-selection-criteria" @@ -94,7 +94,7 @@ "aliases": [ "dsc" ], - "description": "Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by CA File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.\nExample: --dsc ../selcri/testcri.txt ", + "description": "Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.\nExample: --dsc ../selcri/testcri.txt ", "type": "string", "conflictsWith": [ "static-selection-criteria" @@ -135,7 +135,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -145,7 +145,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -176,7 +176,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -327,7 +327,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -337,7 +337,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -368,7 +368,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -676,7 +676,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -686,7 +686,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -717,7 +717,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -1081,7 +1081,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -1091,7 +1091,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -1122,7 +1122,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -1500,7 +1500,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -1510,7 +1510,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -1541,7 +1541,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -1933,7 +1933,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -1943,7 +1943,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -1974,7 +1974,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -2633,7 +2633,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -2643,7 +2643,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -2674,7 +2674,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -3239,7 +3239,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -3249,7 +3249,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -3280,7 +3280,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -3722,7 +3722,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -3732,7 +3732,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -3763,7 +3763,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -4297,7 +4297,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -4307,7 +4307,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -4338,7 +4338,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -4964,7 +4964,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -4974,7 +4974,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5005,7 +5005,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -5196,7 +5196,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -5206,7 +5206,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5237,7 +5237,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -5368,7 +5368,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -5378,7 +5378,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5409,7 +5409,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -5505,7 +5505,7 @@ ], "summary": "Permanently deletes a data set", "type": "command", - "description": "Permanently deletes a data set.\nIt supports all data set types that are supported by CA File Master Plus.", + "description": "Permanently deletes a data set.\nIt supports all data set types that are supported by File Master Plus.", "handler": "", "positionals": [ { @@ -5533,7 +5533,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -5543,7 +5543,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5574,7 +5574,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -5705,7 +5705,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -5715,7 +5715,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5746,7 +5746,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -5833,7 +5833,7 @@ ], "type": "group", "summary": "Add records in a data set", - "description": "Populate the specified data set with records.\nIt supports all data set types that are supported by CA File Master Plus.", + "description": "Populate the specified data set with records.\nIt supports all data set types that are supported by File Master Plus.", "children": [ { "name": "data-set", @@ -5901,7 +5901,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -5911,7 +5911,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -5942,7 +5942,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -6085,7 +6085,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -6095,7 +6095,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -6126,7 +6126,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -6220,7 +6220,7 @@ "aliases": [ "ds" ], - "description": "Rename a data set.\nIt supports all data set types that are supported by CA File Master Plus.", + "description": "Rename a data set.\nIt supports all data set types that are supported by File Master Plus.", "summary": "Rename a data set", "type": "command", "handler": "", @@ -6262,7 +6262,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -6272,7 +6272,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -6303,7 +6303,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, @@ -6450,7 +6450,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -6460,7 +6460,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -6491,7 +6491,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, diff --git a/commandGroups/idms.jsonc b/commandGroups/idms.jsonc index 5e27acc..50206df 100644 --- a/commandGroups/idms.jsonc +++ b/commandGroups/idms.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms", - "description": "CA IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands", + "description": "IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands", "type": "group", "children": [ { @@ -103,7 +103,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -231,10 +231,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -342,7 +340,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -470,10 +468,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -580,7 +576,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -708,10 +704,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -810,7 +804,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -938,10 +932,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -1040,7 +1032,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -1168,10 +1160,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -1278,7 +1268,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -1406,10 +1396,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -1430,7 +1418,7 @@ "dt" ], "summary": "DCMT TEST commands", - "description": "Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.\n\n The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by CA IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on", + "description": "Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.\n\n The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on", "type": "command", "handler": "", "options": [ @@ -1513,7 +1501,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -1641,10 +1629,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -1652,7 +1638,7 @@ "examples": [ { "options": "--args \"debug options\"", - "description": "Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by CA IDMS technical support" + "description": "Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support" } ], "positionals": [], @@ -1731,7 +1717,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -1859,10 +1845,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -1966,7 +1950,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -2094,10 +2078,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -2126,7 +2108,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "required": true, "group": "IDMS Connection Options" @@ -2183,10 +2165,239 @@ "aliases": [ "ls" ], - "summary": "List active IDMS systems, log messages, user tasks, and transaction details", - "description": "Lists real-time monitor statistics information, log messages, active user tasks, and transaction details", + "summary": "List available datasources, active IDMS systems, log messages, user tasks, and transaction details", + "description": "Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details", "type": "group", "children": [ + { + "name": "datasources", + "aliases": [ + "ds" + ], + "summary": "Lists defined data sources", + "description": "Lists data sources defined to the IDMS REST API", + "type": "command", + "handler": "", + "options": [ + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of the IDMS REST API service", + "type": "string", + "required": true, + "group": "IDMS Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port for the IDMS REST API service", + "type": "number", + "group": "IDMS Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Mainframe user name, which can be the same as your TSO login ID", + "type": "string", + "group": "IDMS Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Mainframe password, which can be the same as your TSO password", + "type": "string", + "group": "IDMS Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates", + "type": "boolean", + "defaultValue": true, + "group": "IDMS Connection Options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", + "type": "string", + "group": "IDMS Connection Options" + }, + { + "name": "datasourcename", + "aliases": [ + "dsn" + ], + "description": "Specifies a specific datasource to view the definition of", + "type": "string", + "group": "Options" + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Lists each datasource defined to the IDMS REST API", + "type": "boolean", + "defaultValue": null, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "idms-profile", + "aliases": [ + "idms-p" + ], + "group": "Profile Options", + "description": "The name of a (idms) 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": "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": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "optional": [ + "idms", + "base" + ] + }, + "outputFormatOptions": true, + "examples": [ + { + "options": "--all", + "description": "Lists all data sources defined to the IDMS Rest API" + }, + { + "options": "--dsn SYSDEMO", + "description": "Lists a single IDMS data source identified by the data source name" + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, { "name": "systems", "aliases": [ @@ -2396,10 +2607,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -2487,7 +2696,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "group": "IDMS Connection Options", "required": true @@ -2662,10 +2871,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -2766,6 +2973,16 @@ "required": true, "group": "Required Options" }, + { + "name": "datasourcename", + "aliases": [ + "dsn" + ], + "description": "The data source name of the specified IDMS system", + "type": "string", + "required": true, + "group": "Required Options" + }, { "name": "response-format-json", "aliases": [ @@ -2889,10 +3106,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -2988,6 +3203,16 @@ "required": true, "group": "Required Options" }, + { + "name": "datasourcename", + "aliases": [ + "dsn" + ], + "description": "The data source name of the specified IDMS system", + "type": "string", + "required": true, + "group": "Required Options" + }, { "name": "response-format-json", "aliases": [ @@ -3111,10 +3336,8 @@ } ], "profile": { - "required": [ - "idms" - ], "optional": [ + "idms", "base" ] }, @@ -3146,6 +3369,15 @@ "description": "The job name of the active IDMS system", "type": "string", "required": true + }, + { + "name": "datasourcename", + "aliases": [ + "dsn" + ], + "description": "The data source name of the specified IDMS system", + "type": "string", + "required": true } ], "merge": true, @@ -3153,6 +3385,9 @@ { "type": "group" }, + { + "name": "datasources" + }, { "name": "systems" }, @@ -3201,7 +3436,7 @@ "positionals": [] } ], - "summary": "Interact with CA IDMS", + "summary": "Interact with IDMS", "options": [ { "name": "response-format-json", diff --git a/commandGroups/jclcheck.jsonc b/commandGroups/jclcheck.jsonc index e0db30d..07b227d 100644 --- a/commandGroups/jclcheck.jsonc +++ b/commandGroups/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck", diff --git a/commandGroups/mat-pma-util.jsonc b/commandGroups/mat-pma-util.jsonc index 815f0f4..4306db8 100644 --- a/commandGroups/mat-pma-util.jsonc +++ b/commandGroups/mat-pma-util.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-pma-util", - "description": "The CA MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of CA Mainframe Application Tuner.", + "description": "The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.", "type": "group", "children": [ { @@ -2355,7 +2355,7 @@ "passOn": [] } ], - "summary": "The CA MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of CA Mainframe Application Tuner.", + "summary": "The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.", "aliases": [ "pma" ], diff --git a/commandGroups/mat.jsonc b/commandGroups/mat.jsonc index ada2a96..fac0218 100644 --- a/commandGroups/mat.jsonc +++ b/commandGroups/mat.jsonc @@ -1,14 +1,14 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat", - "description": "The CA MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using CA Mainframe Application Tuner (CA MAT)", + "description": "The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)", "type": "group", "children": [ { "name": "monitor", "summary": "Get monitor data", - "description": "Get monitor history and measurement analysis data from CA MAT.", + "description": "Get monitor history and measurement analysis data from MAT.", "type": "group", "children": [ { @@ -791,21 +791,21 @@ }, { "name": "group", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with CA MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", + "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", "type": "stringOrEmpty", "group": "Options", "aliases": [] }, { "name": "top", - "description": "Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that CA MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", + "description": "Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", "type": "number", "group": "Options", "aliases": [] }, { "name": "listing", - "description": "Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the CA Endevor® Web Services and have the program listing for the specific measurement registered with CA MAT. The source code listing is retrieved through CA Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.", + "description": "Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.", "type": "boolean", "group": "Options", "aliases": [] @@ -1625,7 +1625,7 @@ }, { "name": "top", - "description": "Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that CA MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", + "description": "Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", "type": "number", "group": "Options", "aliases": [] @@ -2060,7 +2060,7 @@ { "name": "profile", "summary": "Manage monitor profiles", - "description": "Create, invoke, and list CA MAT monitor profiles.", + "description": "Create, invoke, and list MAT monitor profiles.", "type": "group", "children": [ { @@ -2068,8 +2068,8 @@ "aliases": [ "ivk" ], - "summary": "Invoke a CA MAT monitor profile", - "description": "Invoke a CA MAT monitor profile to start measurement.", + "summary": "Invoke a MAT monitor profile", + "description": "Invoke a MAT monitor profile to start measurement.", "handler": "", "type": "command", "profile": { @@ -2083,7 +2083,7 @@ "options": [ { "name": "profile", - "description": "Specifies the name of the profile in CA MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", + "description": "Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", "type": "string", "required": true, "group": "Required Options", @@ -2099,7 +2099,7 @@ }, { "name": "mondsn", - "description": "Specifies the monitor data set name where CA MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default CA MAT monitor DSN pattern is applied.", + "description": "Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.", "type": "string", "required": false, "group": "Options", @@ -2131,7 +2131,7 @@ }, { "name": "listing", - "description": "Activates automated registration of Cobol, C/C++, and Assembler program listings through CA Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the CA MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with CA MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.", + "description": "Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.", "type": "boolean", "required": false, "group": "Options", @@ -2271,7 +2271,7 @@ ], "examples": [ { - "description": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system", + "description": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system ", "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31" }, { @@ -2292,8 +2292,8 @@ "aliases": [ "cr" ], - "summary": "Create a CA MAT monitor profile", - "description": "Create a CA MAT monitor profile.", + "summary": "Create a MAT monitor profile", + "description": "Create a MAT monitor profile.", "type": "command", "handler": "", "profile": { @@ -2307,7 +2307,7 @@ "options": [ { "name": "profile", - "description": "Specifies the name of the profile that you create in CA MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", + "description": "Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", "type": "string", "required": true, "group": "Required Options", @@ -2315,7 +2315,7 @@ }, { "name": "jobname", - "description": "Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", + "description": "Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", "type": "string", "required": true, "group": "Required Options", @@ -2354,7 +2354,7 @@ }, { "name": "mondsn", - "description": "Specifies the monitor data set name where CA MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default CA MAT monitor DSN pattern is applied.", + "description": "Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.", "type": "string", "required": false, "group": "Options", @@ -2362,7 +2362,7 @@ }, { "name": "stepname", - "description": "Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", + "description": "Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", "type": "string", "required": false, "group": "Options", @@ -2385,7 +2385,7 @@ }, { "name": "procstep", - "description": "Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", + "description": "Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", "type": "string", "required": false, "group": "Options", @@ -2393,7 +2393,7 @@ }, { "name": "program", - "description": "Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", + "description": "Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", "type": "string", "required": false, "group": "Options", @@ -2425,7 +2425,7 @@ }, { "name": "tasklib", - "description": "Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", + "description": "Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", "type": "string", "required": false, "group": "Options", @@ -2433,7 +2433,7 @@ }, { "name": "samplecnt", - "description": "Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.", + "description": "Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.", "type": "string", "required": false, "defaultValue": "6000", @@ -2442,7 +2442,7 @@ }, { "name": "succnt", - "description": "Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.", + "description": "Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.", "type": "string", "required": false, "defaultValue": "1", @@ -2451,7 +2451,7 @@ }, { "name": "reccnt", - "description": "Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.", + "description": "Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.", "type": "string", "required": false, "defaultValue": "1", @@ -2460,7 +2460,7 @@ }, { "name": "sampdelay", - "description": "Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.", + "description": "Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.", "type": "string", "required": false, "defaultValue": "0", @@ -2469,7 +2469,7 @@ }, { "name": "userexit1", - "description": "Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).", + "description": "Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).", "type": "string", "required": false, "group": "Options", @@ -2477,7 +2477,7 @@ }, { "name": "userexit2", - "description": "Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).", + "description": "Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).", "type": "string", "required": false, "group": "Options", @@ -2485,7 +2485,7 @@ }, { "name": "userexit3", - "description": "Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).", + "description": "Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).", "type": "string", "required": false, "group": "Options", @@ -2493,7 +2493,7 @@ }, { "name": "inctask", - "description": "Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).", + "description": "Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).", "type": "string", "required": false, "group": "Options", @@ -2501,7 +2501,7 @@ }, { "name": "exctask", - "description": "Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).", + "description": "Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).", "type": "string", "required": false, "group": "Options", @@ -2509,7 +2509,7 @@ }, { "name": "tran", - "description": "Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).", + "description": "Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).", "type": "string", "required": false, "group": "Options", @@ -2517,7 +2517,7 @@ }, { "name": "term", - "description": "Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).", + "description": "Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).", "type": "string", "required": false, "group": "Options", @@ -2525,7 +2525,7 @@ }, { "name": "userid", - "description": "Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).", + "description": "Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).", "type": "string", "required": false, "group": "Options", @@ -2548,7 +2548,7 @@ }, { "name": "db2ctsql", - "description": "Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.", + "description": "Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.", "type": "string", "required": false, "allowableValues": { @@ -2563,7 +2563,7 @@ }, { "name": "db2hvloc", - "description": "Indicates whether the Requestor Location option is enabled for DB2 measurements.", + "description": "Indicates whether the Requestor Location option is enabled for DB2 measurements.", "type": "string", "required": false, "allowableValues": { @@ -2578,7 +2578,7 @@ }, { "name": "db2hvcor", - "description": "Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.", + "description": "Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.", "type": "string", "required": false, "allowableValues": { @@ -2593,7 +2593,7 @@ }, { "name": "db2hviid", - "description": "Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.", + "description": "Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.", "type": "string", "required": false, "allowableValues": { @@ -2608,7 +2608,7 @@ }, { "name": "db2hvthd", - "description": "Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.", + "description": "Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.", "type": "string", "required": false, "allowableValues": { @@ -2654,7 +2654,7 @@ }, { "name": "schedule", - "description": "Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).", + "description": "Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).", "type": "string", "required": false, "group": "Options", @@ -3002,7 +3002,7 @@ "passOn": [] } ], - "summary": "Manage monitor profiles and analyze the measurement data using CA MAT", + "summary": "Manage monitor profiles and analyze the measurement data using MAT", "aliases": [ "mat" ], diff --git a/commandGroups/ops.jsonc b/commandGroups/ops.jsonc index a96a722..b66dbe6 100644 --- a/commandGroups/ops.jsonc +++ b/commandGroups/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops", @@ -57,7 +57,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -68,14 +68,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -86,7 +86,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -228,7 +228,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -238,14 +238,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -255,7 +255,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -390,7 +390,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -401,14 +401,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -419,7 +419,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -561,7 +561,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -571,14 +571,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -588,7 +588,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -727,7 +727,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -738,14 +738,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -756,7 +756,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -930,7 +930,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -941,14 +941,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -959,7 +959,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1101,7 +1101,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1111,14 +1111,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1128,7 +1128,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1285,7 +1285,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -1296,14 +1296,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -1314,7 +1314,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1456,7 +1456,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1466,14 +1466,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1483,7 +1483,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1640,7 +1640,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -1651,14 +1651,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -1669,7 +1669,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1811,7 +1811,7 @@ "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1821,14 +1821,14 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { @@ -1838,7 +1838,7 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { diff --git a/commandGroups/sysview.jsonc b/commandGroups/sysview.jsonc index e7bdd8f..f2c30b6 100644 --- a/commandGroups/sysview.jsonc +++ b/commandGroups/sysview.jsonc @@ -1,8 +1,8 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview", - "description": "Zowe CLI plugin for CA SYSVIEW", + "description": "Zowe CLI plugin for SYSVIEW", "type": "group", "children": [ { @@ -10,7 +10,7 @@ "aliases": [ "cap" ], - "summary": "Display a captured CA SYSVIEW primary command", + "summary": "Display a captured SYSVIEW primary command", "description": "Display output from a primary command stored in a SYSVIEW capture data set", "type": "command", "handler": "", @@ -582,8 +582,8 @@ "aliases": [ "dsp" ], - "summary": "Display a real-time CA SYSVIEW primary command", - "description": "Issue a CA SYSVIEW primary command and display output, including any messages", + "summary": "Display a real-time SYSVIEW primary command", + "description": "Issue a SYSVIEW primary command and display output, including any messages", "type": "command", "handler": "", "profile": { @@ -895,8 +895,8 @@ "aliases": [ "exe" ], - "summary": "Execute a real-time CA SYSVIEW function command", - "description": "Issue a CA SYSVIEW function command and display any messages", + "summary": "Execute a real-time SYSVIEW function command", + "description": "Issue a SYSVIEW function command and display any messages", "type": "command", "handler": "", "profile": { @@ -1096,7 +1096,7 @@ "children": [] } ], - "summary": "Integration with CA SYSVIEW", + "summary": "Integration with SYSVIEW", "aliases": [ "sv" ], diff --git a/profiles/create/ca7.jsonc b/profiles/create/ca7.jsonc index 51717cb..2823c7a 100644 --- a/profiles/create/ca7.jsonc +++ b/profiles/create/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/create/caspool.jsonc b/profiles/create/caspool.jsonc index 823e48f..e908446 100644 --- a/profiles/create/caspool.jsonc +++ b/profiles/create/caspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool-profile", @@ -6,7 +6,7 @@ "caspool" ], "summary": "Create a caspool profile", - "description": "Configuration profile for CA Spool, where you specify information about your CA Spool instance", + "description": "Configuration profile for Spool, where you specify information about your Spool instance", "type": "command", "handler": "", "customize": { @@ -29,10 +29,10 @@ "a" ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "High level qualifier of CA Spool installation.", + "description": "High level qualifier of Spool installation.", "type": "string", "name": "spoolhlq", "aliases": [ @@ -43,10 +43,10 @@ 35 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "CA Spool subsystem name.", + "description": "Spool subsystem name.", "type": "string", "name": "subsys", "aliases": [ @@ -57,10 +57,10 @@ 4 ], "defaultValue": "ESF", - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with CA Spool.", + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", "type": "string", "name": "outds", "aliases": [ @@ -71,7 +71,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { "description": "The data set containing ESFZOWE REXX exec.", @@ -85,7 +85,7 @@ 44 ], "required": true, - "group": "CA SPOOL OPTIONS" + "group": "SPOOL OPTIONS" }, { "name": "overwrite", @@ -143,7 +143,7 @@ "examples": [ { "options": "myProfile --account 1234567890 --spoolhlq CASPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST", - "description": "Create a profile for CA Spool named 'myProfile' with TSO account information '1234567890', CA Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec" + "description": "Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec" } ], "passOn": [], diff --git a/profiles/create/caview.jsonc b/profiles/create/caview.jsonc index 12f41ad..16013bc 100644 --- a/profiles/create/caview.jsonc +++ b/profiles/create/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", @@ -6,7 +6,7 @@ "caview" ], "summary": "Create a caview profile", - "description": "Configuration profile for CA View", + "description": "Configuration profile for View", "type": "command", "handler": "", "customize": { @@ -24,7 +24,7 @@ { "type": "string", "name": "protocol", - "description": "Protocol of the target CA View REST API instance.", + "description": "Protocol of the target View REST API instance.", "required": false, "allowableValues": { "values": [ @@ -40,28 +40,30 @@ { "type": "string", "name": "hostname", - "description": "Hostname or ip address of the target CA View REST API instance.", - "required": true, - "group": "Required Options", + "description": "Hostname or ip address of the target View REST API instance.", + "required": false, + "group": "Options", "aliases": [] }, { "type": "number", "name": "port", - "description": "Port of the target CA View REST API instance.", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", "numericValueRange": [ 0, 65535 ], "required": false, "defaultValue": 443, - "group": "Options", - "aliases": [] + "group": "Options" }, { "type": "string", "name": "base-path", - "description": "Context name of the target CA View REST API instance.", + "description": "Context name of the target View REST API instance.", "required": false, "defaultValue": "web-viewer", "group": "Options", @@ -70,18 +72,21 @@ { "type": "string", "name": "username", - "description": "User name used to authenticate against the target CA View REST API instance.", - "required": true, - "group": "Required Options", + "description": "User name used to authenticate against the target View REST API instance.", + "required": false, + "group": "Options", "aliases": [] }, { "type": "string", "name": "password", - "description": "Password used to authenticate against the target CA View REST API instance.", - "required": true, - "group": "Required Options", - "aliases": [] + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", + "required": false, + "group": "Options" }, { "name": "overwrite", @@ -139,7 +144,7 @@ "examples": [ { "options": "myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret", - "description": "Create a profile for CA View® Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account." + "description": "Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account." } ], "passOn": [], diff --git a/profiles/create/dbm-db2.jsonc b/profiles/create/dbm-db2.jsonc new file mode 100644 index 0000000..7b96e2f --- /dev/null +++ b/profiles/create/dbm-db2.jsonc @@ -0,0 +1,246 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2" + ], + "summary": "Create a dbm-db2 profile", + "description": "The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", + "type": "command", + "handler": "", + "customize": { + "profileTypeIdentifier": "dbm-db2" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a newline delimited string of z/OS JCL JOB statements.", + "type": "string", + "defaultValue": "//DB2DVOPS JOB (),'DB2 PROVISIONING',NOTIFY=&SYSUID,\\n// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\\n// REGION=0M,TIME=NOLIMIT", + "required": true, + "group": "dbm-db2 Common 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.", + "type": "string", + "defaultValue": "", + "required": true, + "group": "dbm-db2 Common 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.", + "type": "string", + "defaultValue": "", + "required": true, + "group": "dbm-db2 Common Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "type": "string", + "defaultValue": "", + "required": true, + "group": "dbm-db2 Common 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.\n \n You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "type": "string", + "required": false, + "stringLengthRange": [ + 1, + 1 + ], + "group": "dbm-db2 Common Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files when they already exist.\n \n \u001b[90m Default value: false \u001b[0m", + "type": "boolean", + "required": false, + "group": "dbm-db2 Common Options" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", + "type": "string", + "required": true, + "defaultValue": "", + "group": "dbm-db2 Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", + "type": "number", + "required": true, + "defaultValue": 7300, + "group": "dbm-db2 Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "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.", + "type": "string", + "required": true, + "defaultValue": "", + "group": "dbm-db2 Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "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.", + "type": "string", + "required": true, + "defaultValue": "", + "group": "dbm-db2 Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", + "type": "boolean", + "required": true, + "defaultValue": true, + "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.", + "type": "string", + "required": true, + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "defaultValue": "https", + "group": "dbm-db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more paired 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.\n\n \u001b[90m Format:\n\n :, :, …\n\n is the subsystem ID. is an entry that is configured in the DBM Data Service environments.yaml file. 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.\n\n Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300 \u001b[0m", + "type": "string", + "required": false, + "group": "dbm-db2 Connection Options" + }, + { + "name": "overwrite", + "aliases": [ + "ow" + ], + "description": "Overwrite the dbm-db2 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": "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "profile_name1", + "description": "Create a dbm-db2 profile named profile_name1 and default values for all the dbm-db2-profile options" + }, + { + "options": "dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss", + "description": "Create a dbm-db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss" + }, + { + "options": "dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false", + "description": "Create a dbm-db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates" + }, + { + "options": "dbm125 --host dbm125 --port 1443 --el “SUBA:prod@host1.com:322,SUBB:test@host2.net:522”", + "description": "Create a dbm-db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/create/ebg.jsonc b/profiles/create/ebg.jsonc index de712ef..2191197 100644 --- a/profiles/create/ebg.jsonc +++ b/profiles/create/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 90cd42d..9cb2797 100644 --- a/profiles/create/endevor-location.jsonc +++ b/profiles/create/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", @@ -6,7 +6,7 @@ "endevor-location" ], "summary": "Create a endevor-location profile", - "description": "The CA Endevor SCM element location, where you specify your working environment, system and subsystem", + "description": "The Endevor element location, where you specify your working environment, system and subsystem", "type": "command", "handler": "", "customize": { @@ -31,7 +31,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM environment where your project resides", + "description": "The Endevor environment where your project resides", "type": "string", "name": "environment", "aliases": [ @@ -45,7 +45,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM system where the element resides", + "description": "The Endevor system where the element resides", "type": "string", "name": "system", "aliases": [ @@ -58,7 +58,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM subsystem where your element resides", + "description": "The Endevor subsystem where your element resides", "type": "string", "name": "subsystem", "aliases": [ @@ -71,7 +71,7 @@ "group": "Options" }, { - "description": "Name of the CA Endevor SCM element's type", + "description": "Name of the Endevor element's type", "type": "string", "name": "type", "aliases": [ @@ -84,7 +84,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM stage where your project resides", + "description": "The Endevor stage where your project resides", "type": "string", "name": "stage-number", "aliases": [ @@ -99,7 +99,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM comment you want to use when performing an action", + "description": "The Endevor comment you want to use when performing an action", "type": "string", "name": "comment", "aliases": [ @@ -112,7 +112,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM CCID you want to use when performing an action", + "description": "The Endevor CCID you want to use when performing an action", "type": "string", "name": "ccid", "aliases": [ @@ -125,23 +125,13 @@ "group": "Options" }, { - "description": "The return code of CA Endevor SCM that defines a failed action", + "description": "The return code of Endevor that defines a failed action", "type": "number", "name": "maxrc", - "defaultValue": 8, + "defaultValue": 12, "group": "Options", "aliases": [] }, - { - "description": "Always override element signout, without having to specify the override signout option on each command", - "type": "boolean", - "name": "override-signout", - "aliases": [ - "os" - ], - "defaultValue": false, - "group": "Options" - }, { "name": "overwrite", "aliases": [ @@ -198,11 +188,11 @@ "examples": [ { "options": "ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR", - "description": "Create a location profile called 'ndvrLoc' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, with elements of type COBOL, using CA Endevor SCM web services configuration ENDEVOR" + "description": "Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR" }, { "options": "ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID'", - "description": "Create a location profile called 'ndvrLoc2' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment'" + "description": "Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment'" } ], "passOn": [], diff --git a/profiles/create/endevor.jsonc b/profiles/create/endevor.jsonc index 913df8d..2f9716d 100644 --- a/profiles/create/endevor.jsonc +++ b/profiles/create/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 5f7c660..e5753a3 100644 --- a/profiles/create/fmp.jsonc +++ b/profiles/create/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", @@ -6,7 +6,7 @@ "fmp" ], "summary": "Create a fmp profile", - "description": "CA File Master Plus profile schema.", + "description": "File Master Plus profile schema.", "type": "command", "handler": "", "customize": { @@ -26,7 +26,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options" @@ -36,7 +36,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options" @@ -67,7 +67,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "defaultValue": "https", "required": false, diff --git a/profiles/create/idms.jsonc b/profiles/create/idms.jsonc index 3d771c2..6ba2834 100644 --- a/profiles/create/idms.jsonc +++ b/profiles/create/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", @@ -64,7 +64,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "group": "IDMS Connection Options" }, diff --git a/profiles/create/jclcheck.jsonc b/profiles/create/jclcheck.jsonc index 51763e2..f2dd29d 100644 --- a/profiles/create/jclcheck.jsonc +++ b/profiles/create/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck-profile", diff --git a/profiles/create/mat.jsonc b/profiles/create/mat.jsonc index 5036f01..e8bafcf 100644 --- a/profiles/create/mat.jsonc +++ b/profiles/create/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", @@ -6,7 +6,7 @@ "mat" ], "summary": "Create a mat profile", - "description": "CA MAT Analyze CLI profile schema.", + "description": "MAT Analyze CLI profile schema.", "type": "command", "handler": "", "customize": { @@ -26,7 +26,7 @@ "aliases": [ "prt" ], - "description": "Specifies the protocol defined for the CA MAT REST API server (http or https).", + "description": "Specifies the protocol defined for the MAT REST API server (http or https).", "type": "string", "required": true, "allowableValues": { @@ -42,7 +42,7 @@ "aliases": [ "hn" ], - "description": "Specifies the hostname or IP address defined for the CA MAT REST API server (e.g. 127.0.0.0 or localhost).", + "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", "type": "string", "required": true, "group": "MAT Profile Options" @@ -82,7 +82,7 @@ "aliases": [ "zdis" ], - "description": "Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.", + "description": "Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.", "type": "boolean", "required": true, "allowableValues": { @@ -98,7 +98,7 @@ "aliases": [ "ldir" ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with CA MAT and listing retrieval through CA Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with CA MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through CA Endevor® footprints, you need to have the CA Endevor® Web Services installed and configured and specify the CA Endevor® web server details in the CA MAT database configuration.", + "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", "type": "string", "required": false, "group": "MAT Profile Options" @@ -159,11 +159,11 @@ "examples": [ { "options": "matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable true", - "description": "Create a MAT profile called 'matprofile' using your CA MAT configuration and REST API details, with the CA MAT REST API server integrated with the Zowe API Mediation Layer" + "description": "Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer" }, { "options": "matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable false --listingDir 'c:\\listings'", - "description": "Create a MAT profile called 'matprofile' using your CA MAT configuration and the details of the CA MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\\listings' directory to store program listings for instant analysis from your VS Code IDE" + "description": "Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\\listings' directory to store program listings for instant analysis from your VS Code IDE" } ], "passOn": [], diff --git a/profiles/create/ops.jsonc b/profiles/create/ops.jsonc index 61c8575..7da0e82 100644 --- a/profiles/create/ops.jsonc +++ b/profiles/create/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ops-profile", @@ -25,7 +25,7 @@ "description": "The hostname of the server where OPS Web Services is running.", "type": "string", "name": "host", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -36,14 +36,14 @@ "aliases": [ "p" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { "description": "Your z/OS user name used to authenticate to OPS Web Services", "type": "string", "name": "user", - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS", "aliases": [] }, @@ -54,7 +54,7 @@ "aliases": [ "pass" ], - "required": false, + "required": true, "group": "OPS WEB SERVICES CONNECTION OPTIONS" }, { diff --git a/profiles/create/pma.jsonc b/profiles/create/pma.jsonc index f80d6da..4b54dd7 100644 --- a/profiles/create/pma.jsonc +++ b/profiles/create/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", @@ -6,7 +6,7 @@ "pma" ], "summary": "Create a pma profile", - "description": "CA MAT Detect CLI profile schema.", + "description": "MAT Detect CLI profile schema.", "type": "command", "handler": "", "customize": { diff --git a/profiles/create/sysview-format.jsonc b/profiles/create/sysview-format.jsonc index 7bd43cf..ee9e83b 100644 --- a/profiles/create/sysview-format.jsonc +++ b/profiles/create/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 a2c0073..1665be3 100644 --- a/profiles/create/sysview.jsonc +++ b/profiles/create/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 e64ab47..8bf927b 100644 --- a/profiles/delete/ca7.jsonc +++ b/profiles/delete/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/delete/caspool.jsonc b/profiles/delete/caspool.jsonc index 261bd20..6214166 100644 --- a/profiles/delete/caspool.jsonc +++ b/profiles/delete/caspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool-profile", diff --git a/profiles/delete/caview.jsonc b/profiles/delete/caview.jsonc index 133f5f5..f6af6f9 100644 --- a/profiles/delete/caview.jsonc +++ b/profiles/delete/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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.jsonc b/profiles/delete/dbm-db2.jsonc new file mode 100644 index 0000000..268f307 --- /dev/null +++ b/profiles/delete/dbm-db2.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2" + ], + "summary": "Delete a dbm-db2 profile.", + "description": "Delete a dbm-db2 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": "", + "customize": { + "profileTypeIdentifier": "dbm-db2" + }, + "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": "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the dbm-db2 profile to be deleted. You can also load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "profilename", + "description": "Delete a dbm-db2 profile named profilename" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/delete/ebg.jsonc b/profiles/delete/ebg.jsonc index f196e3f..eff8791 100644 --- a/profiles/delete/ebg.jsonc +++ b/profiles/delete/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 adcd7bd..297fcb8 100644 --- a/profiles/delete/endevor-location.jsonc +++ b/profiles/delete/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 e509943..d95ac26 100644 --- a/profiles/delete/endevor.jsonc +++ b/profiles/delete/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 2b66c4b..a2e3d03 100644 --- a/profiles/delete/fmp.jsonc +++ b/profiles/delete/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 5cf430c..e3c8f66 100644 --- a/profiles/delete/idms.jsonc +++ b/profiles/delete/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/delete/jclcheck.jsonc b/profiles/delete/jclcheck.jsonc index 7a77a55..115b903 100644 --- a/profiles/delete/jclcheck.jsonc +++ b/profiles/delete/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck-profile", diff --git a/profiles/delete/mat.jsonc b/profiles/delete/mat.jsonc index f58ffe5..9d7628d 100644 --- a/profiles/delete/mat.jsonc +++ b/profiles/delete/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/delete/ops.jsonc b/profiles/delete/ops.jsonc index 179f6aa..af929b3 100644 --- a/profiles/delete/ops.jsonc +++ b/profiles/delete/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 927870e..3b574cb 100644 --- a/profiles/delete/pma.jsonc +++ b/profiles/delete/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 c6e5429..703af9c 100644 --- a/profiles/delete/sysview-format.jsonc +++ b/profiles/delete/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 563b1a1..90690e3 100644 --- a/profiles/delete/sysview.jsonc +++ b/profiles/delete/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 a6a34c3..b4de6e0 100644 --- a/profiles/list/ca7.jsonc +++ b/profiles/list/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profiles", diff --git a/profiles/list/caspool.jsonc b/profiles/list/caspool.jsonc index 7c74342..f4914f7 100644 --- a/profiles/list/caspool.jsonc +++ b/profiles/list/caspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool-profiles", @@ -6,7 +6,7 @@ "caspool" ], "summary": "List profiles of the type caspool.", - "description": "Configuration profile for CA Spool, where you specify information about your CA Spool instance", + "description": "Configuration profile for Spool, where you specify information about your Spool instance", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/caview.jsonc b/profiles/list/caview.jsonc index 5301d50..466eafe 100644 --- a/profiles/list/caview.jsonc +++ b/profiles/list/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profiles", @@ -6,7 +6,7 @@ "caview" ], "summary": "List profiles of the type caview.", - "description": "Configuration profile for CA View", + "description": "Configuration profile for View", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/dbm-db2.jsonc b/profiles/list/dbm-db2.jsonc new file mode 100644 index 0000000..43ecbe0 --- /dev/null +++ b/profiles/list/dbm-db2.jsonc @@ -0,0 +1,74 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-profiles", + "aliases": [ + "dbm-db2" + ], + "summary": "List profiles of the type dbm-db2.", + "description": "The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", + "type": "command", + "handler": "", + "customize": { + "profileTypeIdentifier": "dbm-db2" + }, + "options": [ + { + "name": "show-contents", + "aliases": [ + "sc" + ], + "description": "List dbm-db2 profiles and their contents. All profile details will be printed as part of command output.", + "type": "boolean", + "required": false, + "group": "Options" + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type dbm-db2" + }, + { + "options": "--sc", + "description": "List profiles of type dbm-db2 and display their contents" + } + ], + "positionals": [], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/list/ebg.jsonc b/profiles/list/ebg.jsonc index 7059e3e..ad9a29a 100644 --- a/profiles/list/ebg.jsonc +++ b/profiles/list/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 c6891b5..704a2ab 100644 --- a/profiles/list/endevor-location.jsonc +++ b/profiles/list/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profiles", @@ -6,7 +6,7 @@ "endevor-location" ], "summary": "List profiles of the type endevor-location.", - "description": "The CA Endevor SCM element location, where you specify your working environment, system and subsystem", + "description": "The Endevor element location, where you specify your working environment, system and subsystem", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/endevor.jsonc b/profiles/list/endevor.jsonc index dd8a283..4b7f608 100644 --- a/profiles/list/endevor.jsonc +++ b/profiles/list/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 b829d69..7c38c08 100644 --- a/profiles/list/fmp.jsonc +++ b/profiles/list/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profiles", @@ -6,7 +6,7 @@ "fmp" ], "summary": "List profiles of the type fmp.", - "description": "CA File Master Plus profile schema.", + "description": "File Master Plus profile schema.", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/idms.jsonc b/profiles/list/idms.jsonc index bff4a7a..031cf3d 100644 --- a/profiles/list/idms.jsonc +++ b/profiles/list/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profiles", diff --git a/profiles/list/jclcheck.jsonc b/profiles/list/jclcheck.jsonc index 905f227..4d1b2f9 100644 --- a/profiles/list/jclcheck.jsonc +++ b/profiles/list/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck-profiles", diff --git a/profiles/list/mat.jsonc b/profiles/list/mat.jsonc index 9e86d35..8aac690 100644 --- a/profiles/list/mat.jsonc +++ b/profiles/list/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profiles", @@ -6,7 +6,7 @@ "mat" ], "summary": "List profiles of the type mat.", - "description": "CA MAT Analyze CLI profile schema.", + "description": "MAT Analyze CLI profile schema.", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/ops.jsonc b/profiles/list/ops.jsonc index 1723b34..9d101b1 100644 --- a/profiles/list/ops.jsonc +++ b/profiles/list/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 ac42f04..79c51be 100644 --- a/profiles/list/pma.jsonc +++ b/profiles/list/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profiles", @@ -6,7 +6,7 @@ "pma" ], "summary": "List profiles of the type pma.", - "description": "CA MAT Detect CLI profile schema.", + "description": "MAT Detect CLI profile schema.", "type": "command", "handler": "", "customize": { diff --git a/profiles/list/sysview-format.jsonc b/profiles/list/sysview-format.jsonc index df201b6..5745c79 100644 --- a/profiles/list/sysview-format.jsonc +++ b/profiles/list/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 80c3238..73ce0d2 100644 --- a/profiles/list/sysview.jsonc +++ b/profiles/list/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 5beb5e3..18913b5 100644 --- a/profiles/set-default/ca7.jsonc +++ b/profiles/set-default/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/set-default/caspool.jsonc b/profiles/set-default/caspool.jsonc index 1f73c95..911251a 100644 --- a/profiles/set-default/caspool.jsonc +++ b/profiles/set-default/caspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool-profile", diff --git a/profiles/set-default/caview.jsonc b/profiles/set-default/caview.jsonc index 3a4adaa..cf3c9b5 100644 --- a/profiles/set-default/caview.jsonc +++ b/profiles/set-default/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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.jsonc b/profiles/set-default/dbm-db2.jsonc new file mode 100644 index 0000000..2cef672 --- /dev/null +++ b/profiles/set-default/dbm-db2.jsonc @@ -0,0 +1,67 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2" + ], + "summary": "Set the default\n profiles for the dbm-db2 group", + "description": "The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 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": "", + "options": [ + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the dbm-db2 group. When you issue commands within the dbm-db2 group without a profile specified as part of the command, the default will be loaded instead.", + "type": "string", + "required": true + } + ], + "customize": { + "profileTypeIdentifier": "dbm-db2" + }, + "examples": [ + { + "options": "profilename", + "description": "Set the default profile for type dbm-db2 to the profile named 'profilename'" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/set-default/ebg.jsonc b/profiles/set-default/ebg.jsonc index 8d18133..969516d 100644 --- a/profiles/set-default/ebg.jsonc +++ b/profiles/set-default/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 ed982d4..8b195c7 100644 --- a/profiles/set-default/endevor-location.jsonc +++ b/profiles/set-default/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 3b2361c..cab80e6 100644 --- a/profiles/set-default/endevor.jsonc +++ b/profiles/set-default/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 a21b60d..61fbdb5 100644 --- a/profiles/set-default/fmp.jsonc +++ b/profiles/set-default/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 d3a30bb..dc4806a 100644 --- a/profiles/set-default/idms.jsonc +++ b/profiles/set-default/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", diff --git a/profiles/set-default/jclcheck.jsonc b/profiles/set-default/jclcheck.jsonc index 7b3797f..e63fb82 100644 --- a/profiles/set-default/jclcheck.jsonc +++ b/profiles/set-default/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck-profile", diff --git a/profiles/set-default/mat.jsonc b/profiles/set-default/mat.jsonc index 0607ef7..2a133cb 100644 --- a/profiles/set-default/mat.jsonc +++ b/profiles/set-default/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", diff --git a/profiles/set-default/ops.jsonc b/profiles/set-default/ops.jsonc index 613aaa0..ae63e69 100644 --- a/profiles/set-default/ops.jsonc +++ b/profiles/set-default/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 47123c8..5406a91 100644 --- a/profiles/set-default/pma.jsonc +++ b/profiles/set-default/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 922be35..c654429 100644 --- a/profiles/set-default/sysview-format.jsonc +++ b/profiles/set-default/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 bc510e5..13d793a 100644 --- a/profiles/set-default/sysview.jsonc +++ b/profiles/set-default/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 99c19a2..d04876e 100644 --- a/profiles/update/ca7.jsonc +++ b/profiles/update/ca7.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "ca7-profile", diff --git a/profiles/update/caspool.jsonc b/profiles/update/caspool.jsonc index e3fca01..e950997 100644 --- a/profiles/update/caspool.jsonc +++ b/profiles/update/caspool.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caspool-profile", @@ -6,7 +6,7 @@ "caspool" ], "summary": "Update a caspool 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": "Configuration profile for CA Spool, where you specify information about your CA Spool instance", + "description": "Configuration profile for Spool, where you specify information about your Spool instance", "type": "command", "handler": "", "customize": { @@ -29,12 +29,12 @@ "a" ], "required": false, - "group": "CA SPOOL OPTIONS", + "group": "SPOOL OPTIONS", "absenceImplications": null, "implies": null }, { - "description": "High level qualifier of CA Spool installation.", + "description": "High level qualifier of Spool installation.", "type": "string", "name": "spoolhlq", "aliases": [ @@ -45,12 +45,12 @@ 35 ], "required": false, - "group": "CA SPOOL OPTIONS", + "group": "SPOOL OPTIONS", "absenceImplications": null, "implies": null }, { - "description": "CA Spool subsystem name.", + "description": "Spool subsystem name.", "type": "string", "name": "subsys", "aliases": [ @@ -60,13 +60,13 @@ 1, 4 ], - "group": "CA SPOOL OPTIONS", + "group": "SPOOL OPTIONS", "required": false, "absenceImplications": null, "implies": null }, { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with CA Spool.", + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", "type": "string", "name": "outds", "aliases": [ @@ -77,7 +77,7 @@ 44 ], "required": false, - "group": "CA SPOOL OPTIONS", + "group": "SPOOL OPTIONS", "absenceImplications": null, "implies": null }, @@ -93,7 +93,7 @@ 44 ], "required": false, - "group": "CA SPOOL OPTIONS", + "group": "SPOOL OPTIONS", "absenceImplications": null, "implies": null }, @@ -135,23 +135,23 @@ "examples": [ { "options": "myProfile --account 3213213210", - "description": "Update the TSO account information to '3213213210' for CA Spool profile named 'myProfile'" + "description": "Update the TSO account information to '3213213210' for Spool profile named 'myProfile'" }, { "options": "myProfile --spoolhlq CASPOOL.HLQ", - "description": "Update high level qualifier of the CA Spool installation to 'CASPOOL.HLQ' for CA Spool profile named 'myProfile'" + "description": "Update high level qualifier of the Spool installation to 'CASPOOL.HLQ' for Spool profile named 'myProfile'" }, { "options": "myProfile --subsys ESF2", - "description": "Update the CA Spool subsystem name to 'ESF2' for CA Spool profile named 'myProfile'" + "description": "Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile'" }, { "options": "myProfile --outds OUTPUT.RESPONSE.DS.NEW", - "description": "Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for CA Spool profile named 'myProfile'" + "description": "Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile'" }, { "options": "myProfile --clist USER.CLIST", - "description": "Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for CA Spool profile named 'myProfile'" + "description": "Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile'" } ], "passOn": [], diff --git a/profiles/update/caview.jsonc b/profiles/update/caview.jsonc index 31a7227..a774fb7 100644 --- a/profiles/update/caview.jsonc +++ b/profiles/update/caview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "caview-profile", @@ -6,7 +6,7 @@ "caview" ], "summary": "Update a caview 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": "Configuration profile for CA View", + "description": "Configuration profile for View", "type": "command", "handler": "", "customize": { @@ -24,7 +24,7 @@ { "type": "string", "name": "protocol", - "description": "Protocol of the target CA View REST API instance.", + "description": "Protocol of the target View REST API instance.", "required": false, "allowableValues": { "values": [ @@ -41,7 +41,7 @@ { "type": "string", "name": "hostname", - "description": "Hostname or ip address of the target CA View REST API instance.", + "description": "Hostname or ip address of the target View REST API instance.", "required": false, "absenceImplications": null, "implies": null, @@ -51,7 +51,10 @@ { "type": "number", "name": "port", - "description": "Port of the target CA View REST API instance.", + "aliases": [ + "P" + ], + "description": "Port of the target View REST API instance.", "numericValueRange": [ 0, 65535 @@ -59,13 +62,12 @@ "required": false, "absenceImplications": null, "implies": null, - "group": "Options", - "aliases": [] + "group": "Options" }, { "type": "string", "name": "base-path", - "description": "Context name of the target CA View REST API instance.", + "description": "Context name of the target View REST API instance.", "required": false, "absenceImplications": null, "implies": null, @@ -75,7 +77,7 @@ { "type": "string", "name": "username", - "description": "User name used to authenticate against the target CA View REST API instance.", + "description": "User name used to authenticate against the target View REST API instance.", "required": false, "absenceImplications": null, "implies": null, @@ -85,12 +87,15 @@ { "type": "string", "name": "password", - "description": "Password used to authenticate against the target CA View REST API instance.", + "aliases": [ + "pass", + "pw" + ], + "description": "Password used to authenticate against the target View REST API instance.", "required": false, "absenceImplications": null, "implies": null, - "group": "Options", - "aliases": [] + "group": "Options" }, { "name": "response-format-json", diff --git a/profiles/update/dbm-db2.jsonc b/profiles/update/dbm-db2.jsonc new file mode 100644 index 0000000..f48291b --- /dev/null +++ b/profiles/update/dbm-db2.jsonc @@ -0,0 +1,236 @@ +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "dbm-db2-profile", + "aliases": [ + "dbm-db2" + ], + "summary": "Update a dbm-db2 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 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", + "type": "command", + "handler": "", + "customize": { + "profileTypeIdentifier": "dbm-db2" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a newline delimited string of z/OS JCL JOB statements.", + "type": "string", + "required": false, + "group": "dbm-db2 Common Options", + "absenceImplications": null, + "implies": null + }, + { + "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.", + "type": "string", + "required": false, + "group": "dbm-db2 Common Options", + "absenceImplications": null, + "implies": null + }, + { + "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.", + "type": "string", + "required": false, + "group": "dbm-db2 Common Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.", + "type": "string", + "required": false, + "group": "dbm-db2 Common 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.\n \n You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.", + "type": "string", + "required": false, + "stringLengthRange": [ + 1, + 1 + ], + "group": "dbm-db2 Common Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files when they already exist.\n \n \u001b[90m Default value: false \u001b[0m", + "type": "boolean", + "required": false, + "group": "dbm-db2 Common Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", + "type": "string", + "required": false, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", + "type": "number", + "required": false, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "user", + "aliases": [ + "u" + ], + "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.", + "type": "string", + "required": false, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "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.", + "type": "string", + "required": false, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", + "type": "boolean", + "required": false, + "group": "dbm-db2 Connection 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.", + "type": "string", + "required": false, + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null, + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more paired 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.\n\n \u001b[90m Format:\n\n :, :, …\n\n is the subsystem ID. is an entry that is configured in the DBM Data Service environments.yaml file. 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.\n\n Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300 \u001b[0m", + "type": "string", + "required": false, + "group": "dbm-db2 Connection Options", + "absenceImplications": null, + "implies": null + }, + { + "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-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", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "dbm123 --user newuser --password newp4ss", + "description": "Update a dbm-db2 profile named dbm123 with a new username and password" + }, + { + "options": "profile_name1 --work-dataset-prefix NEWPREFX.DDL", + "description": "Update a dbm-db2 profile named profile_name1 with a new work data set prefix" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/ebg.jsonc b/profiles/update/ebg.jsonc index 685273e..67be86f 100644 --- a/profiles/update/ebg.jsonc +++ b/profiles/update/ebg.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 3677867..dc89b4b 100644 --- a/profiles/update/endevor-location.jsonc +++ b/profiles/update/endevor-location.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "endevor-location-profile", @@ -6,7 +6,7 @@ "endevor-location" ], "summary": "Update a endevor-location 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 CA Endevor SCM element location, where you specify your working environment, system and subsystem", + "description": "The Endevor element location, where you specify your working environment, system and subsystem", "type": "command", "handler": "", "customize": { @@ -34,7 +34,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM environment where your project resides", + "description": "The Endevor environment where your project resides", "type": "string", "name": "environment", "aliases": [ @@ -50,7 +50,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM system where the element resides", + "description": "The Endevor system where the element resides", "type": "string", "name": "system", "aliases": [ @@ -66,7 +66,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM subsystem where your element resides", + "description": "The Endevor subsystem where your element resides", "type": "string", "name": "subsystem", "aliases": [ @@ -82,7 +82,7 @@ "group": "Options" }, { - "description": "Name of the CA Endevor SCM element's type", + "description": "Name of the Endevor element's type", "type": "string", "name": "type", "aliases": [ @@ -98,7 +98,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM stage where your project resides", + "description": "The Endevor stage where your project resides", "type": "string", "name": "stage-number", "aliases": [ @@ -116,7 +116,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM comment you want to use when performing an action", + "description": "The Endevor comment you want to use when performing an action", "type": "string", "name": "comment", "aliases": [ @@ -132,7 +132,7 @@ "group": "Options" }, { - "description": "The CA Endevor SCM CCID you want to use when performing an action", + "description": "The Endevor CCID you want to use when performing an action", "type": "string", "name": "ccid", "aliases": [ @@ -148,7 +148,7 @@ "group": "Options" }, { - "description": "The return code of CA Endevor SCM that defines a failed action", + "description": "The return code of Endevor that defines a failed action", "type": "number", "name": "maxrc", "required": false, @@ -157,18 +157,6 @@ "group": "Options", "aliases": [] }, - { - "description": "Always override element signout, without having to specify the override signout option on each command", - "type": "boolean", - "name": "override-signout", - "aliases": [ - "os" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, { "name": "response-format-json", "aliases": [ diff --git a/profiles/update/endevor.jsonc b/profiles/update/endevor.jsonc index c0e9968..99af252 100644 --- a/profiles/update/endevor.jsonc +++ b/profiles/update/endevor.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 eee9d8f..fa2475e 100644 --- a/profiles/update/fmp.jsonc +++ b/profiles/update/fmp.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "fmp-profile", @@ -6,7 +6,7 @@ "fmp" ], "summary": "Update a fmp 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": "CA File Master Plus profile schema.", + "description": "File Master Plus profile schema.", "type": "command", "handler": "", "customize": { @@ -26,7 +26,7 @@ "aliases": [ "H" ], - "description": "Specifies CA File Master Plus server host name.", + "description": "Specifies File Master Plus server host name.", "type": "string", "required": false, "group": "FMP Connection Options", @@ -38,7 +38,7 @@ "aliases": [ "P" ], - "description": "Specifies CA File Master Plus server port.", + "description": "Specifies File Master Plus server port.", "type": "number", "required": false, "group": "FMP Connection Options", @@ -75,7 +75,7 @@ "aliases": [ "o" ], - "description": "Specifies CA File Master Plus REST API protocol.", + "description": "Specifies File Master Plus REST API protocol.", "type": "string", "required": false, "allowableValues": { diff --git a/profiles/update/idms.jsonc b/profiles/update/idms.jsonc index 828a472..88f4509 100644 --- a/profiles/update/idms.jsonc +++ b/profiles/update/idms.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "idms-profile", @@ -75,7 +75,7 @@ "aliases": [ "d" ], - "description": "Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", + "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", "type": "string", "group": "IDMS Connection Options", "required": false, diff --git a/profiles/update/jclcheck.jsonc b/profiles/update/jclcheck.jsonc index 57fa382..43bc469 100644 --- a/profiles/update/jclcheck.jsonc +++ b/profiles/update/jclcheck.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "jclcheck-profile", diff --git a/profiles/update/mat.jsonc b/profiles/update/mat.jsonc index 76f7a06..8b1211f 100644 --- a/profiles/update/mat.jsonc +++ b/profiles/update/mat.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "mat-profile", @@ -6,7 +6,7 @@ "mat" ], "summary": "Update a mat 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": "CA MAT Analyze CLI profile schema.", + "description": "MAT Analyze CLI profile schema.", "type": "command", "handler": "", "customize": { @@ -26,7 +26,7 @@ "aliases": [ "prt" ], - "description": "Specifies the protocol defined for the CA MAT REST API server (http or https).", + "description": "Specifies the protocol defined for the MAT REST API server (http or https).", "type": "string", "required": false, "allowableValues": { @@ -44,7 +44,7 @@ "aliases": [ "hn" ], - "description": "Specifies the hostname or IP address defined for the CA MAT REST API server (e.g. 127.0.0.0 or localhost).", + "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", "type": "string", "required": false, "group": "MAT Profile Options", @@ -92,7 +92,7 @@ "aliases": [ "zdis" ], - "description": "Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.", + "description": "Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.", "type": "boolean", "required": false, "allowableValues": { @@ -110,7 +110,7 @@ "aliases": [ "ldir" ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with CA MAT and listing retrieval through CA Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with CA MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through CA Endevor® footprints, you need to have the CA Endevor® Web Services installed and configured and specify the CA Endevor® web server details in the CA MAT database configuration.", + "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", "type": "string", "required": false, "group": "MAT Profile Options", diff --git a/profiles/update/ops.jsonc b/profiles/update/ops.jsonc index c05a9c7..e98c105 100644 --- a/profiles/update/ops.jsonc +++ b/profiles/update/ops.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 5debab0..8ab2edf 100644 --- a/profiles/update/pma.jsonc +++ b/profiles/update/pma.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "pma-profile", @@ -6,7 +6,7 @@ "pma" ], "summary": "Update a pma 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": "CA MAT Detect CLI profile schema.", + "description": "MAT Detect CLI profile schema.", "type": "command", "handler": "", "customize": { diff --git a/profiles/update/sysview-format.jsonc b/profiles/update/sysview-format.jsonc index 8585d6e..ef1f2ca 100644 --- a/profiles/update/sysview-format.jsonc +++ b/profiles/update/sysview-format.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 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 4f9145c..6f1ba18 100644 --- a/profiles/update/sysview.jsonc +++ b/profiles/update/sysview.jsonc @@ -1,4 +1,4 @@ -// Copyright (c) 2021 Broadcom. All Rights Reserved. The term +// Copyright (c) 2022 Broadcom. All Rights Reserved. The term // "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. { "name": "sysview-profile",