From e8e9d5272f4b081a031f39ec1ae42543a731aff2 Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Tue, 1 Oct 2024 16:17:57 -0400 Subject: [PATCH 1/4] Add Broadcom conformant V3 plug-ins Signed-off-by: Andrew W. Harn --- commandGroups/.gitkeep | 0 commandGroups/dbm-db2.jsonc | 3121 +++++ commandGroups/endevor.jsonc | 23975 ++++++++++++++++++++++++++++++++++ commandGroups/omspool.jsonc | 544 + commandGroups/ops.jsonc | 4737 +++++++ commandGroups/sysview.jsonc | 1341 ++ 6 files changed, 33718 insertions(+) delete mode 100644 commandGroups/.gitkeep create mode 100644 commandGroups/dbm-db2.jsonc create mode 100644 commandGroups/endevor.jsonc create mode 100644 commandGroups/omspool.jsonc create mode 100644 commandGroups/ops.jsonc create mode 100644 commandGroups/sysview.jsonc diff --git a/commandGroups/.gitkeep b/commandGroups/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/commandGroups/dbm-db2.jsonc b/commandGroups/dbm-db2.jsonc new file mode 100644 index 0000000..ee45e62 --- /dev/null +++ b/commandGroups/dbm-db2.jsonc @@ -0,0 +1,3121 @@ +// Copyright (c) 2024 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.\n \n For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "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 generate ddl' command.\n \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "verify", + "aliases": [ + "v" + ], + "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n\u001b[90m Default value: no \u001b[0m", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "yes", + "no" + ] + }, + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "DBM-Db2 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 DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "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 high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.\n \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "match-set", + "aliases": [ + "ms" + ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "match-set-file", + "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. \u001b[0m", + "type": "string", + "conflictsWith": [ + "match-set" + ], + "aliases": [ + "msf" + ], + "required": false, + "group": "Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set-file", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in and . If the same is specified multiple times, the first occurrence takes precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "name": "rule-set", + "aliases": [ + "rs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "id", + "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n\u001b[90m Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. \u001b[0m", + "required": false, + "type": "string", + "group": "Options", + "aliases": [] + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "output-compare-script", + "description": "Specifies the name of the local output file that contains the update script to make changes to objects that reside on the Db2 subsystem.\n \n\u001b[90m Default value: compare.txt \u001b[0m", + "type": "string", + "aliases": [ + "ocs" + ], + "required": false, + "group": "Options" + }, + { + "name": "output-summary-file", + "description": "Specifies the name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.\n \n\u001b[90m Default value: summary.txt \u001b[0m", + "type": "string", + "aliases": [ + "osf" + ], + "required": false, + "group": "Options" + }, + { + "name": "output-impact-file", + "description": "Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.\n \nTo determine the report format, supply one of the following extensions in the file name:\n- .json for JSON\n- .yaml or .yml for YAML\nIf no extension is provided, the format is set to JSON.\n \n\u001b[90m Default value: impact.json\n\nFor more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", + "type": "string", + "aliases": [ + "oif" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 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 DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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 rule set for the objects matched as determined by the local mask specifications in the pair.txt file" + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "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.\n \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "match-set", + "aliases": [ + "ms" + ], + "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n\u001b[90m Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "match-set-file", + "description": "Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n\u001b[90m Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. \u001b[0m", + "type": "string", + "conflictsWith": [ + "match-set" + ], + "aliases": [ + "msf" + ], + "required": false, + "group": "Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set-file", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.\n \n\u001b[90m Format:\n\n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in and . If the same is specified multiple times, the first occurrence takes precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "name": "rule-set", + "aliases": [ + "rs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n\u001b[90m Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 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 DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "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 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 \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli\n", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "output-recovery-script", + "description": "Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm execute script' command undoes the changes that were made by execution of the compare-script. \n \n\u001b[90m Default value: recovery.txt \u001b[0m", + "type": "string", + "aliases": [ + "ors", + "output-recovery-file", + "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 \nThe following restart options are valid:\n \nnew - Restart execution of the script at the first statement. \n \ntoken - 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": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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 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 \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli\n", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "target-db2", + "description": "Specifies the target Db2 subsystem or data sharing group where you want to execute the script. If this option is not specified, the target subsystem is identified by the first .CONNECT statement in the script.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.\n \n The target-db2 option takes precedence over any other value that is specified for the Db2 subsystem or data sharing group. \u001b[0m", + "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\nThe following options are valid:\n\nname - Begin execution of the specific section and process all subsequent statements up to the next section.\n\nA 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 \nnumber - Begin execution after the specific sync point (.SYNC statement) and process all statements up to the end of the script.\n \nname, 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 \nThe following restart options are valid:\n \nnew - Restart execution of the script at the first statement.\n \ntoken - 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 \nname, 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 \nA 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": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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 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 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 \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli\n", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "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 \nThe following restart options are valid:\n \nnew - Restart execution of the script at the first statement.\n \nname, 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 \nA 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": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 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": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "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 compare ddl' command.\n \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "object", + "description": "Specifies the Db2 objects to be generated in DDL. Use the optional include clause to include related Db2 objects.\n \n \u001b[90m Format: see the object-file description\n \n Note: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "o" + ], + "group": "Required Options" + }, + { + "name": "object-file", + "description": "Specifies the name of the local input file that contains a list of Db2 objects to be generated in DDL. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional include clause (,...) identifies one or more related Db2 object types to include in the object list.\n\nYou can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "of" + ], + "conflictsWith": [ + "object" + ], + "group": "Required Options" + }, + { + "name": "source-db2", + "aliases": [ + "sd" + ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set-file", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in and . If the same is specified multiple times, the first occurrence takes precedence.\n \nFor a full list of attributes, see Global Change Set Attributes in the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "name": "type", + "aliases": [ + "t" + ], + "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "drop", + "create" + ] + }, + "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": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 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 DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "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 execute migration-script' command.\n \nFor details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli", + "type": "command", + "handler": "", + "profile": { + "required": [], + "optional": [ + "dbm-db2", + "base" + ], + "suppressOptions": [] + }, + "options": [ + { + "name": "object", + "description": "Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format: see the object-file description\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "o" + ], + "group": "Required Options" + }, + { + "name": "object-file", + "description": "Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.\n \n\u001b[90m Format:\n\n [include(,...)];\n\nThe required clause identifies the specific Db2 (base) object:\n \nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nALIAS \nSYNONYM \nMQT \nSEQUENCE \nTRIGGER \nFUNCTION \nPROCEDURE \n\nThe optional include clause (,...) identifies one or more related Db2 object types to include in the object list.\n\nYou can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.\n \nExample:\n \ntable sysibm.systables include (tablespace, database, index);\ndatabase db1 include(children);\n\nNote: The --object and --object-file options are mutually exclusive. \u001b[0m", + "type": "string", + "aliases": [ + "of" + ], + "conflictsWith": [ + "object" + ], + "group": "Required Options" + }, + { + "name": "source-db2", + "aliases": [ + "sd" + ], + "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "target-db2", + "aliases": [ + "td" + ], + "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n \u001b[90m Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. \u001b[0m", + "required": false, + "type": "string", + "group": "Required Options" + }, + { + "name": "change-set", + "aliases": [ + "cs" + ], + "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n\u001b[90m Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "change-set-file", + "description": "Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.\n\n\u001b[90m Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in and . If the same is specified multiple times, the first occurrence takes precedence.\n \nFor a full list of attributes, see Global Change Set Attributes in the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", + "type": "string", + "aliases": [ + "csf" + ], + "required": false, + "group": "Options" + }, + { + "name": "output-migrate-script", + "description": "Specifies the name of the local output file that contains the script to make changes to objects that reside on the Db2 subsystem.\n \n\u001b[90m Default value: migration.txt \u001b[0m", + "type": "string", + "aliases": [ + "oms" + ], + "required": false, + "group": "Options" + }, + { + "name": "output-ddl-file", + "description": "Specifies the name of the local output file that contains the generated DDL for objects that are identified by the --object-file or --object option.\n \n\u001b[90m Default value: output.sql \u001b[0m", + "type": "string", + "aliases": [ + "odf" + ], + "required": false, + "group": "Options" + }, + { + "name": "error-file", + "aliases": [ + "ef" + ], + "description": "Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.\n \n\u001b[90m Default value: error.log \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "modification", + "aliases": [ + "m" + ], + "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n\u001b[90m For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt \u001b[0m", + "required": false, + "type": "string", + "group": "Options" + }, + { + "name": "dbm-db2-options-profile", + "description": "The name of a (dbm-db2-options) profile to load for this command execution.", + "type": "string", + "aliases": [ + "dbm-db2-options-p" + ], + "required": false, + "group": "Profile Options" + }, + { + "name": "protocol", + "description": "Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.", + "required": false, + "type": "string", + "allowableValues": { + "values": [ + "http", + "https" + ] + }, + "group": "DBM-Db2 Connection Options", + "aliases": [] + }, + { + "name": "environment-list", + "aliases": [ + "el" + ], + "description": "Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "job-cards", + "aliases": [ + "jc" + ], + "description": "Specifies a string array of z/OS JCL JOB statements.", + "required": false, + "type": "array", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "work-dataset-prefix", + "aliases": [ + "wdp" + ], + "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "delete-work-datasets", + "aliases": [ + "dwd" + ], + "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "overwrite-output-files", + "aliases": [ + "oof" + ], + "description": "Specifies whether to overwrite output files if they exist.", + "required": false, + "type": "boolean", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "authid", + "aliases": [ + "a" + ], + "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "sqlid", + "aliases": [ + "s" + ], + "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "termination-character", + "aliases": [ + "tc" + ], + "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", + "required": false, + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "DBM-Db2 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 DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "required": false, + "type": "string", + "group": "DBM-Db2 Connection Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + } + ], + "summary": "Interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.", + "aliases": [ + "dbm" + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/endevor.jsonc b/commandGroups/endevor.jsonc new file mode 100644 index 0000000..fa56cce --- /dev/null +++ b/commandGroups/endevor.jsonc @@ -0,0 +1,23975 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "endevor", + "description": "Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.", + "type": "group", + "children": [ + { + "name": "add", + "type": "group", + "description": "Add an Element into Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'adding element'", + "description": "Add element from local file with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The add element command lets you add an Element to an Environment entry Stage in Endevor.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-member", + "aliases": [ + "fm" + ], + "description": "Use this input to provide source member name in the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-path", + "aliases": [ + "fp" + ], + "description": "Use this input to provide the path of source USS file. It must be used with from-uss-file.", + "type": "string", + "stringLengthRange": [ + 1, + 768 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-text" + ], + "implies": [ + "from-uss-file" + ], + "group": "input sources options" + }, + { + "name": "from-uss-file", + "aliases": [ + "fuf" + ], + "description": "Use this input to provide source USS file name. It must be used with from-path", + "type": "string", + "stringLengthRange": [ + 1, + 255 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-text" + ], + "implies": [ + "from-path" + ], + "group": "input sources options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "new-version", + "aliases": [ + "nv" + ], + "description": "Assign a different version number to the Element.", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "group": "options" + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "generate", + "aliases": [ + "g" + ], + "description": "Specifies if you want to Generate Element after Add/Update action.", + "type": "boolean", + "required": false, + "group": "options" + }, + { + "name": "get-fingerprint", + "aliases": [ + "gfg" + ], + "description": "Return fingerprint of a retrieved, added or updated element as the first line of the response.", + "type": "boolean", + "defaultValue": false, + "group": "options" + }, + { + "name": "fingerprint", + "aliases": [ + "fg" + ], + "description": "Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-path", + "from-uss-file" + ], + "required": false, + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "approve", + "aliases": [ + "aprv" + ], + "type": "group", + "description": "Approve a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -n \"notes\" -i ENDEVOR", + "description": "Approve package with endevor profile set up, specifying approval notes" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The approve package command approves Package in Endevor for execution.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "notes", + "aliases": [ + "n" + ], + "description": "Notes for package.", + "type": "string", + "stringLengthRange": [ + 1, + 60 + ], + "conflictsWith": [ + "notes-from-file" + ], + "group": "options" + }, + { + "name": "notes-from-file", + "aliases": [ + "nff" + ], + "description": "Local file of notes for package.", + "type": "string", + "conflictsWith": [ + "notes" + ], + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "backin", + "type": "group", + "description": "Backin a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -i ENDEVOR", + "description": "Backin package with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The backin package command reverses the backout action and returns the Package to a status of Executed.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "statement", + "aliases": [ + "stmn" + ], + "description": "Specify the SCL statement number for the Element action that you want to back in or back out.", + "type": "number", + "group": "options" + }, + { + "name": "element", + "aliases": [ + "elm" + ], + "description": "Specify the Element name for the Element action that you want to back in or back out.", + "type": "string", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "backout", + "type": "group", + "description": "Backout a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -i ENDEVOR", + "description": "Backout package with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The backout package command restores the executable and output modules of the Package to the status they were in before execution.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "statement", + "aliases": [ + "stmn" + ], + "description": "Specify the SCL statement number for the Element action that you want to back in or back out.", + "type": "number", + "group": "options" + }, + { + "name": "element", + "aliases": [ + "elm" + ], + "description": "Specify the Element name for the Element action that you want to back in or back out.", + "type": "string", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "cast", + "type": "group", + "description": "Cast a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR", + "description": "Cast package with endevor profile set up, changing the execution window of the Package" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-date-time", + "aliases": [ + "fdt" + ], + "description": "Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "to-date-time", + "aliases": [ + "tdt" + ], + "description": "Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "validate-components", + "aliases": [ + "vc" + ], + "description": "Specify \"yes\" to enable component validation within the package, \"no\" to disable, and \"warn\" to generate a warning if component validation fails.", + "type": "string", + "allowableValues": { + "values": [ + "yes", + "no", + "warn" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "backout", + "description": "Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.", + "type": "boolean", + "group": "options", + "defaultValue": true, + "aliases": [] + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "check", + "type": "group", + "description": "Endevor Web Services Health Check.", + "children": [ + { + "examples": [ + { + "options": "ENDEVOR", + "description": "Perform health check of Endevor Web Services instance ENDEVOR" + } + ], + "name": "instance", + "type": "command", + "handler": "", + "description": "The check instance command triggers the web services health check for a given instance.", + "positionals": [ + { + "name": "instance", + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string" + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "commit", + "type": "group", + "description": "Commit a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName --delete-promotion-history -i ENDEVOR", + "description": "Commit package with endevor profile set up, specifying deletion of all promotion history" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "older-than", + "aliases": [ + "ot" + ], + "description": "Specify the minimum age of the package.", + "type": "number", + "group": "options" + }, + { + "name": "delete-promotion-history", + "aliases": [ + "dph" + ], + "description": "Specifies whether you want to delete all promotion history associated with previous versions of the Package", + "type": "boolean", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "confirm", + "aliases": [ + "conf" + ], + "type": "group", + "description": "Confirm a manual conflict resolution inside an Endevor workspace file is complete.", + "children": [ + { + "examples": [ + { + "options": " filename", + "description": "Confirm a manual conflict resolution has been finished for file 'filename'" + } + ], + "name": "resolution", + "aliases": [ + "res" + ], + "type": "command", + "handler": "", + "description": "Confirm a manual conflict resolution inside an Endevor workspace file is complete.", + "positionals": [ + { + "name": "workspace-file", + "description": "An Endevor workspace file (full or relative path).", + "type": "string" + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "create", + "type": "group", + "description": "Create a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -d \"package description\" --ff localfile.txt -i ENDEVOR", + "description": "Create package from local file with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The create package command lets you create a package in Endevor.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-member", + "aliases": [ + "fm" + ], + "description": "Use this input to provide source member name in the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-package", + "aliases": [ + "fp" + ], + "description": "Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.", + "type": "string", + "stringLengthRange": [ + 1, + 16 + ], + "conflictsWith": [ + "from-dataset", + "from-member", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-text", + "aliases": [ + "ft" + ], + "description": "Provides a string to use as input SCL.", + "type": "string", + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-uss-file" + ], + "group": "input sources options" + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "Allows you to associate a 50-character description when creating or updating package.", + "type": "string", + "stringLengthRange": [ + 1, + 50 + ], + "group": "options", + "required": true + }, + { + "name": "from-date-time", + "aliases": [ + "fdt" + ], + "description": "Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "to-date-time", + "aliases": [ + "tdt" + ], + "description": "Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "backout", + "description": "Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.", + "type": "boolean", + "group": "options", + "defaultValue": true, + "aliases": [] + }, + { + "name": "notes", + "aliases": [ + "n" + ], + "description": "Notes for package.", + "type": "string", + "stringLengthRange": [ + 1, + 60 + ], + "conflictsWith": [ + "notes-from-file" + ], + "group": "options" + }, + { + "name": "notes-from-file", + "aliases": [ + "nff" + ], + "description": "Local file of notes for package.", + "type": "string", + "conflictsWith": [ + "notes" + ], + "group": "options" + }, + { + "name": "emergency-package", + "aliases": [ + "ep" + ], + "description": "Specify if the package should be an emergency package. When not specified, the package is a standard package.", + "type": "boolean", + "group": "options" + }, + { + "name": "sharable", + "aliases": [ + "sh" + ], + "description": "Specify this option if the package can be edited by more than one person when in In-edit status.", + "type": "boolean", + "group": "options" + }, + { + "name": "promotion", + "aliases": [ + "pr" + ], + "description": "Specify this option to define the package as a promotion package.", + "type": "boolean", + "group": "options" + }, + { + "name": "validate-scl", + "aliases": [ + "vs" + ], + "description": "Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated", + "type": "boolean", + "group": "options", + "defaultValue": true + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "delete", + "aliases": [ + "del" + ], + "type": "group", + "description": "Delete an Element or a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Delete element with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The delete element command deletes an Element from the specified inventory location in Endevor.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "only-components", + "aliases": [ + "oc" + ], + "description": "Applicable for Endevor ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. \"No\" is the default option", + "type": "boolean", + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "packageName -i ENDEVOR", + "description": "Delete package with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The delete package command lets you delete Packages of any status type in Endevor.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "status", + "aliases": [ + "st" + ], + "description": "Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action. \nIt is possible to specify multiple status separated by \",\" during list and delete package.", + "type": "string", + "allowableValues": { + "values": [ + "ALLSTATE", + "INEDIT", + "INAPPROVAL", + "APPROVED", + "INEXECUTION", + "EXECUTED", + "COMMITTED", + "DENIED", + "EXECFAILED" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "older-than", + "aliases": [ + "ot" + ], + "description": "Specify the minimum age of the package.", + "type": "number", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "deny", + "type": "group", + "description": "Deny a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -n \"notes\" -i ENDEVOR", + "description": "Deny package with endevor profile set up, specifying denial notes" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The deny package command changes the status of a Package to Denied.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "notes", + "aliases": [ + "n" + ], + "description": "Notes for package.", + "type": "string", + "stringLengthRange": [ + 1, + 60 + ], + "conflictsWith": [ + "notes-from-file" + ], + "group": "options" + }, + { + "name": "notes-from-file", + "aliases": [ + "nff" + ], + "description": "Local file of notes for package.", + "type": "string", + "conflictsWith": [ + "notes" + ], + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "execute", + "type": "group", + "description": "Execute a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR", + "description": "Execute package with endevor profile set up, specifying the time frame within which to execute the Package" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The execute package command executes a Package that have a status of Approved or Execfailed.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-date-time", + "aliases": [ + "fdt" + ], + "description": "Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "to-date-time", + "aliases": [ + "tdt" + ], + "description": "Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "status", + "aliases": [ + "st" + ], + "description": "Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action. \nIt is possible to specify multiple status separated by \",\" during list and delete package.", + "type": "string", + "allowableValues": { + "values": [ + "ALLSTATE", + "INEDIT", + "INAPPROVAL", + "APPROVED", + "INEXECUTION", + "EXECUTED", + "COMMITTED", + "DENIED", + "EXECFAILED" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "generate", + "aliases": [ + "gen" + ], + "type": "group", + "description": "Generate an Element in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --cb -i ENDEVOR", + "description": "Generate an element with endevor profile set up, specifying option Copyback" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The generate element command executes the generate Processor for the current level of the Element.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "copy-back", + "aliases": [ + "cb" + ], + "description": "Specify if you want to copy the current level of the Element back to the FROM Stage, then perform this action. Do not use with --nosource option.", + "type": "boolean", + "conflictsWith": [ + "nosource" + ], + "group": "options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "nosource", + "aliases": [ + "ns" + ], + "description": "Specify if you want to have source-less Element. Do not use with --copy-back option.", + "type": "boolean", + "conflictsWith": [ + "copy-back" + ], + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "initialize", + "aliases": [ + "init" + ], + "type": "group", + "description": "Initialize a directory as an Endevor workspace.", + "children": [ + { + "examples": [ + { + "options": "", + "description": "initialize current directory as an Endevor workspace" + }, + { + "options": "'myWorkspace'", + "description": "initialize 'myWorkspace' directory as an Endevor workspace" + } + ], + "name": "workspace", + "aliases": [ + "wsp" + ], + "type": "command", + "handler": "", + "description": "Initialize current directory as an Endevor workspace.", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "workspace-dir", + "description": "The Endevor workspace directory, if different from current working directory.", + "type": "string" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "list", + "type": "group", + "description": "List instances, elements, types, packages and inventory locations in Endevor.", + "children": [ + { + "examples": [ + { + "options": "", + "description": "List the contents of the main Endevor configuration table (C1DEFLTS)" + } + ], + "name": "defaults", + "description": "List the contents of the main Endevor configuration table (C1DEFLTS)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "", + "description": "List the contents of the Endevor optional features table (ENCOPTBL)" + } + ], + "name": "features", + "description": "List the contents of the Endevor optional features table (ENCOPTBL)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "", + "description": "List the contents of the Endevor type sequence" + } + ], + "name": "type-sequence", + "aliases": [ + "typeseq" + ], + "description": "List the contents of the Endevor type sequence", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "", + "description": "List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)" + } + ], + "name": "dialog", + "description": "List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "", + "description": "List the Endevor site symbols" + } + ], + "name": "symbols", + "description": "List the Endevor site symbols", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "--host hostName --port 8080", + "description": "List instances with session specified" + } + ], + "name": "instances", + "aliases": [ + "instance", + "inst", + "i" + ], + "description": "The list instances command lists instances used by Endevor Web Services", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "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": "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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "--host hostName --port 8080", + "description": "List codepage-config with session specified" + } + ], + "name": "code-page-config", + "aliases": [ + "codepages", + "cdpg" + ], + "description": "The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "positionals": [], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all environments in Endevor with endevor profile set up" + } + ], + "name": "environments", + "aliases": [ + "environment", + "env" + ], + "description": "The list environments command lists environments in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "environment", + "type": "string", + "description": "Name of the Endevor environment.", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all stages in Endevor with endevor profile set up" + } + ], + "name": "stages", + "aliases": [ + "stage", + "stg" + ], + "description": "The list stages command lists stages in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "stage", + "type": "string", + "description": "Name of the Endevor stage", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all systems in Endevor with endevor profile set up" + } + ], + "name": "systems", + "aliases": [ + "system", + "sys", + "s" + ], + "description": "The list systems command lists system information in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "system", + "type": "string", + "description": "Name of the Endevor system", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all subsystems in Endevor with endevor profile set up" + } + ], + "name": "subsystems", + "aliases": [ + "subsystem", + "subsys", + "sbs" + ], + "description": "The list subsystems command lists subsystem information in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "subsystem", + "type": "string", + "description": "Name of the Endevor subsystem", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all types in Endevor with endevor profile set up" + } + ], + "name": "types", + "aliases": [ + "type", + "t" + ], + "description": "The list types command lists type information in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "type", + "type": "string", + "description": "Name of the Endevor type", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "--type TYPENAME --env ENVNAME --sn 1 --sys SYSNAME -i ENDEVOR", + "description": "List processor groups for type TYPENAME with endevor profile set up" + } + ], + "name": "processor-groups", + "aliases": [ + "processor-group", + "pgrp" + ], + "description": "The list processor-groups command lists processor group information in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "proc-group", + "type": "string", + "description": "Name of the Endevor processor group", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "PROCGROUP --env ENVNAME --sn 1 --sys SYSNAME --typ TYPENAME -i ENDEVOR", + "description": "List all processor symbols for group PROCGROUP with endevor profile set up" + } + ], + "name": "processor-symbols", + "aliases": [ + "processor-symbol", + "psym" + ], + "description": "The list processor-symbols command lists processor group symbol overrides information in Endevor", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "proc-group", + "type": "string", + "description": "Name of the Endevor processor group", + "required": false, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR", + "description": "List all packages in Endevor with endevor profile set up" + } + ], + "name": "packages", + "aliases": [ + "package", + "pkg", + "p" + ], + "type": "command", + "handler": "", + "description": "The list packages command lists package information in Endevor", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "status", + "aliases": [ + "st" + ], + "description": "Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action. \nIt is possible to specify multiple status separated by \",\" during list and delete package.", + "type": "string", + "allowableValues": { + "values": [ + "ALLSTATE", + "INEDIT", + "INAPPROVAL", + "APPROVED", + "INEXECUTION", + "EXECUTED", + "COMMITTED", + "DENIED", + "EXECFAILED" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "emergency-package", + "aliases": [ + "ep" + ], + "description": "Specify if the package should be an emergency package. When not specified, the package is a standard package.", + "type": "boolean", + "group": "options" + }, + { + "name": "enterprise", + "aliases": [ + "ent" + ], + "description": "Specify to filter the list by enterprise Package parameter. A - All, E - Enterprise, X - eXclude.", + "type": "string", + "allowableValues": { + "values": [ + "A", + "E", + "X" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "promotion-status", + "aliases": [ + "ps" + ], + "description": "Specify to filter the list by promotion Package parameter. A - All, P - Promotion, X - eXclude.", + "type": "string", + "allowableValues": { + "values": [ + "A", + "P", + "X" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "prom-target-env", + "aliases": [ + "pte" + ], + "description": "Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "options" + }, + { + "name": "prom-target-stgID", + "aliases": [ + "pts" + ], + "description": "Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.", + "type": "string", + "group": "options" + }, + { + "name": "approver", + "aliases": [ + "apr" + ], + "description": "Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported. ", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "-i ENDEVOR --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME", + "description": "List elements in Endevor from the specified inventory location with the endevor profile set up" + }, + { + "options": "--stext \"first or second and third\"", + "description": "List elements in Endevor using search text string" + } + ], + "name": "elements", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The list elements command lists element information in Endevor", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element", + "required": false, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "path", + "aliases": [ + "pa" + ], + "description": "Specifies a PHYsical or LOGical path.", + "type": "string", + "allowableValues": { + "values": [ + "log", + "phy" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "return", + "aliases": [ + "ret" + ], + "description": "Sets mapping options for returned results: return FIRst match or ALL matching results.", + "type": "string", + "allowableValues": { + "values": [ + "fir", + "all" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "data", + "aliases": [ + "dat" + ], + "description": "Allows to select the type of summary data returned in the element list:\nALL - Full element information\nBAS - Basic element information\nELE - Element change level summary\nCOMP - Component change level summary\n\nWhen data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter). \nIn all other cases default set of columns will be shown.", + "type": "string", + "allowableValues": { + "values": [ + "all", + "bas", + "ele", + "comp" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "options" + }, + { + "name": "where-ccid-generate", + "aliases": [ + "wcg" + ], + "description": "Instructs Endevor to search using the generate CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-lastact", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "options" + }, + { + "name": "where-ccid-lastact", + "aliases": [ + "wcla" + ], + "description": "Instructs Endevor to search using the last action CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "options" + }, + { + "name": "where-ccid-lastlvl", + "aliases": [ + "wcll" + ], + "description": "Instructs Endevor to search using the last level CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-change" + ], + "group": "options" + }, + { + "name": "where-ccid-change", + "aliases": [ + "wcchg" + ], + "description": "This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-lastlvl" + ], + "implies": [ + "data" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "options" + }, + { + "name": "where-proc-type", + "aliases": [ + "wpt" + ], + "description": "Lets you select Elements according to a specified Processor type.", + "type": "string", + "allowableValues": { + "values": [ + "GEN", + "GENERATE", + "MOV", + "MOVE", + "DEL", + "DELETE" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "search-text", + "aliases": [ + "stext" + ], + "description": "Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.\nFor complex search strings with quotation marks use search-text-file parameter.", + "type": "string", + "conflictsWith": [ + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-text-file", + "aliases": [ + "stf" + ], + "description": "File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.", + "type": "string", + "conflictsWith": [ + "search-text" + ], + "group": "endevor search text options" + }, + { + "name": "search-in", + "aliases": [ + "si" + ], + "description": "2 letters describing where search should be performed:\nes - Element Source\neh - Element History\nec - Element Changes\neu - Element Summary\ncs - Components Source\nch - Components History\ncc - Components Changes\ncu - Components Summary.", + "type": "string", + "allowableValues": { + "values": [ + "es", + "eh", + "ec", + "eu", + "cs", + "ch", + "cc", + "cu" + ], + "caseSensitive": false + }, + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-from", + "aliases": [ + "sf" + ], + "description": "Beginning interval of the column range for the search-text.", + "type": "number", + "numericValueRange": [ + 1, + 32000 + ], + "implies": [ + "search-to" + ], + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-to", + "aliases": [ + "st" + ], + "description": "Ending interval of the column range for the search-text.", + "type": "number", + "numericValueRange": [ + 1, + 32000 + ], + "implies": [ + "search-from" + ], + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-ignore-case", + "aliases": [ + "ic" + ], + "description": "Ignore search case.", + "type": "boolean", + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-in-binary", + "aliases": [ + "bin" + ], + "description": "Should the text search be performed in binary elements.", + "type": "boolean", + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "search-limit", + "aliases": [ + "sl" + ], + "description": "Maximum search limit where 0 is NOLIMIT.", + "type": "number", + "numericValueRange": [ + 0, + 2147483647 + ], + "impliesOneOf": [ + "search-text", + "search-text-file" + ], + "group": "endevor search text options" + }, + { + "name": "to-package", + "aliases": [ + "tp" + ], + "type": "string", + "description": "Specifies the package to which the SCL has to be appended. This option requires scl-action", + "required": false, + "implies": [ + "scl-action" + ], + "conflictsWith": [ + "asynchronous" + ], + "stringLengthRange": [ + 1, + 16 + ], + "group": "scl generation options" + }, + { + "name": "scl-action", + "aliases": [ + "sa" + ], + "description": "Specifies the action for the SCL that has to be built.", + "type": "string", + "allowableValues": { + "values": [ + "GENERATE", + "MOVE" + ], + "caseSensitive": false + }, + "implies": [ + "to-package" + ], + "group": "scl generation options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "--task-status fin", + "description": "List all finished tasks" + }, + { + "options": "2789102296850204364", + "description": "List a specific task to verify its completion status" + } + ], + "name": "tasks", + "type": "command", + "handler": "", + "description": "List asynchronous tasks submitted by this user", + "positionals": [ + { + "name": "task-id", + "description": "The id of an asynchronous Endevor web service task.", + "type": "string" + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "task-status", + "description": "Filter tasks by status: in-progress, finished or all.", + "type": "string", + "defaultValue": "all", + "allowableValues": { + "values": [ + "inp", + "fin", + "all" + ], + "caseSensitive": false + }, + "group": "asynchronous task options", + "aliases": [] + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "aliases": [], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + }, + { + "type": "command", + "name": "instances" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + }, + { + "type": "command", + "name": "instances" + } + ] + }, + { + "property": "options", + "value": { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + "merge": true + }, + { + "property": "options", + "value": { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + "merge": true, + "ignoreNodes": [ + { + "type": "group" + }, + { + "type": "command", + "name": "instances" + }, + { + "type": "command", + "name": "tasks" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "merge", + "aliases": [ + "mrg" + ], + "type": "group", + "description": "Merge Endevor elements from one Endevor location into another", + "children": [ + { + "examples": [ + { + "options": "ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM", + "description": "Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile)" + }, + { + "options": "* --merge-out-of-sync", + "description": "Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile)" + }, + { + "options": "* --merge-out-of-sync --dry-run", + "description": "Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile)" + }, + { + "options": "* --system SYSTO --subsystem SUBTO --merge-system SYSFROM --merge-subsystem SUBFROM", + "description": "Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile)" + }, + { + "options": "ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM --ccid MYCCID --comment 'my comment' --signout --overrride-signout", + "description": "Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into SUBTO, retrieving both elements using the provided ccid & comment, with signout, and overriding signout if necessary" + } + ], + "name": "element", + "aliases": [ + "ele" + ], + "type": "command", + "handler": "", + "description": "Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use \"synchronize workspace\" command afterwards to push the result back into Endevor.", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element", + "required": false, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "merge-environment", + "aliases": [ + "menv" + ], + "type": "string", + "description": "Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.", + "stringLengthRange": [ + 1, + 255 + ], + "group": "merge-location definition options" + }, + { + "name": "merge-stage-number", + "aliases": [ + "msn" + ], + "type": "string", + "description": "Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.", + "stringLengthRange": [ + 1, + 255 + ], + "group": "merge-location definition options" + }, + { + "name": "merge-system", + "aliases": [ + "msys" + ], + "type": "string", + "description": "Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.", + "stringLengthRange": [ + 1, + 255 + ], + "group": "merge-location definition options" + }, + { + "name": "merge-subsystem", + "aliases": [ + "msub" + ], + "type": "string", + "description": "Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.", + "stringLengthRange": [ + 1, + 255 + ], + "group": "merge-location definition options" + }, + { + "name": "merge-out-of-sync", + "aliases": [ + "moos" + ], + "type": "boolean", + "description": "Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.", + "conflictsWith": [ + "merge-environment", + "merge-stage-number", + "merge-system", + "merge-subsystem" + ], + "group": "merge-location definition options" + }, + { + "name": "workspace-dir", + "aliases": [ + "wsp" + ], + "description": "The Endevor workspace directory, if different from current working directory.", + "defaultValue": ".", + "required": false, + "type": "string", + "group": "workspace options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of any Endevor elements affected by this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "signout", + "description": "Specify if you want to perform the action with signing out any retrieved elements.", + "type": "boolean", + "group": "options", + "aliases": [] + }, + { + "name": "dry-run", + "aliases": [ + "dr" + ], + "description": "List all actions the synchronization would perform, without executing them.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "limit", + "aliases": [ + "lim" + ], + "description": "If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.", + "type": "number", + "defaultValue": 0, + "group": "workspace options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "move", + "aliases": [ + "mv" + ], + "type": "group", + "description": "Move an Element in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Move element from specified inventory location with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The move element command moves Elements between inventory locations along a map.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "sync", + "aliases": [ + "s" + ], + "description": "Specify if you want to synchronize source and current level of the Elements while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "with-history", + "aliases": [ + "wh" + ], + "description": "Specify if you want to preserve the change history of the Elements while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "bypass-element-delete", + "aliases": [ + "bed" + ], + "description": "Specify if you want to retain the Elements in the source Stage after successfully completing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "retain-signout", + "aliases": [ + "rs" + ], + "description": "Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.", + "type": "boolean", + "conflictsWith": [ + "signout-to" + ], + "group": "options" + }, + { + "name": "signout-to", + "aliases": [ + "st" + ], + "description": "Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.", + "type": "string", + "conflictsWith": [ + "retain-signout" + ], + "group": "options" + }, + { + "name": "jump", + "aliases": [ + "j" + ], + "description": "Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "print", + "aliases": [ + "p" + ], + "type": "group", + "description": "Print an Element or a Component in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Print element from specified inventory location with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "description": "The print element command prints selected information about Element in Endevor.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "level", + "aliases": [ + "lev" + ], + "description": "Indicates the level number of the element (use along with the version option).", + "type": "number", + "numericValueRange": [ + 0, + 99 + ], + "implies": [ + "element-version" + ], + "group": "options" + }, + { + "name": "element-version", + "aliases": [ + "ev" + ], + "description": "Indicates the version number of the element (use along with the level option).", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "implies": [ + "level" + ], + "group": "options" + }, + { + "name": "print", + "type": "string", + "description": "Specify the type of data to print out for print element command", + "required": false, + "defaultValue": "browse", + "allowableValues": { + "values": [ + "browse", + "changes", + "history", + "summary", + "master", + "listing" + ], + "caseSensitive": false + }, + "group": "options", + "aliases": [] + }, + { + "name": "list-string", + "aliases": [ + "ls" + ], + "type": "string", + "description": "Specifies the one to eight character text-string used to identify the listing data set to print.", + "required": false, + "stringLengthRange": [ + 1, + 8 + ], + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "headings", + "type": "boolean", + "description": "Specify it if you want to print a header on each page.", + "required": false, + "group": "options", + "aliases": [] + }, + { + "name": "explode", + "aliases": [ + "exp", + "ex" + ], + "type": "boolean", + "description": "Specify to print component info from ACMQ.", + "required": false, + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Print selected component information about Element with endevor profile set up" + } + ], + "name": "components", + "aliases": [ + "comp" + ], + "description": "The print component command prints selected component information about Element in Endevor.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "level", + "aliases": [ + "lev" + ], + "description": "Indicates the level number of the element (use along with the version option).", + "type": "number", + "numericValueRange": [ + 0, + 99 + ], + "implies": [ + "element-version" + ], + "group": "options" + }, + { + "name": "element-version", + "aliases": [ + "ev" + ], + "description": "Indicates the version number of the element (use along with the level option).", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "implies": [ + "level" + ], + "group": "options" + }, + { + "name": "print-comp", + "aliases": [ + "pc" + ], + "type": "string", + "description": "Specify the type of data to print out for print component command", + "required": false, + "defaultValue": "browse", + "allowableValues": { + "values": [ + "browse", + "changes", + "history", + "summary" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "headings", + "type": "boolean", + "description": "Specify it if you want to print a header on each page.", + "required": false, + "group": "options", + "aliases": [] + }, + { + "name": "explode", + "aliases": [ + "exp", + "ex" + ], + "type": "boolean", + "description": "Specify to print component info from ACMQ.", + "required": false, + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "memName --fd DSNAME -i ENDEVOR", + "description": "Print a member from specified dataset" + } + ], + "name": "member", + "aliases": [ + "mem" + ], + "description": "The print member command prints a member from a specified dataset.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "member", + "type": "string", + "description": "Name of the member.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "headings", + "type": "boolean", + "description": "Specify it if you want to print a header on each page.", + "required": false, + "group": "options", + "aliases": [] + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "queryacm", + "type": "group", + "description": "Query Elements and information about their components in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME -i ENDEVOR", + "description": "query all the components used by element \"elementName\" from the specified inventory location with the endevor profile set up" + } + ], + "name": "components", + "aliases": [ + "comp" + ], + "type": "command", + "handler": "", + "description": "Query components used by a specified Element with the Endevor ACM Query facility.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "excCirculars", + "aliases": [ + "exc" + ], + "description": "Filters the result to exclude components that have a circular relationship to the subject of your search.", + "type": "boolean", + "group": "options" + }, + { + "name": "excIndirect", + "aliases": [ + "exi" + ], + "description": "Filters the result to exclude indirectly related components.", + "type": "boolean", + "group": "options" + }, + { + "name": "excRelated", + "aliases": [ + "exr" + ], + "description": "Filters the result to exclude related components.", + "type": "boolean", + "group": "options" + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "reset", + "type": "group", + "description": "Reset a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName -i ENDEVOR", + "description": "Reset package with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The reset package command lets you set the status of a Package back to In-edit so you can modify it.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "retrieve", + "aliases": [ + "ret" + ], + "type": "group", + "description": "Retrieve an Element in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME --tf localfile.txt -i ENDEVOR", + "description": "Retrieve element from specified inventory location to local file with endevor profile set up" + }, + { + "options": "\"*\" --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ \"*\" --to-dir /user/localdir -i ENDEVOR", + "description": "Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The retrieve element command retrieves an existing element in Endevor.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "element-version", + "aliases": [ + "ev" + ], + "description": "Indicates the version number of the element (use along with the level option).", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "implies": [ + "level" + ], + "group": "options" + }, + { + "name": "level", + "aliases": [ + "lev" + ], + "description": "Indicates the level number of the element (use along with the version option).", + "type": "number", + "numericValueRange": [ + 0, + 99 + ], + "implies": [ + "element-version" + ], + "group": "options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "signout", + "description": "Specify if you want to perform the action with signing the element out.", + "type": "boolean", + "group": "options", + "aliases": [] + }, + { + "name": "replace-member", + "aliases": [ + "replace", + "rm" + ], + "description": "Specify if you want to replace the member currently in the library with the new element contents", + "type": "boolean", + "group": "options" + }, + { + "name": "expand-includes", + "aliases": [ + "expand", + "ei" + ], + "description": "Indicates that INCLUDE statements should be expanded in the course of the action.", + "type": "boolean", + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "get-fingerprint", + "aliases": [ + "gfg" + ], + "description": "Return fingerprint of a retrieved, added or updated element as the first line of the response.", + "type": "boolean", + "defaultValue": false, + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "to-path", + "aliases": [ + "tp" + ], + "description": "Provide a USS path to a destination location.", + "type": "string", + "stringLengthRange": [ + 1, + 768 + ], + "conflictsWith": [ + "to-dataset", + "to-member", + "to-file" + ], + "group": "output location options" + }, + { + "name": "to-uss-file", + "aliases": [ + "tuf" + ], + "description": "Provide a USS file as a destination file.", + "type": "string", + "stringLengthRange": [ + 1, + 255 + ], + "conflictsWith": [ + "to-dataset", + "to-member", + "to-file" + ], + "group": "output location options" + }, + { + "name": "to-dataset", + "aliases": [ + "td" + ], + "description": "Provide a destination data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "to-path", + "to-uss-file", + "to-file" + ], + "group": "output location options" + }, + { + "name": "to-member", + "aliases": [ + "tm" + ], + "description": "Provide a destination member name inside the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "to-path", + "to-uss-file", + "to-file" + ], + "group": "output location options" + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "to-dir", + "aliases": [ + "tdir" + ], + "description": "Directory name in which the command output will be stored.", + "type": "string", + "conflictsWith": [ + "to-file", + "to-dataset", + "to-member", + "to-path", + "to-uss-file" + ], + "group": "bulk action options" + }, + { + "name": "flat", + "description": " Store the output of the bulk action within one folder. When you use this option, ensure that the results do not contain duplicate names. (Duplicate names occur when two or more Elements have the same name and type.)", + "type": "boolean", + "implies": [ + "to-dir" + ], + "group": "bulk action options", + "aliases": [] + }, + { + "name": "with-dependencies", + "aliases": [ + "wd" + ], + "description": "Retrieve Elements, including their Endevor-managed input components.", + "type": "boolean", + "implies": [ + "to-dir" + ], + "group": "bulk action options" + }, + { + "name": "where-ccid-generate", + "aliases": [ + "wcg" + ], + "description": "Instructs Endevor to search using the generate CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-lastact", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "bulk action options", + "implies": [ + "to-dir" + ] + }, + { + "name": "where-ccid-lastact", + "aliases": [ + "wcla" + ], + "description": "Instructs Endevor to search using the last action CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastlvl", + "where-ccid-change" + ], + "group": "bulk action options", + "implies": [ + "to-dir" + ] + }, + { + "name": "where-ccid-lastlvl", + "aliases": [ + "wcll" + ], + "description": "Instructs Endevor to search using the last level CCID associated with an Element. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-change" + ], + "group": "bulk action options", + "implies": [ + "to-dir" + ] + }, + { + "name": "where-ccid-change", + "aliases": [ + "wcchg" + ], + "description": "This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current", + "where-ccid-retrieve", + "where-ccid-generate", + "where-ccid-lastact", + "where-ccid-lastlvl" + ], + "implies": [ + "to-dir" + ], + "group": "bulk action options" + }, + { + "name": "file-extension", + "aliases": [ + "ext" + ], + "description": "The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.", + "type": "string", + "allowableValues": { + "values": [ + "none", + "file-ext", + "type-name", + "mixed" + ], + "caseSensitive": false + }, + "defaultValue": "mixed", + "group": "bulk action options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "2789102296850204364", + "description": "Retrieve the result of task 2789102296850204364" + } + ], + "name": "result", + "aliases": [ + "res" + ], + "type": "command", + "handler": "", + "description": "Retrieve the result of an asynchronous task", + "positionals": [ + { + "name": "task-id", + "description": "The id of an asynchronous Endevor web service task.", + "type": "string" + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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 + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "signin", + "aliases": [ + "si" + ], + "type": "group", + "description": "Signin an Element in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Signin element with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The signin element command signs in an existing element in Endevor.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "signout-to", + "aliases": [ + "st" + ], + "description": "Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.", + "type": "string", + "conflictsWith": [ + "retain-signout" + ], + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "submit", + "type": "group", + "description": "Submit a Package or a SCL file in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName --ff jobcardfile.txt -i ENDEVOR", + "description": "Submit package using jobcard from local file, with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The submit package command submits a JCL job stream to execute one or more Packages.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-member", + "aliases": [ + "fm" + ], + "description": "Use this input to provide source member name in the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "to-CA7", + "aliases": [ + "t7" + ], + "description": "Specify to send the submission of the package to CA 7 scheduler.", + "type": "boolean", + "group": "output location options" + }, + { + "name": "to-ddname", + "aliases": [ + "tdd" + ], + "description": "Send the submission of the package to be processed according to a DDName specified in the starter task (STC).", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "output location options" + }, + { + "name": "status", + "aliases": [ + "st" + ], + "description": "Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action. \nIt is possible to specify multiple status separated by \",\" during list and delete package.", + "type": "string", + "allowableValues": { + "values": [ + "ALLSTATE", + "INEDIT", + "INAPPROVAL", + "APPROVED", + "INEXECUTION", + "EXECUTED", + "COMMITTED", + "DENIED", + "EXECFAILED" + ], + "caseSensitive": false + }, + "group": "options" + }, + { + "name": "multiple-streams", + "aliases": [ + "ms" + ], + "description": "Specify to submit a separate, unique job for each package. If you do not specify this, a single job with a unique job step for each package is submitted.", + "type": "boolean", + "group": "options" + }, + { + "name": "increment-jobname", + "aliases": [ + "ij" + ], + "description": "Specify to increases the last character in the jobcard you provide.", + "type": "boolean", + "group": "options" + }, + { + "name": "jcl-procedure", + "aliases": [ + "jp" + ], + "description": "This option lets you to identify the name of the JCL procedure that you want to invoke. ENDEVOR is used by default if any processor is specified.", + "type": "string", + "group": "options" + }, + { + "name": "CA7-dependent-job", + "aliases": [ + "7dj" + ], + "description": "Specifies a single predecessor job which must complete while demanded job is waiting in the CA 7 scheduler.", + "type": "string", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "--sf sclfile.txt --sclt element -i ENDEVOR", + "description": "Submit a SCL of type element, with endevor profile set up" + } + ], + "name": "scl", + "type": "command", + "handler": "", + "description": "The submit scl commands submits a SCL file to be executed.", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "scl-file", + "aliases": [ + "sf", + "sclf" + ], + "description": "The file which contains the Endevor SCL you would like to submit.", + "type": "string", + "required": true, + "group": "options" + }, + { + "name": "scl-type", + "aliases": [ + "sclt" + ], + "description": "The category of Endevor SCL.", + "type": "string", + "allowableValues": { + "values": [ + "list", + "element", + "package", + "admin", + "ship", + "addUpdRtv" + ], + "caseSensitive": false + }, + "required": true, + "group": "options" + }, + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "synchronize", + "aliases": [ + "sync" + ], + "type": "group", + "description": "Synchronize remote Endevor inventory with the local Endevor workspace.", + "children": [ + { + "examples": [ + { + "options": "", + "description": "Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory" + }, + { + "options": "'C:/projects/myWorkspace'", + "description": "Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace'" + }, + { + "options": "--environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'", + "description": "Synchronize all elements in system SYSTEM1 subsystem SUBSYS1 from environment DEV stage 1, whose type begins with 'ASM', with current directory" + }, + { + "options": "'C:/projects/myWorkspace' --ccid myccid --comment 'my changes' --element PRFX%%11", + "description": "Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace'" + }, + { + "options": "--dry-run --endevor-location-profile mysandbox", + "description": "Display all actions needed to synchronize all elements in the map location defined by endevor-location profile 'mysandbox' with current directory, without performing them" + }, + { + "options": "--reset", + "description": "Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor" + } + ], + "name": "workspace", + "aliases": [ + "wsp" + ], + "type": "command", + "handler": "", + "description": "Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "workspace-dir", + "description": "The Endevor workspace directory, if different from current working directory.", + "type": "string" + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of any Endevor elements affected by this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "signout", + "description": "Specify if you want to perform the action with signing out any retrieved elements.", + "type": "boolean", + "group": "options", + "aliases": [] + }, + { + "name": "element", + "aliases": [ + "ele", + "elem" + ], + "type": "string", + "description": "Name filter to synchronize only specific Endevor element(s).", + "defaultValue": "*", + "stringLengthRange": [ + 1, + 255 + ], + "group": "workspace options" + }, + { + "name": "dry-run", + "aliases": [ + "dr" + ], + "description": "List all actions the synchronization would perform, without executing them.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "reset", + "aliases": [ + "rst" + ], + "description": "Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "limit", + "aliases": [ + "lim" + ], + "description": "If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.", + "type": "number", + "defaultValue": 0, + "group": "workspace options" + }, + { + "name": "one-way", + "aliases": [], + "description": "Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "allow-deletes", + "aliases": [ + "del" + ], + "description": "Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "file-extension", + "aliases": [ + "ext" + ], + "description": "The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.", + "type": "string", + "allowableValues": { + "values": [ + "none", + "file-ext", + "type-name", + "mixed" + ], + "caseSensitive": false + }, + "defaultValue": "mixed", + "group": "workspace options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "transfer", + "aliases": [ + "tr" + ], + "type": "group", + "description": "Transfer an Element in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --tosn 2 --sys SYS --sub SUB --typ TYPE -i ENDEVOR", + "description": "Transfer element from specified inventory location to 1 stage higher in map, with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The Transfer element command transfers Elements from one Endevor location to another.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "to-environment", + "aliases": [ + "toenv" + ], + "description": "The target Endevor environment.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "output location options" + }, + { + "name": "to-system", + "aliases": [ + "tosys" + ], + "description": "The target Endevor system.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "output location options" + }, + { + "name": "to-subsystem", + "aliases": [ + "tosub" + ], + "description": "The target Endevor subsystem.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "output location options" + }, + { + "name": "to-element", + "aliases": [ + "toele" + ], + "description": "The target Endevor element name.", + "type": "string", + "stringLengthRange": [ + 1, + 255 + ], + "group": "output location options" + }, + { + "name": "to-type", + "aliases": [ + "totyp" + ], + "description": "The target Endevor element type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "output location options" + }, + { + "name": "to-stage-number", + "aliases": [ + "tosn" + ], + "description": "The target Endevor stage Id/number.", + "type": "string", + "stringLengthRange": [ + 1, + 1 + ], + "group": "output location options" + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "element-version", + "aliases": [ + "ev" + ], + "description": "Indicates the version number of the element (use along with the level option).", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "implies": [ + "level" + ], + "group": "options" + }, + { + "name": "level", + "aliases": [ + "lev" + ], + "description": "Indicates the level number of the element (use along with the version option).", + "type": "number", + "numericValueRange": [ + 0, + 99 + ], + "implies": [ + "element-version" + ], + "group": "options" + }, + { + "name": "new-version", + "aliases": [ + "nv" + ], + "description": "Assign a different version number to the Element.", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "group": "options" + }, + { + "name": "sync", + "aliases": [ + "s" + ], + "description": "Specify if you want to synchronize source and current level of the Elements while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "with-history", + "aliases": [ + "wh" + ], + "description": "Specify if you want to preserve the change history of the Elements while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "ignore-generate-failed", + "aliases": [ + "igf" + ], + "description": "Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.", + "type": "boolean", + "group": "options" + }, + { + "name": "bypass-element-delete", + "aliases": [ + "bed" + ], + "description": "Specify if you want to retain the Elements in the source Stage after successfully completing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "bypass-delete-proc", + "aliases": [ + "bdp" + ], + "description": "Specity to bypasses the execution of the delete processor.", + "type": "boolean", + "group": "options" + }, + { + "name": "bypass-generate-proc", + "aliases": [ + "bgp" + ], + "description": "Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.", + "type": "boolean", + "group": "options" + }, + { + "name": "retain-signout", + "aliases": [ + "rs" + ], + "description": "Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.", + "type": "boolean", + "conflictsWith": [ + "signout-to" + ], + "group": "options" + }, + { + "name": "signout-to", + "aliases": [ + "st" + ], + "description": "Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.", + "type": "string", + "conflictsWith": [ + "retain-signout" + ], + "group": "options" + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "unsynchronize", + "aliases": [ + "unsync" + ], + "type": "group", + "description": "Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.", + "children": [ + { + "examples": [ + { + "options": "", + "description": "Remove all elements in the map location defined by the currently active endevor-location profile from current directory" + }, + { + "options": "--force", + "description": "Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor" + }, + { + "options": "'C:/projects/myWorkspace'", + "description": "Remove all elements in the map location defined by the currently active endevor-location profile from workspace directory 'C:/projects/myWorkspace'" + }, + { + "options": "--environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'", + "description": "Remove all elements in system SYSTEM1 subsystem SUBSYS1 environment DEV stage 1, whose type begins with 'ASM', from current directory" + } + ], + "name": "workspace", + "aliases": [ + "wsp" + ], + "type": "command", + "handler": "", + "description": "Remove a selected subset of remote Endevor inventory from a local Endevor workspace", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "positionals": [ + { + "name": "workspace-dir", + "description": "The Endevor workspace directory, if different from current working directory.", + "type": "string" + } + ], + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "\\*", + "\\%", + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "element", + "aliases": [ + "ele", + "elem" + ], + "type": "string", + "description": "Name filter to synchronize only specific Endevor element(s).", + "defaultValue": "*", + "stringLengthRange": [ + 1, + 255 + ], + "group": "workspace options" + }, + { + "name": "force", + "aliases": [ + "f" + ], + "description": "Force unsynchronization of local workspace regardless of any local changes not yet saved into Endevor.", + "type": "boolean", + "group": "workspace options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "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": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "update", + "type": "group", + "description": "Update an Element or a Package in Endevor.", + "children": [ + { + "examples": [ + { + "options": "packageName --ff localfile.txt -i ENDEVOR", + "description": "Update package from local file with endevor profile set up" + } + ], + "name": "package", + "aliases": [ + "pkg" + ], + "type": "command", + "handler": "", + "description": "The update package command lets you update a package in Endevor.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-member", + "aliases": [ + "fm" + ], + "description": "Use this input to provide source member name in the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-package", + "aliases": [ + "fp" + ], + "description": "Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.", + "type": "string", + "stringLengthRange": [ + 1, + 16 + ], + "conflictsWith": [ + "from-dataset", + "from-member", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-text", + "aliases": [ + "ft" + ], + "description": "Provides a string to use as input SCL.", + "type": "string", + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-uss-file" + ], + "group": "input sources options" + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "Allows you to associate a 50-character description when creating or updating package.", + "type": "string", + "stringLengthRange": [ + 1, + 50 + ], + "group": "options" + }, + { + "name": "from-date-time", + "aliases": [ + "fdt" + ], + "description": "Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "to-date-time", + "aliases": [ + "tdt" + ], + "description": "Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.", + "type": "string", + "group": "options" + }, + { + "name": "backout", + "description": "Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.", + "type": "boolean", + "group": "options", + "defaultValue": true, + "aliases": [] + }, + { + "name": "notes", + "aliases": [ + "n" + ], + "description": "Notes for package.", + "type": "string", + "stringLengthRange": [ + 1, + 60 + ], + "conflictsWith": [ + "notes-from-file" + ], + "group": "options" + }, + { + "name": "notes-from-file", + "aliases": [ + "nff" + ], + "description": "Local file of notes for package.", + "type": "string", + "conflictsWith": [ + "notes" + ], + "group": "options" + }, + { + "name": "emergency-package", + "aliases": [ + "ep" + ], + "description": "Specify if the package should be an emergency package. When not specified, the package is a standard package.", + "type": "boolean", + "group": "options" + }, + { + "name": "sharable", + "aliases": [ + "sh" + ], + "description": "Specify this option if the package can be edited by more than one person when in In-edit status.", + "type": "boolean", + "group": "options" + }, + { + "name": "promotion", + "aliases": [ + "pr" + ], + "description": "Specify this option to define the package as a promotion package.", + "type": "boolean", + "group": "options" + }, + { + "name": "validate-scl", + "aliases": [ + "vs" + ], + "description": "Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated", + "type": "boolean", + "group": "options", + "defaultValue": true + }, + { + "name": "append", + "aliases": [ + "a" + ], + "description": "Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.", + "type": "boolean", + "group": "options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'updating element'", + "description": "Update element from local file with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage. ", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "from-file", + "aliases": [ + "ff" + ], + "description": "Use this input to provide source file.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-package", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-dataset", + "aliases": [ + "fd" + ], + "description": "Use this input to provide source data set name.", + "type": "string", + "stringLengthRange": [ + 1, + 44 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-member", + "aliases": [ + "fm" + ], + "description": "Use this input to provide source member name in the data set.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-path", + "from-uss-file", + "from-text" + ], + "group": "input sources options" + }, + { + "name": "from-path", + "aliases": [ + "fp" + ], + "description": "Use this input to provide the path of source USS file. It must be used with from-uss-file.", + "type": "string", + "stringLengthRange": [ + 1, + 768 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-text" + ], + "implies": [ + "from-uss-file" + ], + "group": "input sources options" + }, + { + "name": "from-uss-file", + "aliases": [ + "fuf" + ], + "description": "Use this input to provide source USS file name. It must be used with from-path", + "type": "string", + "stringLengthRange": [ + 1, + 255 + ], + "conflictsWith": [ + "from-package", + "from-file", + "from-dataset", + "from-member", + "from-text" + ], + "implies": [ + "from-path" + ], + "group": "input sources options" + }, + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "override-signout", + "aliases": [ + "os" + ], + "description": "Specify if you want to override the Signout of an Endevor element while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "proc-group", + "aliases": [ + "pg" + ], + "description": "The Endevor processor group you would like to use.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "required": false, + "group": "options" + }, + { + "name": "generate", + "aliases": [ + "g" + ], + "description": "Specifies if you want to Generate Element after Add/Update action.", + "type": "boolean", + "required": false, + "group": "options" + }, + { + "name": "get-fingerprint", + "aliases": [ + "gfg" + ], + "description": "Return fingerprint of a retrieved, added or updated element as the first line of the response.", + "type": "boolean", + "defaultValue": false, + "group": "options" + }, + { + "name": "fingerprint", + "aliases": [ + "fg" + ], + "description": "Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.", + "type": "string", + "conflictsWith": [ + "from-dataset", + "from-member", + "from-path", + "from-uss-file" + ], + "required": false, + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "sync", + "aliases": [ + "s" + ], + "description": "Specify if you want to synchronize source and current level of the Elements while performing this action.", + "type": "boolean", + "group": "options" + }, + { + "name": "sync-with-history", + "aliases": [ + "swh" + ], + "description": "Specify if you want to preserve the change history of the Elements while performing the synchronization during element update.", + "type": "boolean", + "implies": [ + "sync" + ], + "group": "options" + }, + { + "name": "sync-fingerprint", + "aliases": [ + "sfg" + ], + "description": "Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint.", + "type": "string", + "implies": [ + "sync" + ], + "group": "options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "view", + "type": "group", + "description": "View an Element or a Package SCL in Endevor.", + "children": [ + { + "examples": [ + { + "options": "elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --tf localfile.txt -i ENDEVOR", + "description": "View element from specified inventory location to local file with endevor profile set up" + } + ], + "name": "element", + "aliases": [ + "elem", + "ele" + ], + "type": "command", + "handler": "", + "description": "The view element command views an existing element in Endevor.", + "positionals": [ + { + "name": "element", + "type": "string", + "description": "Name of the Endevor element.", + "required": true, + "stringLengthRange": [ + 1, + 255 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "environment", + "aliases": [ + "env" + ], + "description": "The Endevor environment where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "system", + "aliases": [ + "sys" + ], + "description": "The Endevor system where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "subsystem", + "aliases": [ + "sub" + ], + "description": "The Endevor subsystem where your project resides.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "type", + "aliases": [ + "typ" + ], + "description": "Name of the Endevor element's type.", + "type": "string", + "stringLengthRange": [ + 1, + 8 + ], + "group": "endevor-location definition options" + }, + { + "name": "stage-number", + "aliases": [ + "sn" + ], + "description": "The Endevor stage number where your project resides.", + "type": "string", + "allowableValues": { + "values": [ + "1", + "2" + ] + }, + "group": "endevor-location definition options" + }, + { + "name": "ccid", + "aliases": [ + "cci" + ], + "description": "The CCID you want to use when performing an Element action.", + "type": "string", + "stringLengthRange": [ + 1, + 12 + ], + "group": "endevor-location definition options" + }, + { + "name": "comment", + "aliases": [ + "com" + ], + "description": "The comment you want to have when performing an Element action", + "type": "string", + "stringLengthRange": [ + 1, + 40 + ], + "group": "endevor-location definition options" + }, + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "element-version", + "aliases": [ + "ev" + ], + "description": "Indicates the version number of the element (use along with the level option).", + "type": "number", + "numericValueRange": [ + 1, + 99 + ], + "implies": [ + "level" + ], + "group": "options" + }, + { + "name": "level", + "aliases": [ + "lev" + ], + "description": "Indicates the level number of the element (use along with the version option).", + "type": "number", + "numericValueRange": [ + 0, + 99 + ], + "implies": [ + "element-version" + ], + "group": "options" + }, + { + "name": "search", + "aliases": [ + "sea" + ], + "description": "Enables the search through the Endevor map.", + "type": "boolean", + "group": "options" + }, + { + "name": "where-ccid-all", + "aliases": [ + "wca" + ], + "description": "Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-current", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-current", + "aliases": [ + "wcc" + ], + "description": "Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs. \nAccept up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-retrieve" + ], + "group": "options" + }, + { + "name": "where-ccid-retrieve", + "aliases": [ + "wcr" + ], + "description": "Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. \nAccepts up to 8 CCIDs separated by \", \". Enclose CCIDs that contain special characters in quotes.", + "type": "string", + "conflictsWith": [ + "where-ccid-all", + "where-ccid-current" + ], + "group": "options" + }, + { + "name": "where-proc-group", + "aliases": [ + "wpg" + ], + "description": "Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name. \nAccepts up to 8 Processor group names separated by \", \". ", + "type": "string", + "group": "options" + }, + { + "name": "charset", + "aliases": [ + "char" + ], + "description": "Specifies the clients preferred character set when retrieving, printing or updating elements.", + "type": "string", + "defaultValue": false, + "group": "options" + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "examples": [ + { + "options": "packageName -i ENDEVOR", + "description": "View SCL of package \"packageName\" in the console with endevor profile set up" + } + ], + "name": "pkgscl", + "aliases": [ + "packagescl" + ], + "type": "command", + "handler": "", + "description": "The view pkgscl command views the SCL of an existing package in Endevor.", + "positionals": [ + { + "name": "package", + "type": "string", + "description": "Name of the Endevor package.", + "required": false, + "stringLengthRange": [ + 1, + 16 + ] + } + ], + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "maxrc", + "description": "The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails", + "type": "number", + "defaultValue": 8, + "group": "endevor-location definition options", + "aliases": [] + }, + { + "name": "to-file", + "aliases": [ + "tf" + ], + "description": "The file name in which the data from the command output is stored", + "type": "string", + "group": "output customization options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options" + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/omspool.jsonc b/commandGroups/omspool.jsonc new file mode 100644 index 0000000..711eee7 --- /dev/null +++ b/commandGroups/omspool.jsonc @@ -0,0 +1,544 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "omspool", + "description": "Interact with Output Management Spool™ for z/OS (OM Spool)", + "type": "group", + "children": [ + { + "name": "issue", + "aliases": [ + "is" + ], + "summary": "Issue OM Spool commands.", + "description": "Issue OM Spool commands.", + "type": "group", + "children": [ + { + "name": "command", + "aliases": [ + "cmd" + ], + "summary": "Issue commands to work with OM Spool.", + "description": "Issue commands to work with OM Spool.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "omspool", + "zosmf", + "base" + ] + }, + "positionals": [ + { + "name": "command-text", + "type": "string", + "description": "The OM Spool command to issue.", + "required": true + } + ], + "examples": [ + { + "description": "Issue the OM Spool command 'DS' to display the status of the ESF system", + "options": "\"DS\"" + } + ], + "options": [ + { + "description": "z/OS TSO/E accounting information.", + "type": "string", + "name": "account", + "aliases": [ + "a" + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "High level qualifier of OM Spool installation.", + "type": "string", + "name": "spoolhlq", + "aliases": [ + "hlq" + ], + "stringLengthRange": [ + 1, + 35 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "OM Spool subsystem name.", + "type": "string", + "name": "subsys", + "aliases": [ + "sub" + ], + "stringLengthRange": [ + 1, + 4 + ], + "defaultValue": "ESF", + "group": "OM SPOOL OPTIONS" + }, + { + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with OM Spool.", + "type": "string", + "name": "outds", + "aliases": [ + "out" + ], + "stringLengthRange": [ + 1, + 44 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "The data set containing ESFZOWE REXX exec.", + "type": "string", + "name": "clist", + "aliases": [ + "cl" + ], + "stringLengthRange": [ + 1, + 44 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The z/OSMF server host name.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The z/OSMF server port.", + "type": "number", + "defaultValue": 443, + "group": "Zosmf Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Mainframe (z/OSMF) user name, which can be the same as your TSO login.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Zosmf 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 z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "group": "Zosmf Connection Options" + }, + { + "name": "protocol", + "description": "The protocol used (HTTP or HTTPS)", + "type": "string", + "defaultValue": "https", + "group": "Zosmf Connection Options", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "aliases": [] + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Zosmf Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Zosmf Connection Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "omspool-profile", + "aliases": [ + "omspool-p" + ], + "group": "Profile Options", + "description": "The name of a (omspool) profile to load for this command execution.", + "type": "string" + }, + { + "name": "zosmf-profile", + "aliases": [ + "zosmf-p" + ], + "group": "Profile Options", + "description": "The name of a (zosmf) 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" + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "description": "z/OS TSO/E accounting information.", + "type": "string", + "name": "account", + "aliases": [ + "a" + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "High level qualifier of OM Spool installation.", + "type": "string", + "name": "spoolhlq", + "aliases": [ + "hlq" + ], + "stringLengthRange": [ + 1, + 35 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "OM Spool subsystem name.", + "type": "string", + "name": "subsys", + "aliases": [ + "sub" + ], + "stringLengthRange": [ + 1, + 4 + ], + "defaultValue": "ESF", + "group": "OM SPOOL OPTIONS" + }, + { + "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with OM Spool.", + "type": "string", + "name": "outds", + "aliases": [ + "out" + ], + "stringLengthRange": [ + 1, + 44 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + }, + { + "description": "The data set containing ESFZOWE REXX exec.", + "type": "string", + "name": "clist", + "aliases": [ + "cl" + ], + "stringLengthRange": [ + 1, + 44 + ], + "required": true, + "group": "OM SPOOL OPTIONS" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + }, + { + "property": "options", + "value": [ + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The z/OSMF server host name.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The z/OSMF server port.", + "type": "number", + "defaultValue": 443, + "group": "Zosmf Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Mainframe (z/OSMF) user name, which can be the same as your TSO login.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.", + "type": "string", + "required": false, + "group": "Zosmf Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Zosmf 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 z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "group": "Zosmf Connection Options" + }, + { + "name": "protocol", + "description": "The protocol used (HTTP or HTTPS)", + "type": "string", + "defaultValue": "https", + "group": "Zosmf Connection Options", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Zosmf Connection Options" + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Zosmf Connection Options" + } + ], + "merge": true, + "ignoreNodes": [ + { + "type": "group" + } + ] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + } + ], + "summary": "OM Spool™ Plug-in for Zowe™ CLI", + "aliases": [ + "esf" + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/ops.jsonc b/commandGroups/ops.jsonc new file mode 100644 index 0000000..cb67ee1 --- /dev/null +++ b/commandGroups/ops.jsonc @@ -0,0 +1,4737 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "ops", + "description": "Interact with OPS/MVS® for automation administration and resource management.", + "type": "group", + "children": [ + { + "name": "create", + "summary": "Create a generic AOF event for API rules processing.", + "description": "Create a generic AOF event for API rules processing.", + "type": "group", + "children": [ + { + "name": "event", + "aliases": [], + "summary": "Create a generic AOF event for API rules processing.", + "description": "Create a generic AOF event for API rules processing", + "examples": [ + { + "options": "\"EVENTCODE\" \"eventtext\" --subsystem \"OPSS\"", + "description": "Create a generic AOF event, \"EVENTCODE\" for API rules processing on the \"OPSS\" subsystem." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "eventCode", + "type": "string", + "description": "The event code that is passed, upper-cased, to API rules in the AOF variable API.ID. This code can be up to 10 characters long.", + "required": true + }, + { + "name": "eventText", + "type": "string", + "description": "The event text that is passed, unaltered, to API rules in the AOF variable API.TEXT. This text can be up to 255 characters long.", + "required": true + } + ], + "options": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "disable", + "summary": "Disable an AOF rule.", + "description": "Disable an Automated Operations Facility rule.", + "type": "group", + "children": [ + { + "name": "rule", + "aliases": [], + "summary": "Disable the specified rule.", + "description": "Disable the specified rule.", + "examples": [ + { + "options": "\"OPSRULES\" \"MYRULE\" --subsystem \"OPSS\"", + "description": "Disable the rule \"MYRULE\" in the ruleset \"OPSRULES\" for the \"OPSS\" subsystem." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "ruleset", + "type": "string", + "description": "The ruleset containing the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + }, + { + "name": "rule", + "type": "string", + "description": "The name of the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "enable", + "summary": "Enable an AOF rule.", + "description": "Enable an Automated Operations Facility rule.", + "type": "group", + "children": [ + { + "name": "rule", + "aliases": [], + "summary": "Enable the specified rule.", + "description": "Enable the specified rule.", + "examples": [ + { + "options": "\"OPSRULES\" \"MYRULE\" --subsystem \"OPSS\"", + "description": "Enable the rule \"MYRULE\" in the ruleset \"OPSRULES\" for the \"OPSS\" subsystem." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "ruleset", + "type": "string", + "description": "The ruleset containing the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + }, + { + "name": "rule", + "type": "string", + "description": "The name of the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "execute", + "summary": "Execute an OPS/MVS REXX program or an operator command.", + "description": "Execute an OPS/MVS REXX program or an operator command.", + "type": "group", + "children": [ + { + "name": "rexx", + "aliases": [], + "summary": "Execute the specified OPS/MVS REXX program.", + "description": "Execute the specified OPS/MVS REXX program.", + "examples": [ + { + "options": "\"OPS.REXX(PROGRAM)\" --subsystem \"OPSS\"", + "description": "Execute the REXX program \"PROGRAM\" in the dataset \"OPS.REXX\" on the \"OPSS\" subsystem." + }, + { + "options": "\"(PROGRAM)\" --subsystem \"OPSS\"", + "description": "Execute the REXX program \"PROGRAM\" in the dataset \"{USER_PREFIX}.REXX\" on the \"OPSS\" subsystem." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "program", + "type": "string", + "description": "The name of the OPS/REXX source program. When enclosed in single quotes, the program name can be either a fully qualified data set name (sequential or PDS including member) or a member of a precompiled REXX data set. When not enclosed in quotes, the program name is expanded as follows: If it is in the format MYLIB, it is expanded to {USER_PREFIX}.MYLIB.REXX, where {USER_PREFIX} represents your default TSO prefix. If it is in the format MYLIB(MEMBER), it is expanded to {USER_PREFIX}.MYLIB.REXX(MEMBER). If it is in the format (MEMBER), it is expanded to {USER_PREFIX}.REXX(MEMBER).", + "required": true + } + ], + "options": [ + { + "name": "argument", + "type": "string", + "description": "Specifies any characters to be passed to the OPS/REXX program. Leading blanks are stripped from the argument. Any embedded quotes will be passed on to the called OPS/REXX program unaltered and unfiltered. The length of the string cannot exceed 256 characters.", + "required": false, + "aliases": [ + "arg" + ], + "stringLengthRange": [ + 1, + 256 + ], + "group": "Options" + }, + { + "name": "maxQueue", + "type": "string", + "description": "The maximum number of output lines that this OPS/REXX program can have in its external data queue.", + "required": false, + "aliases": [ + "mq" + ], + "group": "Options" + }, + { + "name": "workspace", + "type": "string", + "description": "Defines the size of the OPS/REXX program workspace, in bytes. The workspace size limits the maximum number of nested calls, symbols, and values that can be used during program execution. If your program has a large memory requirement, use this size value to specify a workspace that is larger than the default of 1.5 MB.", + "required": false, + "aliases": [ + "ws" + ], + "group": "Options" + }, + { + "name": "timeout", + "type": "string", + "description": "The amount of elapsed time (in minutes) the OPS/REXX program is allowed to execute. If this parameter is not specified, the default value specified in the application.yml (configuration file for the REST API server) parameter 'opsmvs.rexxExecRunTimeout' will be used. If the value specified for this parameter is zero, then no timeout limit is imposed on the OPS/REXX program.", + "required": false, + "aliases": [ + "to" + ], + "group": "Options" + }, + { + "name": "outputLimit", + "type": "string", + "description": "The maximum number of output lines the OPS/REXX program is allowed to generate before the OPS/REXX program is canceled. If this parameter is not specified, the default value specified in the application.yml (configuration file for the REST API server) parameter 'opsmvs.rexxExecOutputLimit' will be used. If the value for this parameter is zero, then no output limit is imposed on the OPS/REXX program.", + "required": false, + "aliases": [ + "ol" + ], + "group": "Options" + }, + { + "name": "wait", + "aliases": [ + "w" + ], + "type": "number", + "description": "Wait for the specified number of seconds for the OPS/MVS REXX program to end and the output to be returned. By default the command returns immediately after initiating the program's execution.", + "required": false, + "defaultValue": 10, + "numericValueRange": [ + 1, + 3600 + ], + "group": "Options" + }, + { + "name": "debug", + "type": "string", + "hidden": true, + "description": "Optionally set the hidden REST API endpoint parameter, debug, to allow REXX program execution output to be returned.", + "allowableValues": { + "values": [ + "YES", + "NO" + ], + "caseSensitive": false + }, + "required": false, + "defaultValue": "NO", + "aliases": [ + "d" + ], + "group": "Options" + }, + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "command", + "aliases": [], + "summary": "Execute the specified operator command.", + "description": "Execute the specified operator command.", + "examples": [ + { + "options": "\"D A,L\" --subsystem \"OPSS\"", + "description": "Execute the operator command, \"D A,L\" on the \"OPSS\" subsystem." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "command", + "type": "string", + "description": "The text of the operator command to be issued. The length of this string cannot exceed 240 characters.", + "required": true + } + ], + "options": [ + { + "name": "bmpCmdOut", + "type": "string", + "description": "If the specified command is an IMS command, this parameter controls the echoing of the command output. This keyword only applies if you are using an IMS Operations Facility (IOF) Batch Message Processing (BMP) program for issuing IMS commands. Valid values are: OPSLOG, WTO, and NONE. A value of 'OPSLOG' echoes all output that is associated with the current IMS command back to OPSLOG as trace messages. This results in a small amount of additional overhead to the command, assuming that the number of lines of output is not large. No output is sent back to any z/OS console or to the subsystem interface. A value of 'WTO' echoes all output that is associated with the current IMS command as Write To Operator messages to the z/OS console. Using this option can add a significant amount of overhead to IMS command processing and has the potential of flooding the consoles with command output messages. A value of 'NONE' sends IMS commands to the BMP and returns the responses to the issuing program (if so requested). This recommended approach results in the lowest amount of overhead. The use of this parameter does not affect how the IMS command output is returned to the command issuer. The default value for this parameter is 'NONE'.", + "required": false, + "aliases": [ + "bco" + ], + "group": "Options" + }, + { + "name": "capture", + "type": "string", + "description": "This parameter captures command responses that are not internally routed back to the OPS/MVS console that issued the command. If this parameter is specified, command response messages are captured based on text segments matching the first characters (starting with column 1) of the messages. These captured response messages are in addition to the usual command response messages that are captured based on other specified parameters. You can specify up to 10 message text segments with this parameter, and each text segment can have up to 124 characters.", + "required": false, + "aliases": [ + "cp" + ], + "group": "Options" + }, + { + "name": "cart", + "type": "string", + "description": "This parameter specifies a z/OS command and response token (CART). This token can be represented as either a one- to eight-character string such as MYCMDTOK, or as a one- to eight-byte hexadecimal value such as X'D6D7E2E205162738'. Messages issued in response to this command are issued using the same CART. If this parameter is not specified, OPS/MVS will generate a unique CART token and use this generated token to determine which response messages should be returned to the caller.", + "required": false, + "aliases": [ + "ct" + ], + "group": "Options" + }, + { + "name": "cmdEcho", + "type": "string", + "description": "This parameter determines whether the issued command is echoed as the first line of the command response. You can specify either YES, which is the default, or NO. This parameter is ignored when the cmdLog parameter is set to NO.", + "required": false, + "aliases": [ + "ce" + ], + "group": "Options" + }, + { + "name": "cmdLog", + "type": "string", + "description": "This parameter determines whether the issued command is echoed in both SYSLOG and the command response, or neither. You can specify either YES, which is the default, or NO. The NO setting overrides the setting of the cmdEcho parameter.", + "required": false, + "aliases": [ + "cl" + ], + "group": "Options" + }, + { + "name": "cmdWait", + "type": "string", + "description": "This parameter specifies, in seconds, how long to wait for command output collection to complete. The number of lines that are collected are analyzed every few hundredths of a second, based on the value specified with the interval parameter. If no new output lines are forthcoming after at least two output lines have been received, the wait for more response characters is terminated before this cmdWait period expires. You can specify a value for this parameter from 1 through 600 seconds. If you specify a value of YES for the stopEnd parameter, the end line of a multi-line WTO message also stops response collection. The main difference between the cmdWait and wait parameters is that the wait parameter specifies an unconditional wait period, while the cmdWait parameter specifies a conditional wait based on a continuous, timely collection of response lines. The default value for this parameter is the value of the OCWAIT global OPS/MVS parameter. When used in IMS Type 2 message syntax, the cmdWait and wait parameters are identical and specify the maximum wait time in seconds for message completion. IBM documentation on IMSPLEX usage implies that the delay in gathering results from multiple IMS systems can be considerable and should be considered normal. The default if omitted is 120, or 2 minutes. This cmdWait parameter is mutually exclusive with the wait parameter.", + "required": false, + "aliases": [ + "cw" + ], + "group": "Options" + }, + { + "name": "conName", + "type": "string", + "description": "This parameter defines the name of the console to receive the issued command. The console name that you provide can contain as many as eight characters. You can retrieve command output when the specified console is allocated to OPS/MVS. If the console is not allocated or does not exist, this request will return an error code of 190. This conName parameter is mutually exclusive with the conType parameter.", + "required": false, + "aliases": [ + "cn" + ], + "group": "Options" + }, + { + "name": "conType", + "type": "string", + "description": "This parameter specifies the appropriate type of console that should be used for the command that you are issuing. The default value for this parameter is the current value of the OCCONTYPE global OPS/MVS parameter. Valid values are: ANY, EXTCONS, SSCONS, or XTRACONS. A value of 'ANY' tells OPS/MVS to select the first available console to issue the command. In this case, OPS/MVS selects consoles in the following order: Subsystem consoles, followed by XTRACONS consoles, and finally Extended consoles. A value of 'EXTCONS' tells OPS/MVS to select the first available extended console. Extended consoles are controlled by the EXTENDEDCONSOLES global OPS/MVS parameter. A value of 'SSCONS' tells OPS/MVS to select the first available subsystem console. Subsystem consoles are controlled by the SUBSYSDEFAULT global OPS/MVS parameter. A value of 'XTRACONS' tells OPS/MVS to select the first available extra extended console. Extra extended consoles are controlled by the EXTRAEXTCONSOLES global OPS/MVS parameter. This conType parameter is mutually exclusive with the conName parameter.", + "required": false, + "aliases": [ + "cnt" + ], + "group": "Options" + }, + { + "name": "imsId", + "type": "string", + "description": "If you use the IMS Operations Facility (IOF) at your site, you can use the /opscmd endpoint to issue IMS commands. If you are running only one copy of IMS on the system where the current instance of the OPS/MVS REST API is running, you can omit the imsId parameter. However, if several copies of IMS (such as a production version and a test version) reside on the system, use this parameter to specify the IMS control region that should receive the command. IMS IDs can contain from one to four characters. IBM ships IMS with a default IMS ID of IMSA. If you do not know the IMS ID of the IMS you want OPS/MVS to control, ask your systems management department. When used in IMS Type 2 message syntax, the command is issued to the IMSPLEX manager, and distributed from there. The imsId parameter is used to establish the eligibility of participating IMS systems to receive the command. If the imsId parameter is omitted, the first IMS system capable of responding receives the command. If the value of the imsId parameter is specified as a wildcard *, all participating IMS systems receive the command. The value of the imsId parameter can also be specified as a list, separated by spaces or commas, of specific IMS system names to receive the command. The wildcard * should not be used with the imsId parameter unless the imsPlex parameter is specified with an explicit name.", + "required": false, + "aliases": [ + "id" + ], + "group": "Options" + }, + { + "name": "imsPlex", + "type": "string", + "description": "If you use the IMS Operations Facility (IOF) at your site, you can use the /opscmd endpoint to issue IMS commands. If you are running only one copy of IMS on the system where the current instance of the OPS/MVS REST API is running, you can omit the imsId parameter. However, if several copies of IMS (such as a production version and a test version) reside on the system, use this parameter to specify the IMS control region that should receive the command. IMS IDs can contain from one to four characters. IBM ships IMS with a default IMS ID of IMSA. If you do not know the IMS ID of the IMS you want OPS/MVS to control, ask your systems management department. When used in IMS Type 2 message syntax, the command is issued to the IMSPLEX manager, and distributed from there. The imsId parameter is used to establish the eligibility of participating IMS systems to receive the command. If the imsId parameter is omitted, the first IMS system capable of responding receives the command. If the value of the imsId parameter is specified as a wildcard *, all participating IMS systems receive the command. The value of the imsId parameter can also be specified as a list, separated by spaces or commas, of specific IMS system names to receive the command. The wildcard * should not be used with the imsId parameter unless the imsPlex parameter is specified with an explicit name.", + "required": false, + "aliases": [ + "ip" + ], + "group": "Options" + }, + { + "name": "imsReply", + "type": "string", + "description": "The presence of this imsPlex parameter implies you are issuing an IMS command using the IMS Type 2 message syntax. This value can be specified as a specific IMSPLEX name, in which case the imsId parameter controls the selection of participating IMS systems. The imsPlex parameter can also be specified as a wildcard *, meaning the imsId determines the IMSPLEX name. In this case, the imsId parameter cannot be specified as a wildcard *, but must contain a valid IMS system name. The imsId parameter, or the first of a list, will be used to locate the name of its associated IMSPLEX.", + "required": false, + "aliases": [ + "ir" + ], + "group": "Options" + }, + { + "name": "interval", + "type": "string", + "description": "This parameter specifies, in centiseconds, how frequently to test for command response lines to see if the response has ended. This interval parameter temporarily overrides the value of the OCINTERVAL global OPS/MVS parameter. The default for this interval parameter is the value of the OCINTERVAL global OPS/MVS parameter, but you can specify any number from 10 through 300, or a value of 0 to bypass interval testing.", + "required": false, + "aliases": [ + "int" + ], + "group": "Options" + }, + { + "name": "localOnly", + "type": "string", + "description": "When 'YES' is specified for this parameter, only messages from the local system are considered as potential command response candidates. This parameter should be used in conjunction with the capture and stopMsg parameters to prevent output from other systems possibly being returned as command output. You can specify either NO, which is the default, or YES.", + "required": false, + "aliases": [ + "loc" + ], + "group": "Options" + }, + { + "name": "log", + "type": "string", + "description": "This parameter determines whether response lines from the issued command go into the SYSLOG and/or OPSLOG data sets. Valid options are: YES, NO, OFF, and NOWHERE. A value of 'YES' means command responses and command echo will be logged in both SYSLOG and OPSLOG. A value of 'NO' means SYSLOG will only contain the command echo, not the command responses, and OPSLOG will contain both the command echo and the command responses. A value of 'OFF' means the command echo and command responses will not be logged to SYSLOG. OPSLOG will contain the command responses, but not the command echo. A value of 'NOWHERE' means the command echo and command responses will not be logged to either the SYSLOG or the OPSLOG. Note that the logging of command response lines is also influenced by MIC and AOF rule processing. The default value for this parameter is 'YES'.", + "required": false, + "aliases": [ + "lg" + ], + "group": "Options" + }, + { + "name": "maxCmdOut", + "type": "string", + "description": "This parameter defines how many command output lines to collect before terminating the command response. If the command output contains more lines than this maxCmdOut value, no more command output lines are collected. You can specify any value from 1 through 32767 for this parameter. The default value for this parameter is the value of the OCMAXMSG global OPS/MVS parameter.", + "required": false, + "aliases": [ + "mco" + ], + "group": "Options" + }, + { + "name": "output", + "type": "string", + "description": "This parameter determines whether you receive output from the issued command. You can specify either YES, which is the default, or NO. The NO setting is mutually exclusive with the wait parameter.", + "required": false, + "aliases": [ + "out" + ], + "group": "Options" + }, + { + "name": "stopEnd", + "type": "string", + "description": "This parameter determines whether the end line of a multiline WTO message stops the collection of command output. Valid options are: YES, and NO. A value of 'YES' will cause the command response to terminate at the first end line of a multiline WTO message or at the time that is specified through the cmdWait parameter or the OCWAIT global OPS/MVS parameter. A value of 'NO' will cause the command output to continue collecting until either: the time interval that is specified by the cmdWait parameter or the OCWAIT global parameter expires; or no new command output lines are collected in the time interval that is specified by the interval parameter. The default value for this parameter is 'YES'.", + "required": false, + "aliases": [ + "se" + ], + "group": "Options" + }, + { + "name": "stopMsg", + "type": "string", + "description": "This parameter specifies a list of one to ten message text segments matching the first characters (starting with column 1) of the messages that terminate the collection of command response lines. When any of these text segments are detected, the collection of response lines stops. The message segment or segments you specify need not be directed to the console receiving the command response. Each item in the list of message text segments you specify can contain no more than 124 characters. All message text segments that are specified on this parameter will match both uppercase and lowercase text in potential matching messages (case-insensitive). This parameter does not work with IMS Type 2 commands. The stopMsg and stopResp parameters are mutually exclusive.", + "required": false, + "aliases": [ + "sm" + ], + "group": "Options" + }, + { + "name": "stopResp", + "type": "string", + "description": "This parameter specifies a list of one to ten message text segments matching the first characters (starting with column 1) of the messages that terminate the collection of command response lines. The message segments that you specify must be directed to the console receiving the command response, and each item in the segment list can contain no more than 124 characters. You can use this stopResp parameter to terminate the collection of a long command response once the desired response line is found. All message text segments that are specified on this keyword will match both uppercase and lowercase text in potential matching messages (case-insensitive). The stopResp and stopMsg parameters are mutually exclusive.", + "required": false, + "aliases": [ + "sr" + ], + "group": "Options" + }, + { + "name": "wait", + "aliases": [ + "w" + ], + "type": "number", + "description": "This parameter specifies a period of time (in seconds) to unconditionally wait to receive output from the issued command. Control is not returned to the caller until the full wait period elapses. In most cases, a conditional wait using the cmdWait parameter in conjunction with the interval and various stopXxxx parameters can be used to effectively collect command responses, thus eliminating the need for an unconditional wait. When used in IMS Type 2 message syntax, the wait parameter is identical to the cmdWait parameter. This wait parameter is mutually exclusive with the cmdWait parameter. If the output parameter is set to NO, you can not use this parameter (mutually exclusive).", + "required": false, + "numericValueRange": [ + 1, + 3600 + ], + "group": "Options" + }, + { + "name": "debug", + "type": "string", + "hidden": true, + "description": "Optionally set the hidden REST API endpoint parameter, debug, to allow REXX program execution output to be returned.", + "allowableValues": { + "values": [ + "YES", + "NO" + ], + "caseSensitive": false + }, + "required": false, + "defaultValue": "NO", + "aliases": [ + "d" + ], + "group": "Options" + }, + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "show", + "summary": "Display data associated with OPS/MVS automation elements, such as AOF rules and rulesets, and SSM resources, OPS log names, subsystems and RDF tables, or REST API server status.", + "description": "Display data associated with OPS/MVS automation elements, such as AOF rules and rulesets, and SSM resources, OPS log names, subsystems and RDF tables, or REST API server status.", + "type": "group", + "children": [ + { + "name": "logname", + "aliases": [], + "summary": "Display data associated with logs.", + "description": "Display a list of the OPSLOG lognames that are defined to the specified subsystem. The list also identifies the live OPSLOG. This command is only available when connected to the OPS/MVS REST API server.", + "examples": [ + { + "options": "--subsystem \"OPSS\"", + "description": "Show the data for the logs defined for the \"OPSS\" subsystem" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [], + "options": [ + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "resource", + "aliases": [], + "summary": "Display data associated with the specified SSM resource.", + "description": "Display data associated with the specified SSM resource. Currently, only the current and desired states of the resource are displayed.", + "examples": [ + { + "options": "\"RESOURCE1\" --table \"MYTABLE\" --subsystem \"OPSS\"", + "description": "Show the current and desired state of the resource \"RESOURCE1\" in the table \"MYTABLE\" for the \"OPSS\" subsystem" + }, + { + "options": "* --table \"MYTABLE\" --subsystem \"OPSS\"", + "description": "Show the current and desired state of all resources in the table \"MYTABLE\" for the \"OPSS\" subsystem. This command is only available when connected to the OPS/MVS REST API server" + }, + { + "options": "* --subsystem \"OPSS\"", + "description": "Show the current and desired state of all resources in all tables for the \"OPSS\" subsystem. This command is only available when connected to the OPS/MVS REST API server" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "resourcename", + "type": "string", + "description": "The name of the resource.", + "required": true, + "stringLengthRange": [ + 1, + 18 + ] + } + ], + "options": [ + { + "name": "tablename", + "type": "string", + "description": "The name of the table that contains the resource. If not specified, the command searches all SSM tables and displays each instance of the resource that is found.", + "required": false, + "aliases": [ + "table" + ], + "stringLengthRange": [ + 1, + 18 + ], + "group": "Options" + }, + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "rule", + "aliases": [], + "summary": "Display data associated with the specified rule.", + "description": "Display data associated with the specified rule.", + "examples": [ + { + "options": "\"OPSRULES\" \"MYRULE\" --subsystem \"OPSS\" -f csv", + "description": "Show the data in csv format of the rule \"MYRULE\" in the ruleset \"OPSRULES\" for the \"OPSS\" subsystem" + }, + { + "options": "\"OPSRULES\" \"*\" --subsystem \"OPSS\"", + "description": "Show the data of all rules in ruleset \"OPSRULES\" for the \"OPSS\" subsystem. This command is only available when connected to the OPS/MVS REST API server" + }, + { + "options": "\"*\" \"*\" --subsystem \"OPSS\"", + "description": "Show the data of all rules in all rulesets for the \"OPSS\" subsystem. This command is only available when connected to the OPS/MVS REST API server" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "ruleset", + "type": "string", + "description": "The ruleset containing the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + }, + { + "name": "rule", + "type": "string", + "description": "The name of the rule.", + "required": true, + "stringLengthRange": [ + 1, + 8 + ] + } + ], + "options": [ + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "ruleset", + "aliases": [], + "summary": "Display data associated with one or all rulesets.", + "description": "Display data associated with one or all rulesets for a specified subsystem. This command is only available when connected to the OPS/MVS REST API server.", + "examples": [ + { + "options": "--subsystem \"OPSS\"", + "description": "Show the data for the rulesets defined for the \"OPSS\" subsystem" + }, + { + "options": "--ruleset \"CICS\"", + "description": "Show the data for ruleset \"CICS\" for the default OPS/MVS subsystem" + }, + { + "options": "--ruleset \"IMS\" --subsystem \"OPSS\"", + "description": "Show the data for ruleset IMS for the \"OPSS\" subsystem" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [], + "options": [ + { + "name": "ruleset", + "type": "string", + "description": "The ruleset to display.", + "required": false, + "stringLengthRange": [ + 1, + 8 + ], + "group": "Options", + "aliases": [] + }, + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "status", + "aliases": [], + "summary": "Display data associated with an OPS/MVS REST API server.", + "description": "Display data associated with an OPS/MVS REST API server. This command is only available when connected to the OPS/MVS REST API server.", + "examples": [ + { + "options": "--format \"csv\"", + "description": "Show the data for REST API in \"CSV\" format" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [], + "options": [ + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "subsystem", + "aliases": [], + "summary": "Display a list of the OPS/MVS subsystems.", + "description": "Display a list of the OPS/MVS subsystems that are running on the host z/OS LPAR. This command is only available when connected to the OPS/MVS REST API server.", + "examples": [ + { + "options": "", + "description": "Show the data for the OPS/MVS subsystems that are running on the host system" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [], + "options": [ + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "table", + "aliases": [], + "summary": "Display data associated with tables.", + "description": "Display a list of the RDF tables that are defined to the specified subsystem. This command is only available when connected to the OPS/MVS REST API server.", + "examples": [ + { + "options": "--subsystem \"OPSS\"", + "description": "Show the tables defined for the \"OPSS\" subsystem" + }, + { + "options": "--subsystem \"OPSS\" --table \"SSM*\"", + "description": "Show the tables starting with 'SSM' defined for the \"OPSS\" subsystem" + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [], + "options": [ + { + "name": "tablename", + "type": "string", + "description": "The optional filter used to describe which table names will be returned. You can specify either an absolute table name or a table name containing one or more wildcard characters (* or ?). The * wildcard will match zero or more characters, and the ? wildcard will match any single character. If no value is specified, the value * will be used.", + "required": false, + "aliases": [ + "table" + ], + "stringLengthRange": [ + 1, + 18 + ], + "group": "Options" + }, + { + "name": "format", + "aliases": [ + "f" + ], + "type": "string", + "description": "Format of the displayed output.", + "defaultValue": "namevalue", + "allowableValues": { + "values": [ + "namevalue", + "namevaluecolor", + "csv", + "json" + ], + "caseSensitive": false + }, + "required": false, + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "start", + "summary": "Start an SSM resource.", + "description": "Start a System State Manager resource.", + "type": "group", + "children": [ + { + "name": "resource", + "aliases": [], + "summary": "Start the specified resource.", + "description": "Start the specified resource. The desired state of the resource is set to the appropriate UP state and SSM takes action to start the resource.", + "examples": [ + { + "options": "\"RESOURCE1\" \"MYTABLE\" --subsystem \"OPSS\"", + "description": "Start the resource RESOURCE1 in the table \"MYTABLE\" for subsystem \"OPSS\"." + }, + { + "options": "\"RESOURCE1\" \"MYTABLE\" --subsystem \"OPSS\" -w 120", + "description": "Start the resource \"RESOURCE1\" in the table \"MYTABLE\" for the \"OPSS\" subsystem, and wait for up to 2 minutes for \"RESOURCE1\" to have a current state of UP." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "resourcename", + "type": "string", + "description": "The name of the resource.", + "required": true, + "stringLengthRange": [ + 1, + 18 + ] + }, + { + "name": "tablename", + "type": "string", + "description": "The name of the table that contains the resource.", + "required": true, + "aliases": [ + "table" + ], + "stringLengthRange": [ + 1, + 18 + ] + } + ], + "options": [ + { + "name": "wait", + "aliases": [ + "w" + ], + "type": "number", + "description": "Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired states still do not match, the command fails with a timeout error.", + "required": false, + "numericValueRange": [ + 1, + 86400 + ], + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "name": "stop", + "summary": "Stop an SSM resource.", + "description": "Stop a System State Manager resource.", + "type": "group", + "children": [ + { + "name": "resource", + "aliases": [], + "summary": "Stop the specified resource.", + "description": "Stop the specified resource. The desired state of the resource is set to the appropriate DOWN state and SSM takes action to stop the resource.", + "examples": [ + { + "options": "\"RESOURCE1\" \"MYTABLE\" --subsystem \"OPSS\"", + "description": "Stop the resource \"RESOURCE1\" in the table \"MYTABLE\" for the \"OPSS\" subsystem." + }, + { + "options": "\"RESOURCE1\" \"MYTABLE\" --subsystem \"OPSS\" -w 120", + "description": "Stop the \"RESOURCE1\" in the table \"MYTABLE\" for the \"OPSS\" subsystem, and wait for up to 2 minutes for \"RESOURCE1\" to have a current state of DOWN." + } + ], + "type": "command", + "handler": "", + "profile": { + "optional": [ + "ops", + "base" + ] + }, + "positionals": [ + { + "name": "resourcename", + "type": "string", + "description": "The name of the resource.", + "required": true, + "stringLengthRange": [ + 1, + 18 + ] + }, + { + "name": "tablename", + "type": "string", + "description": "The name of the table that contains the resource.", + "required": true, + "aliases": [ + "table" + ], + "stringLengthRange": [ + 1, + 18 + ] + } + ], + "options": [ + { + "name": "wait", + "aliases": [ + "w" + ], + "type": "number", + "description": "Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired states still do not match, the command fails with a timeout error.", + "required": false, + "numericValueRange": [ + 1, + 86400 + ], + "group": "Options" + }, + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options", + "aliases": [] + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ops-profile", + "aliases": [ + "ops-p" + ], + "group": "Profile Options", + "description": "The name of a (ops) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": [] + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "ignoreNodes": [ + { + "type": "group" + } + ], + "property": "options", + "value": [ + { + "description": "Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "user", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "password", + "aliases": [ + "pass" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The hostname of the server where OPS/MVS Web Services / REST API is running.", + "type": "string", + "name": "host", + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The port number for OPS/MVS Web Services / REST API.", + "type": "number", + "name": "port", + "aliases": [ + "p" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "defaultValue": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "The protocol that is used for connecting to OPS/MVS Web Services / REST API.", + "type": "string", + "name": "protocol", + "aliases": [ + "prot" + ], + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "required": true, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.", + "type": "string", + "name": "subsystem", + "aliases": [ + "subs" + ], + "defaultValue": "OPSS", + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.", + "type": "boolean", + "name": "rest-api", + "aliases": [ + "ra" + ], + "defaultValue": false, + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + }, + { + "description": "NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "required": false, + "group": "OPS/MVS Web Services / REST API connection options" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + } + ], + "summary": "Zowe CLI Plug-in for OPS/MVS®", + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/sysview.jsonc b/commandGroups/sysview.jsonc new file mode 100644 index 0000000..ed28328 --- /dev/null +++ b/commandGroups/sysview.jsonc @@ -0,0 +1,1341 @@ +// Copyright (c) 2024 Broadcom. All Rights Reserved. The term +// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. +{ + "name": "sysview", + "description": "Zowe CLI plugin for SYSVIEW", + "type": "group", + "children": [ + { + "name": "capture", + "aliases": [ + "cap" + ], + "summary": "Display a captured SYSVIEW primary command", + "description": "Display output from a primary command stored in a SYSVIEW capture data set", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "sysview", + "sysview-format", + "base" + ] + }, + "positionals": [ + { + "name": "capture-dsn", + "description": "Capture data set name from which to retrieve captured commands", + "type": "string", + "required": true + }, + { + "name": "capture-command", + "description": "Captured command to retrieve", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "capture-row", + "aliases": [ + "cr" + ], + "description": "Row number of command within capture data set", + "type": "number", + "group": "data options" + }, + { + "name": "capture-screen", + "aliases": [ + "cs" + ], + "description": "Screen name, for commands which have multiple screens", + "type": "string", + "group": "data options" + }, + { + "name": "capture-title", + "aliases": [ + "ct" + ], + "description": "The captured command screen title or a user supplied title specified on the CAPIMMED command", + "type": "string", + "group": "data options" + }, + { + "name": "fields", + "aliases": [ + "f" + ], + "description": "Fields to be returned (by name). For example: \"jobname\" \"cpu\"", + "type": "array", + "group": "data options" + }, + { + "name": "all-rows", + "aliases": [ + "ar" + ], + "description": "Return all rows of data, no matter how many. Overrides --row-start and --row-end", + "type": "boolean", + "group": "data options" + }, + { + "name": "row-start", + "aliases": [ + "rs" + ], + "description": "The first row of the response data to display", + "type": "number", + "defaultValue": 1, + "group": "data options" + }, + { + "name": "row-end", + "aliases": [ + "re" + ], + "description": "The last row of the response data to display", + "type": "number", + "defaultValue": 100, + "group": "data options" + }, + { + "name": "context-fields", + "aliases": [ + "cf" + ], + "description": "Context fields to display. Defaults to hiding all context", + "type": "array", + "group": "display options" + }, + { + "name": "overview", + "aliases": [ + "o" + ], + "description": "Display the overview section", + "type": "boolean", + "group": "display options" + }, + { + "name": "info", + "aliases": [ + "i" + ], + "description": "Display the information area, if any", + "type": "boolean", + "group": "display options" + }, + { + "name": "pretty", + "aliases": [ + "p" + ], + "description": "Display formatted data", + "type": "boolean", + "group": "display options" + }, + { + "name": "blank-if-zero", + "aliases": [ + "biz", + "b" + ], + "description": "Show a blank space instead of '0' values", + "type": "boolean", + "group": "display options" + }, + { + "name": "truncate", + "aliases": [ + "tr" + ], + "description": "Truncate displays that are too wide for the console", + "type": "boolean", + "defaultValue": false, + "group": "display options" + }, + { + "name": "timeout", + "aliases": [ + "to" + ], + "description": "The number of seconds to wait before timing out", + "type": "number", + "defaultValue": 30, + "numericValueRange": [ + 1, + 60 + ], + "group": "data options" + }, + { + "name": "response-format-csv", + "aliases": [ + "csv" + ], + "description": "Format data as a set of Comma Seperated Values", + "type": "boolean", + "group": "response format options" + }, + { + "description": "The hostname of the SYSVIEW REST API", + "type": "string", + "name": "host", + "aliases": [ + "H" + ], + "group": "sysview connection options" + }, + { + "description": "The port number of the SYSVIEW REST API", + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "user", + "aliases": [ + "u" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "group": "sysview connection options" + }, + { + "description": "If set, the server certificate is verified against the list of supplied CAs", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "group": "sysview connection options" + }, + { + "description": "SSID of the SYSVIEW instance. Default value: GSVX", + "type": "string", + "name": "ssid", + "defaultValue": "GSVX", + "group": "sysview connection options", + "aliases": [] + }, + { + "description": "The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "defaultValue": "/api/v1", + "group": "sysview connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "sysview-profile", + "aliases": [ + "sysview-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview) profile to load for this command execution.", + "type": "string" + }, + { + "name": "sysview-format-profile", + "aliases": [ + "sysview-format-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview-format) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "\"MY.CAPTURE.DATASET\" ACTIVITY", + "description": "Display the captured ACTIVITY command from MY.CAPTURE.DATASET." + }, + { + "options": "\"MY.CAPTURE.DATASET\" ACTIVITY --capture-row 3 --fields Jobname Jobid Status", + "description": "Display the Jobname, Jobid, and Status columns of the captured ACTIVITY command on row 3 from MY.CAPTURE.DATASET." + } + ], + "passOn": [], + "children": [] + }, + { + "name": "capture-immediate", + "aliases": [ + "cap-imm" + ], + "summary": "Submit a capture request1", + "description": "Submit a capture request2", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "sysview", + "base" + ] + }, + "positionals": [ + { + "name": "capture-file", + "description": "The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "context-fields", + "aliases": [ + "cf" + ], + "description": "Context fields to display. Defaults to hiding all context", + "type": "array", + "group": "display options" + }, + { + "name": "capture-description", + "aliases": [ + "cd" + ], + "description": "The description of the capture", + "type": "string", + "group": "data options" + }, + { + "description": "The hostname of the SYSVIEW REST API", + "type": "string", + "name": "host", + "aliases": [ + "H" + ], + "group": "sysview connection options" + }, + { + "description": "The port number of the SYSVIEW REST API", + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "user", + "aliases": [ + "u" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "group": "sysview connection options" + }, + { + "description": "If set, the server certificate is verified against the list of supplied CAs", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "group": "sysview connection options" + }, + { + "description": "SSID of the SYSVIEW instance. Default value: GSVX", + "type": "string", + "name": "ssid", + "defaultValue": "GSVX", + "group": "sysview connection options", + "aliases": [] + }, + { + "description": "The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "defaultValue": "/api/v1", + "group": "sysview connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "sysview-profile", + "aliases": [ + "sysview-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "\"./my-capture.txt\" --description \"Top CPU Users\"", + "description": "Issues a Capture containing the commands in capture file 'my-capture.txt' with the description 'Top CPU Users'" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "check", + "type": "group", + "description": "Confirm that the SYSVIEW REST server is running on a specified system.", + "children": [ + { + "name": "status", + "description": "Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "sysview", + "base" + ] + }, + "options": [ + { + "description": "The hostname of the SYSVIEW REST API", + "type": "string", + "name": "host", + "aliases": [ + "H" + ], + "group": "sysview connection options" + }, + { + "description": "The port number of the SYSVIEW REST API", + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "user", + "aliases": [ + "u" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "group": "sysview connection options" + }, + { + "description": "If set, the server certificate is verified against the list of supplied CAs", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "group": "sysview connection options" + }, + { + "description": "SSID of the SYSVIEW instance. Default value: GSVX", + "type": "string", + "name": "ssid", + "defaultValue": "GSVX", + "group": "sysview connection options", + "aliases": [] + }, + { + "description": "The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "defaultValue": "/api/v1", + "group": "sysview connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "sysview-profile", + "aliases": [ + "sysview-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "Report the status of the SYSVIEW REST server that you specified in your default SYSVIEW REST profile", + "options": "" + }, + { + "description": "Report the status of the SYSVIEW REST server that you specified in a supplied SYSVIEW REST profile", + "options": "--sysview-profile SomeSysviewProfileName" + }, + { + "description": "Report the status of the SYSVIEW REST server that you specified manually via command line", + "options": "--host myhost --port 443 --user myuser --password mypass" + } + ], + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "display", + "aliases": [ + "dsp" + ], + "summary": "Display a real-time SYSVIEW primary command", + "description": "Issue a SYSVIEW primary command and display output, including any messages", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "sysview", + "sysview-format", + "base" + ] + }, + "positionals": [ + { + "name": "command-string", + "description": "Command(s) to be issued \n(If more than one command, separated by a semi-colon)\nExample: \"ACTIVITY;SORT CPU% D\"\n", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "fields", + "aliases": [ + "f" + ], + "description": "Fields to be returned (by name). For example: \"jobname\" \"cpu\"", + "type": "array", + "group": "data options" + }, + { + "name": "all-rows", + "aliases": [ + "ar" + ], + "description": "Return all rows of data, no matter how many. Overrides --row-start and --row-end", + "type": "boolean", + "group": "data options" + }, + { + "name": "row-start", + "aliases": [ + "rs" + ], + "description": "The first row of the response data to display", + "type": "number", + "defaultValue": 1, + "group": "data options" + }, + { + "name": "row-end", + "aliases": [ + "re" + ], + "description": "The last row of the response data to display", + "type": "number", + "defaultValue": 100, + "group": "data options" + }, + { + "name": "context-fields", + "aliases": [ + "cf" + ], + "description": "Context fields to display. Defaults to hiding all context", + "type": "array", + "group": "display options" + }, + { + "name": "overview", + "aliases": [ + "o" + ], + "description": "Display the overview section", + "type": "boolean", + "group": "display options" + }, + { + "name": "info", + "aliases": [ + "i" + ], + "description": "Display the information area, if any", + "type": "boolean", + "group": "display options" + }, + { + "name": "pretty", + "aliases": [ + "p" + ], + "description": "Display formatted data", + "type": "boolean", + "group": "display options" + }, + { + "name": "blank-if-zero", + "aliases": [ + "biz", + "b" + ], + "description": "Show a blank space instead of '0' values", + "type": "boolean", + "group": "display options" + }, + { + "name": "truncate", + "aliases": [ + "tr" + ], + "description": "Truncate displays that are too wide for the console", + "type": "boolean", + "defaultValue": false, + "group": "display options" + }, + { + "name": "timeout", + "aliases": [ + "to" + ], + "description": "The number of seconds to wait before timing out", + "type": "number", + "defaultValue": 30, + "numericValueRange": [ + 1, + 60 + ], + "group": "data options" + }, + { + "name": "response-format-csv", + "aliases": [ + "csv" + ], + "description": "Format data as a set of Comma Seperated Values", + "type": "boolean", + "group": "response format options" + }, + { + "description": "The hostname of the SYSVIEW REST API", + "type": "string", + "name": "host", + "aliases": [ + "H" + ], + "group": "sysview connection options" + }, + { + "description": "The port number of the SYSVIEW REST API", + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "user", + "aliases": [ + "u" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "group": "sysview connection options" + }, + { + "description": "If set, the server certificate is verified against the list of supplied CAs", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "group": "sysview connection options" + }, + { + "description": "SSID of the SYSVIEW instance. Default value: GSVX", + "type": "string", + "name": "ssid", + "defaultValue": "GSVX", + "group": "sysview connection options", + "aliases": [] + }, + { + "description": "The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "defaultValue": "/api/v1", + "group": "sysview connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "sysview-profile", + "aliases": [ + "sysview-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview) profile to load for this command execution.", + "type": "string" + }, + { + "name": "sysview-format-profile", + "aliases": [ + "sysview-format-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview-format) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "\"CSMSTAT\" --cf message", + "description": "Issue the CSMSTAT command and show the 'message' field from the context area of the response" + }, + { + "options": "\"jobs CS&VLMC\" --fields Jobname Jobid Status", + "description": "Issue the JOBSUM command to list jobs starting with \"CS\" showing only the fields Jobname, Jobid, and Status" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "execute", + "aliases": [ + "exe" + ], + "summary": "Execute a real-time SYSVIEW function command", + "description": "Issue a SYSVIEW function command and display any messages", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "sysview", + "base" + ] + }, + "positionals": [ + { + "name": "command-string", + "description": "Command(s) to be issued \n(If more than one command, separated by a semi-colon)\nExample: \"ACTIVITY;SORT CPU% D\"\n", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "context-fields", + "aliases": [ + "cf" + ], + "description": "Context fields to display. Defaults to hiding all context", + "type": "array", + "group": "display options" + }, + { + "name": "timeout", + "aliases": [ + "to" + ], + "description": "The number of seconds to wait before timing out", + "type": "number", + "defaultValue": 30, + "numericValueRange": [ + 1, + 60 + ], + "group": "data options" + }, + { + "description": "The hostname of the SYSVIEW REST API", + "type": "string", + "name": "host", + "aliases": [ + "H" + ], + "group": "sysview connection options" + }, + { + "description": "The port number of the SYSVIEW REST API", + "type": "number", + "name": "port", + "aliases": [ + "P" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "user", + "aliases": [ + "u" + ], + "group": "sysview connection options" + }, + { + "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", + "type": "string", + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "group": "sysview connection options" + }, + { + "description": "If set, the server certificate is verified against the list of supplied CAs", + "type": "boolean", + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "group": "sysview connection options" + }, + { + "description": "SSID of the SYSVIEW instance. Default value: GSVX", + "type": "string", + "name": "ssid", + "defaultValue": "GSVX", + "group": "sysview connection options", + "aliases": [] + }, + { + "description": "The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.", + "type": "string", + "name": "base-path", + "aliases": [ + "bp" + ], + "defaultValue": "/api/v1", + "group": "sysview connection options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "sysview-profile", + "aliases": [ + "sysview-p" + ], + "group": "Profile Options", + "description": "The name of a (sysview) 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.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "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": "\"APFTEST SYS1.LINKLIB SYS001\"", + "description": "Issue the APFTEST command and display any messages returned from SYSVIEW." + } + ], + "passOn": [], + "children": [] + } + ], + "summary": "Integration with SYSVIEW", + "aliases": [ + "sv" + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file From 56ca112ff43739f935e2cdbb587fc1d5e1fc1c80 Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Tue, 1 Oct 2024 16:39:07 -0400 Subject: [PATCH 2/4] Update the Zowe version step Signed-off-by: Andrew W. Harn --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9b768f6..a29c989 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -75,7 +75,7 @@ jobs: - name: Get Zowe version id: get-version if: ${{ steps.get-version-from-workflow.outcome == 'skipped' }} - run: echo "number=$(echo 'CLI_v'$(npx zowe --version))" >> $GITHUB_OUTPUT + run: echo "number=$(echo 'CLI_v'$(zowe --version | cut -f3 -d " " | head -n 1))" >> $GITHUB_OUTPUT - name: Build Web Help id: build From c855ee68080aaa1527e3997750f344b06ac438a0 Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Tue, 1 Oct 2024 16:39:41 -0400 Subject: [PATCH 3/4] Restore npx Signed-off-by: Andrew W. Harn --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a29c989..a7c7009 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -75,7 +75,7 @@ jobs: - name: Get Zowe version id: get-version if: ${{ steps.get-version-from-workflow.outcome == 'skipped' }} - run: echo "number=$(echo 'CLI_v'$(zowe --version | cut -f3 -d " " | head -n 1))" >> $GITHUB_OUTPUT + run: echo "number=$(echo 'CLI_v'$(npx zowe --version | cut -f3 -d " " | head -n 1))" >> $GITHUB_OUTPUT - name: Build Web Help id: build From 5f83ede446dd25995288c94288dc75f03efff145 Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Tue, 1 Oct 2024 16:42:41 -0400 Subject: [PATCH 4/4] Work smarter Signed-off-by: Andrew W. Harn --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a7c7009..f0c33da 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -75,7 +75,7 @@ jobs: - name: Get Zowe version id: get-version if: ${{ steps.get-version-from-workflow.outcome == 'skipped' }} - run: echo "number=$(echo 'CLI_v'$(npx zowe --version | cut -f3 -d " " | head -n 1))" >> $GITHUB_OUTPUT + run: echo "number=$(echo 'CLI_v'$(npx zowe --version --rfj | jq -r .data.version))" >> $GITHUB_OUTPUT - name: Build Web Help id: build